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.
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.
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.

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.

JSON Example

{
  "id": "ffb50d6c-09f1-4f08-9b91-cbce466bed52",
  "action": {
    "type": "REDIRECT",
    "redirect_url": "https://api.minteo.finance/v1/payins/redirect/ffb50d6c-09f1-4f08-9b91-cbce466bed52"
  },
  "status": "PENDING",
  "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"
  }
}