Payin

Name	Type	Example / Possible values	Description
id	uuid	"8dc85f2f-1cca-4f20-85fb-dcc16b233c94"	The Payin's ID.
token	string	"COPM"	Stablecoin token for this Payin.
purpose	string	"Top-up on behalf of John Doe"	Purpose of the Payin.
amount	string	"127000.50"	Amount to be collected from the end-user, to be tokenized. Minimum amount for COPM: 10,000 COP.
final_url	string	"https://yoursite.com/payin-completed"	URL to redirect the end-user to, after the Payin's payment is completed. ID of the Payin will be appended as a query parameter to this URL.
status	string	"PENDING" "ABORTED" "IN_PROGRESS" "FULFILLED"	Current status of the Payin.
action	object	<Action>	Action to be taken by the end-user right after the Payin is created.
payment	object	<Payment>	Payment details for the Payin.
third_party	object	<Third Party>	Third Party (end-user) details for the Payin.
destination_wallet_id	uuid	"ee931602-016a-434d-9833-6910d241b8f4"	The ID of the Customer's wallet to send the stablecoin tokens to.
customer_id	uuid	"ee931602-016a-434d-9833-6910d241b8f4"	The ID of the Customer who created the Payin.
finished_at	string null	2024-08-15T18:35:29.613Z	Date when the Payin was finished.
created_at	string	2024-08-15T18:35:29.613Z	Creation date of this Payin.
updated_at	string	2024-08-15T18:35:29.613Z	Last update date of this Payin.
activities	Array<Activities>	[]	Activities related to the Payin.
public_data	JSON null	<Public Data>	Public data associated with the payin.
status_code	string null	CREATE_PAYIN AWAIT_THIRD_PARTY_KYC AWAIT_INIT_PAYIN AWAIT_GATEWAY_CONFIRM_PAYIN GATEWAY_CONFIRM_PAYIN AWAIT_BANK_CONFIRM_PAYIN AWAIT_TOKENIZATION AWAIT_TRANSFER_TOKENS CANCELED PAYMENT_FAILED KYC_REJECTED EXPIRED	Status code of this payin regarding the status.

action object

For REDIRECT action type:

Name	Type	Example / Possible values	Description
type	string	"REDIRECT"	Type of action to be taken by the end-user.
redirect_url	string	"https://api.minteo.finance/v1/payins/redirect/8dc85f2f-1cca-4f20-85fb-dcc16b233c94"	URL to redirect the end-user to, after the Payin's payment is completed. ID of the Payin will be appended as a query parameter to this URL.

payment object

Name	Type	Example / Possible values	Description
method	string	"PSE"	Payment method for the Payin.
bank	string	PSE Banks	Bank for the Payin.

third_party object

Name	Type	Example / Possible values	Description
full_name	string	"John Doe"	Full name of the end-user.
legal_identifier_type	string	• CC for Colombian Cedula de Ciudadanía. • CE for Colombian Cedula de Extranjería. • NIT for Colombian NIT. • PP for Passport.	Type of legal identifier for the end-user.
legal_identifier	string	"1099075610"	Legal identifier for the end-user.
country_iso	string	• CO for Colombia.	The ISO 3166-1 alpha-2 country code of the end-user.
email	string	"john@example.com"	Email of the end-user.

Status Codes

Code	Description	Notes
PAYIN_CREATED	Payin created; waiting for the third party to complete the payment.
AWAIT_THIRD_PARTY_KYC	Waiting for the third party to complete the KYC.
AWAIT_INIT_PAYIN	Waiting for the payment gateway to initialize the payment.
AWAIT_GATEWAY_CONFIRM_PAYIN	Waiting for the payment gateway to confirm the payment.
GATEWAY_CONFIRM_PAYIN	Payment confirmed by the gateway.
AWAIT_BANK_CONFIRM_PAYIN	Waiting for the bank to confirm the payment.
AWAIT_TOKENIZATION	Waiting for the tokens to be tokenized.
AWAIT_TRANSFER_TOKENS	Waiting for the tokens to be transferred to the customer's wallet.
CANCELED	Payin canceled.
PAYMENT_FAILED	Payment failed. The payment gateway or the bank did not confirm the payment.
KYC_REJECTED	KYC rejected by the third party.
EXPIRED	Payin expired due to time window or inactivity.

Public Data

Name	Type	Examples / Valid options	Description
transfer_transaction_hash	string	"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"	The hash for the transfer of the tokens to the customer's wallet.
external_reference	string	"COINK#3b59a8a599c0c14"	External reference of the Payin. This is the id of the payin in the provider's system.
hook_event_ids	array	["EVENT#123e4567-e89b-12d3-a456-426614174000", "EVENT#123e4567-e89b-12d3-a456-426614174001"]	The IDs of the hook events associated with the Payin. This only applies if you have enabled webhooks
destination_wallet	object	{ "chain": "POLYGON", "address": "0x1234567891234567890123456789012345678901" }	The destination wallet of the Payin. This is the customer's wallet that will receive the tokens.

Activities

Name	Type	Description
type	Payin Status Codes	Type of the activity.
status	PENDING SUCCEEDED FAILED	Status of the activity.
last_update_at	string Date	Last update date of the activity.

JSON Example

{
  "id": "ffb50d6c-09f1-4f08-9b91-cbce466bed52",
  "created_at": "2024-08-15T18:35:29.613Z",
  "updated_at": "2024-08-15T18:35:29.613Z",
  "finished_at": null,
  "customer_id": "2af83836-43ea-407b-ab4e-9c64ee817b28",
  "action": {
    "type": "REDIRECT",
    "redirect_url": "https://api.minteo.finance/v1/payins/redirect/ffb50d6c-09f1-4f08-9b91-cbce466bed52"
  },
  "status": "PENDING",
  "status_code": "PAYIN_CREATED",
  "destination_wallet_id": "2af83836-43ea-407b-ab4e-9c64ee817b28",
  "amount": "127000",
  "token": "COPM",
  "purpose": "Top-up on behalf of John Doe",
  "final_url": "https://yoursite.com/payin-completed",
  "payment": {
    "method": "PSE",
    "bank": "BANCO_FALABELLA"
  },
  "third_party": {
    "full_name": "John Doe",
    "legal_identifier_type": "CC",
    "legal_identifier": "1099075610",
    "country_iso": "CO",
    "email": "john@example.com"
  },
  "public_data": {
    "destination_wallet": {
      "chain": "POLYGON",
      "address": "0x1234567891234567890123456789012345678901"
    }
  },
  "activities": [
    {
      "type": "PAYIN_CREATED",
      "status": "SUCCEEDED",
      "last_update_at": "2024-08-15T18:35:29.613Z"
    }
  ]
}