ImportantSome payment methods and providers may only be available in specific countries and/or currencies. Make sure you choose the right provider for your needs.
Wallet available examples
Mercado Pago Checkout Pro
Astropay
Apple Pay
Nupay Enrollment
Nequi
DolarApp
Mercado Pago Checkout Pro
Example of a request for a payment using Mercado Pago Checkout Pro. Below are examples of a request and the received response for successful payment creation. The request is presented using the cURL format, and the response is a JSON object.Request (cURL)
curl --request POST \
--url https://api-sandbox.y.uno/v1/payments \
--header 'X-Idempotency-Key: <your-X-idempotency-key>' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'private-secret-key: <your-private-secret-key>' \
--header 'public-api-key: <your-public-api-key>' \
--data '
{
"description": "Payment with Mercado Pago Pro",
"account_id": "<account_id>",
"merchant_order_id": "0000023",
"country": "CO",
"merchant_reference": "reference-0001",
"additional_data": {
"order": {
"items": [
{
"id": "123AD",
"name": "Skirt",
"quantity": 1,
"unit_amount": 3000
}
]
}
},
"amount": {
"currency": "COP",
"value": 3000
},
"customer_payer": {
"email": "john.smith@example.com",
"first_name": "John",
"last_name": "Smith"
},
"payment_method": {
"type": "MERCADO_PAGO_CHECKOUT_PRO"
},
"workflow": "REDIRECT",
"callback_url":"www.y.uno"
}
'
Response (JSON)
{
"id": "d0ff19c2-cf55-4015-a613-e35f22da0233",
"account_id": "<account_id>",
"description": "Payment with Mercado Pago Pro",
"country": "CO",
"status": "READY_TO_PAY",
"sub_status": "CREATED",
"merchant_order_id": "0000023",
"created_at": "2023-07-23T23:02:39.401790Z",
"updated_at": "2023-07-23T23:02:40.312593Z",
"amount": {
"captured": 0.00,
"currency": "COP",
"refunded": 0.00,
"value": 3000.00
},
"checkout": {
"session": "b7e15362-4ac0-4e23-886e-329695933ecb",
"sdk_action_required": true
},
"payment_method": {
"vaulted_token": "",
"type": "MERCADO_PAGO_CHECKOUT_PRO",
"vault_on_success": false,
"token": "",
"payment_method_detail": {
"wallet": {
"verify": false,
"capture": false,
"installments": null,
"payment_method_id": null,
"payment_method_detail": null,
"date_of_expiration": null,
"money_release_date": null,
"sponsor_id": null,
"authorization_code": null,
"customer_data": null,
"card_data": null,
"redirect_url": "https://checkout.sandbox.y.uno/payment?session=e93d8431-f55c-43a3-a4e4-0c7a4bcc7e27"
}
}
},
"customer_payer": {
"id": null,
"merchant_customer_id": null,
"first_name": "John",
"last_name": "Smith",
"gender": null,
"date_of_birth": null,
"email": "john.smith@example.com",
"nationality": null,
"ip_address": null,
"device_fingerprint": null,
"browser_info": {
"user_agent": "",
"accept_header": "",
"accept_content": null,
"accept_browser": null,
"color_depth": "",
"screen_height": "",
"screen_width": "",
"javascript_enabled": null,
"java_enabled": null,
"browser_time_difference": null,
"language": ""
},
"document": null,
"phone": null,
"billing_address": null,
"shipping_address": null
},
"additional_data": {
"airline": null,
"order": {
"fee_amount": null,
"shipping_amount": null,
"items": [
{
"id": "123AD",
"name": "Skirt",
"quantity": 1,
"unit_amount": 3000,
"category": null,
"brand": null,
"sku_code": null,
"manufacture_part_number": null
}
]
},
"seller_details": null
},
"taxes": null,
"transactions": {
"id": "286ad833-7cbc-4e66-92f9-01019eb7d7a3",
"type": "PURCHASE",
"status": "CREATED",
"category": "WALLET",
"amount": 3000.00,
"provider_id": "MERCADO_PAGO",
"payment_method": {
"vaulted_token": "",
"type": "MERCADO_PAGO_CHECKOUT_PRO",
"vault_on_success": false,
"token": "",
"detail": {
"wallet": {
"verify": false,
"capture": false,
"installments": null,
"payment_method_id": null,
"payment_method_detail": null,
"date_of_expiration": null,
"money_release_date": null,
"sponsor_id": null,
"authorization_code": null,
"customer_data": null,
"card_data": null,
"redirect_url": "https://checkout.sandbox.y.uno/payment?session=e93d8431-f55c-43a3-a4e4-0c7a4bcc7e27"
}
}
},
"response_code": "SUCCEEDED",
"response_message": "Transaction successful",
"reason": null,
"description": "Payment with Mercado Pago Pro",
"merchant_reference": "reference-d2b08e8e-c87a-4806-b1ea-b35a19a36a6d",
"provider_data": {
"id": "MERCADO_PAGO",
"transaction_id": "",
"account_id": "",
"status": "",
"sub_status": "",
"status_detail": "",
"response_message": "",
"raw_response": {
"value":"{\"additional_info\":\"\",\"auto_return\":\"approved\",\"back_urls\":{\"failure\":\"http://www.y.uno\",\"pending\":\"http://www.y.uno\",\"success\":\"http://www.y.uno\"},\"binary_mode\":true,\"client_id\":\"3615163740385056\",\"collector_id\":1131498549,\"coupon_code\":null,\"coupon_labels\":null,\"date_created\":\"2023-07-23T19:02:40.082-04:00\",\"date_of_expiration\":null,\"expiration_date_from\":null,\"expiration_date_to\":null,\"expires\":false,\"external_reference\":\"286ad833-7cbc-4e66-92f9-01019eb7d7a3\",\"id\":\"1131498549-ef2fc547-72b3-4e19-acce-83f94c70609a\",\"init_point\":\"https://www.mercadopago.com.ar/checkout/v1/redirect?pref_id=1131498549-ef2fc547-72b3-4e19-acce-83f94c70609a\",\"internal_metadata\":null,\"items\":[{\"id\":\"123AD\",\"category_id\":\"others\",\"currency_id\":\"ARS\",\"description\":\"\",\"title\":\"Skirt\",\"quantity\":1,\"unit_price\":3000}],\"marketplace\":\"MP-MKT-3615163740385056\",\"marketplace_fee\":0,\"metadata\":{},\"notification_url\":\"https://sandbox.y.uno/mercadopago-webhook/v1/checkout-pro/events?source_news=webhooks\&transaction=286ad833-7cbc-4e66-92f9-01019eb7d7a3\",\"operation_type\":\"regular_payment\",\"payer\":{\"phone\":{\"area_code\":\"\",\"number\":\"\"},\"address\":{\"zip_code\":\"\",\"street_name\":\"\",\"street_number\":null},\"email\":\"john.smith@y.uno\",\"identification\":{\"number\":\"\",\"type\":\"\"},\"name\":\"John\",\"surname\":\"Smith\",\"date_created\":null,\"last_purchase\":null},\"payment_methods\":{\"default_card_id\":null,\"default_payment_method_id\":null,\"excluded_payment_methods\":[{\"id\":\"\"}],\"excluded_payment_types\":[{\"id\":\"ticket\"},{\"id\":\"atm\"}],\"installments\":null,\"default_installments\":null},\"processing_modes\":null,\"product_id\":null,\"redirect_urls\":{\"failure\":\"\",\"pending\":\"\",\"success\":\"\"},\"sandbox_init_point\":\"https://sandbox.mercadopago.com.ar/checkout/v1/redirect?pref_id=1131498549-ef2fc547-72b3-4e19-acce-83f94c70609a\",\"site_id\":\"MLA\",\"shipments\":{\"mode\":\"not_specified\",\"default_shipping_method\":null,\"cost\":0,\"receiver_address\":{\"zip_code\":\"\",\"street_name\":\"\",\"street_number\":null,\"floor\":\"\",\"apartment\":\"\",\"city_name\":null,\"state_name\":null,\"country_name\":null}},\"total_amount\":null,\"last_updated\":null}"
},
"third_party_transaction_id": ""
},
"created_at": "2023-07-23T23:02:39.582570Z",
"updated_at": "2023-07-23T23:02:40.227158Z"
},
"split": [],
"callback_url": "www.y.uno",
"workflow": "REDIRECT",
"metadata": []
}
Astropay
Example of a request for a payment using Astropay. Below are examples of a request and the received response for successful payment creation. The request is presented using the cURL format, and the response is a JSON object.Request (cURL)
curl --location 'https://api-sandbox.y.uno/v1/payments' \
--header 'X-idempotency-key: <your-X-idempotency-key>' \
--header 'public-api-key: <your-public-api-key> ' \
--header 'private-secret-key: <your-private-secret-key>' \
--header 'Content-Type: application/json' \
--data '{
"description": "Payment with Astropay",
"account_id": "<account_id>",
"country": "US",
"amount": {
"currency": "USD",
"value": 300
},
"checkout": {
"session": "<checkout_session>"
},
"payment_method": {
"type": "ASTROPAY"
},
"customer_payer": {
"id": "<customer_id>"
},
"merchant_order_id": "000022",
"workflow": "REDIRECT"
}'
Response (JSON)
{
"id": "245e360c-3bd7-4a8d-9258-8a8839087f7e",
"account_id": "<account_id>",
"description": "Payment with Astropay",
"country": "US",
"status": "READY_TO_PAY",
"sub_status": "CREATED",
"merchant_order_id": "000022",
"created_at": "2024-03-22T11:48:45.772202Z",
"updated_at": "2024-03-22T11:48:46.402414Z",
"amount": {
"captured": 0.00,
"currency": "USD",
"refunded": 0.00,
"value": 300.00
},
"checkout": {
"session": "a5e36fa7-e635-417b-aa87-8cda1adbe24e",
"sdk_action_required": true
},
"payment_method": {
"vaulted_token": "",
"type": "ASTROPAY",
"vault_on_success": false,
"token": "",
"payment_method_detail": {
"wallet": {
"verify": false,
"capture": false,
"installments": null,
"payment_method_id": null,
"payment_method_detail": null,
"date_of_expiration": null,
"money_release_date": null,
"sponsor_id": null,
"authorization_code": null,
"customer_data": null,
"card_data": {
"holder_name": "",
"iin": "",
"lfd": "",
"number_length": 0,
"security_code_length": 0,
"brand": "",
"issuer_name": "",
"issuer_code": null,
"category": null,
"type": ""
},
"redirect_url": "https://checkout.sandbox.y.uno/payment?session=4da1aa74-a2c7-457d-8b21-f823fe8cf5b8"
}
}
},
"customer_payer": {
"id": "<customer_id>",
"merchant_customer_id": "1234567",
"first_name": "John",
"last_name": "Doe",
"gender": "M",
"date_of_birth": "1990-02-28",
"email": "john.doe@example.com",
"nationality": "US",
"ip_address": null,
"device_fingerprint": null,
"browser_info": {
"user_agent": "",
"accept_header": "",
"accept_content": null,
"accept_browser": null,
"color_depth": "",
"screen_height": "",
"screen_width": "",
"javascript_enabled": null,
"java_enabled": null,
"browser_time_difference": null,
"language": ""
},
"document": {
"document_type": "PASSPORT",
"document_number": "123456789"
},
"phone": {
"number": "2125551234",
"country_code": "1"
},
"billing_address": {
"address_line_1": "123 Main Street",
"address_line_2": "Apt 4B",
"country": "US",
"state": "NY",
"city": "New York",
"zip_code": "10001",
"neighborhood": "Manhattan"
},
"shipping_address": {
"address_line_1": "456 Oak Avenue",
"address_line_2": null,
"country": "US",
"state": "CA",
"city": "Los Angeles",
"zip_code": "90210",
"neighborhood": "Beverly Hills"
}
"merchant_customer_created_at": null
},
"additional_data": null,
"taxes": null,
"transactions": {
"id": "0b258b77-1785-4b64-9094-c1f7e714e460",
"type": "PURCHASE",
"status": "CREATED",
"category": "WALLET",
"amount": 300.00,
"provider_id": "ASTROPAY",
"payment_method": {
"vaulted_token": "",
"type": "ASTROPAY",
"vault_on_success": false,
"token": "",
"detail": {
"wallet": {
"verify": false,
"capture": false,
"installments": null,
"payment_method_id": null,
"payment_method_detail": null,
"date_of_expiration": null,
"money_release_date": null,
"sponsor_id": null,
"authorization_code": null,
"customer_data": null,
"card_data": {
"holder_name": "",
"iin": "",
"lfd": "",
"number_length": 0,
"security_code_length": 0,
"brand": "",
"issuer_name": "",
"issuer_code": null,
"category": null,
"type": ""
},
"redirect_url": "https://checkout.sandbox.y.uno/payment?session=4da1aa74-a2c7-457d-8b21-f823fe8cf5b8"
}
}
},
"response_code": "SUCCEEDED",
"response_message": "Transaction successful",
"reason": null,
"description": "Payment with Astropay",
"merchant_reference": "000022",
"provider_data": {
"id": "ASTROPAY",
"transaction_id": "qW10WwSpwtTY8vLAqiTBY1D3FT4fTutdLCbFtiBy",
"account_id": "",
"status": "PENDING",
"sub_status": "",
"status_detail": "",
"response_message": "",
"response_code": "200",
"raw_response": {
"deposit_external_id": "{{deposit_external_id}}",
"merchant_deposit_id": "{{merchant_deposit_id}}",
"status": "PENDING",
"type": "default",
"url": "https://onetouch-sandbox.astropay.com/deposit/qW10WwSpwtTY8vLAqiTBY1D3FT4fTutdLCbFtiBy"
},
"third_party_transaction_id": "",
"third_party_account_id": ""
},
"created_at": "2024-03-22T11:48:45.874280Z",
"updated_at": "2024-03-22T11:48:46.361673Z"
},
"transactions_history": [
{
"id": "0b258b77-1785-4b64-9094-c1f7e714e460",
"type": "PURCHASE",
"status": "CREATED",
"category": "WALLET",
"amount": 283.00,
"provider_id": "ASTROPAY",
"payment_method": {
"vaulted_token": "",
"type": "ASTROPAY",
"vault_on_success": false,
"token": "",
"detail": {
"wallet": {
"verify": false,
"capture": false,
"installments": null,
"payment_method_id": null,
"payment_method_detail": null,
"date_of_expiration": null,
"money_release_date": null,
"sponsor_id": null,
"authorization_code": null,
"customer_data": null,
"card_data": {
"holder_name": "",
"iin": "",
"lfd": "",
"number_length": 0,
"security_code_length": 0,
"brand": "",
"issuer_name": "",
"issuer_code": null,
"category": null,
"type": ""
},
"redirect_url": "https://checkout.sandbox.y.uno/payment?session=4da1aa74-a2c7-457d-8b21-f823fe8cf5b8"
}
}
},
"response_code": "SUCCEEDED",
"response_message": "Transaction successful",
"reason": null,
"description": "Payment with Astropay",
"merchant_reference": "000022",
"provider_data": {
"id": "ASTROPAY",
"transaction_id": "qW10WwSpwtTY8vLAqiTBY1D3FT4fTutdLCbFtiBy",
"account_id": "",
"status": "PENDING",
"sub_status": "",
"status_detail": "",
"response_message": "",
"response_code": "200",
"raw_response": {
"deposit_external_id": "{{deposit_external_id}}",
"merchant_deposit_id": "{{merchant_deposit_id}}",
"status": "PENDING",
"type": "default",
"url": "https://onetouch-sandbox.astropay.com/deposit/qW10WwSpwtTY8vLAqiTBY1D3FT4fTutdLCbFtiBy"
},
"third_party_transaction_id": "",
"third_party_account_id": ""
},
"created_at": "2024-03-22T11:48:45.874280Z",
"updated_at": "2024-03-22T11:48:46.361673Z"
}
],
"split": [],
"workflow": "REDIRECT",
"metadata": [],
"fraud_screening": null,
"payment_link_id": "",
"subscription_code": null
}
Apple Pay
Example of a request for a payment using Apple Pay and enabling card verification flow (e.g., zero-dollar auth). Below are examples of a request and the received response for successful payment creation.Request (cURL)
curl --request POST \
--url https://api-sandbox.y.uno/v1/payments \
--header 'X-Idempotency-Key: <your-X-idempotency-key>' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'private-secret-key: <your-private-secret-key>' \
--header 'public-api-key: <your-public-api-key>' \
--data '
{
"description": "Apple Pay Verification",
"account_id": "<account_id>",
"merchant_order_id": "order-001",
"country": "US",
"amount": {
"currency": "USD",
"value": 0
},
"customer_payer": {
"id": "<customer_id>"
},
"payment_method": {
"type": "APPLE_PAY",
"detail": {
"wallet": {
"merchant_id": "merchant_456",
"payment_token": "token_value",
"capture": false,
"verify": true
}
}
}
}
'
Field Reference
| Property | Type | Required | Description |
|---|---|---|---|
verify | boolean | No | Enables card verification flow through the wallet. When true, a verification transaction (e.g., zero-dollar auth) is performed instead of a regular payment. |
The
verify field already existed for CARD payment method type. This change extends the same capability to APPLE_PAY.Nupay Enrollment
Example of a request for creating a payment using Nupay Enrollment. Below are examples of a request and the received response for successful payment creation. The request is presented using the cURL format, and the response is a JSON object.Request (cURL)
curl --location 'https://api-sandbox.y.uno/v1/payments' \
--header 'X-idempotency-key: <your-X-idempotency-key>' \
--header 'public-api-key: <your-public-api-key>' \
--header 'private-secret-key: <your-private-secret-key>' \
--header 'Content-Type: application/json' \
--data '{
"description": "Payment with NuPay",
"account_id": "<account_id>",
"merchant_order_id": "000022",
"country": "US",
"amount": {
"currency": "USD",
"value": 20
},
"checkout": {
"session": "<checkout_session>"
},
"customer_payer": {
"id": "<customer_id>"
},
"workflow": "DIRECT",
"payment_method": {
"type": "NU_PAY_ENROLLMENT",
"vaulted_token": "<your_vaulted_token>",
"detail": {
"wallet": {
"card_data": {
"card_type": "CREDIT"
}
}
}
}
}'
Response (JSON)
{
"id": "db24dc85-1ce3-48bc-a77b-b768c2b45c58",
"account_id": "7ae52512-1234-1234-1234-db973de67640",
"description": "Payment with NuPay",
"country": "US",
"status": "PENDING",
"sub_status": "PENDING_PROVIDER_CONFIRMATION",
"merchant_order_id": "000022",
"created_at": "2024-08-03T00:41:31.729501Z",
"updated_at": "2024-08-03T00:41:36.469759Z",
"amount": {
"captured": 0,
"currency": "USD",
"currency_conversion": null,
"refunded": 0,
"value": 20
},
"checkout": {
"session": "4351f6f4-1234-1234-1234-fd1388c3d55d",
"sdk_action_required": false
},
"payment_method": {
"vaulted_token": "1f3d74a0-1234-1234-1234-f5ccd42b27dc",
"type": "NU_PAY_ENROLLMENT",
"vault_on_success": false,
"token": "",
"payment_method_detail": {
"wallet": {
"verify": false,
"capture": false,
"installments": null,
"payment_method_id": null,
"payment_method_detail": null,
"date_of_expiration": null,
"money_release_date": null,
"sponsor_id": null,
"authorization_code": null,
"customer_data": null,
"card_data": {
"holder_name": "",
"iin": "",
"lfd": "",
"number_length": 0,
"security_code_length": 0,
"brand": "",
"issuer_name": "",
"issuer_code": null,
"category": null,
"type": "CREDIT",
"fingerprint": null
},
"redirect_url": ""
}
}
},
"customer_payer": {
"id": "45ad52b6-a094-41ab-933e-2e75a7ad4bf9",
"merchant_customer_id": "123456789012",
"first_name": "John",
"last_name": "Doe",
"gender": null,
"date_of_birth": null,
"email": "john.doe@email.com",
"nationality": null,
"ip_address": null,
"device_fingerprint": null,
"browser_info": {
"user_agent": "",
"accept_header": "",
"accept_content": null,
"accept_browser": null,
"color_depth": "",
"screen_height": "",
"screen_width": "",
"javascript_enabled": null,
"java_enabled": null,
"browser_time_difference": null,
"language": ""
},
"document": {
"document_type": "PASSPORT",
"document_number": "01234567891"
},
"phone": null,
"billing_address": null,
"shipping_address": null,
"merchant_customer_created_at": null
},
"additional_data": null,
"transactions": {
"id": "0bcc0b37-d863-4139-a9ae-44110c3253d8",
"type": "PURCHASE",
"status": "PENDING",
"category": "WALLET",
"amount": 20,
"provider_id": "SPINPAY",
"payment_method": {
"vaulted_token": "1f3d74a0-1234-1234-1234-f5ccd42b27dc",
"type": "NU_PAY_ENROLLMENT",
"vault_on_success": false,
"token": "",
"detail": {
"wallet": {
"verify": false,
"capture": false,
"installments": null,
"payment_method_id": null,
"payment_method_detail": null,
"date_of_expiration": null,
"money_release_date": null,
"sponsor_id": null,
"authorization_code": null,
"customer_data": null,
"card_data": {
"holder_name": "",
"iin": "",
"lfd": "",
"number_length": 0,
"security_code_length": 0,
"brand": "",
"issuer_name": "",
"issuer_code": null,
"category": null,
"type": "CREDIT",
"fingerprint": null
},
"redirect_url": ""
}
}
},
"response_code": "PENDING_PROVIDER_CONFIRMATION",
"response_message": "Transaction waiting confirmation",
"reason": null,
"description": "Payment with NuPay",
"merchant_reference": "000022",
"provider_data": {
"id": "SPINPAY",
"transaction_id": "512b4695-cc8e-48c6-a72c-36db3ba2e47d",
"account_id": "5864724921505",
"status": "WAITING_PAYMENT_METHOD",
"sub_status": "",
"status_detail": "",
"response_message": null,
"response_code": null,
"raw_response": {
"value": "{\"paymentMethodType\":\"nupay\",\"status\":\"WAITING_PAYMENT_METHOD\",\"pspReferenceId\":\"512b4695-cc8e-48c6-a72c-36db3ba2e47d\",\"referenceId\":\"0bcc0b37-d863-4139-a9ae-44110c3253d8\"}"
},
"third_party_transaction_id": "",
"third_party_account_id": null
},
"created_at": "2024-08-03T00:41:31.928075Z",
"updated_at": "2024-08-03T00:41:36.379150Z"
},
"transactions_history": [
{
"id": "0bcc0b37-d863-4139-a9ae-44110c3253d8",
"type": "PURCHASE",
"status": "PENDING",
"category": "WALLET",
"amount": 20,
"provider_id": "SPINPAY",
"payment_method": {
"vaulted_token": "1f3d74a0-1234-1234-1234-f5ccd42b27dc",
"type": "NU_PAY_ENROLLMENT",
"vault_on_success": false,
"token": "",
"detail": {
"wallet": {
"verify": false,
"capture": false,
"installments": null,
"payment_method_id": null,
"payment_method_detail": null,
"date_of_expiration": null,
"money_release_date": null,
"sponsor_id": null,
"authorization_code": null,
"customer_data": null,
"card_data": {
"holder_name": "",
"iin": "",
"lfd": "",
"number_length": 0,
"security_code_length": 0,
"brand": "",
"issuer_name": "",
"issuer_code": null,
"category": null,
"type": "CREDIT",
"fingerprint": null
},
"redirect_url": ""
}
}
},
"response_code": "PENDING_PROVIDER_CONFIRMATION",
"response_message": "Transaction waiting confirmation",
"reason": null,
"description": "Payment with NuPay",
"merchant_reference": "000022",
"provider_data": {
"id": "SPINPAY",
"transaction_id": "512b4695-cc8e-48c6-a72c-36db3ba2e47d",
"account_id": "5864724921505",
"status": "WAITING_PAYMENT_METHOD",
"sub_status": "",
"status_detail": "",
"response_message": null,
"response_code": null,
"raw_response": {
"value": "{\"paymentMethodType\":\"nupay\",\"status\":\"WAITING_PAYMENT_METHOD\",\"pspReferenceId\":\"512b4695-cc8e-48c6-a72c-36db3ba2e47d\",\"referenceId\":\"0bcc0b37-d863-4139-a9ae-44110c3253d8\"}"
},
"third_party_transaction_id": "",
"third_party_account_id": null
},
"created_at": "2024-08-03T00:41:31.928075Z",
"updated_at": "2024-08-03T00:41:36.379150Z"
}
],
"split": [],
"workflow": "DIRECT",
"metadata": [],
"fraud_screening": null,
"payment_link_id": "",
"subscription_code": null,
"routing_rules": {
"condition": {
"id": 95706,
"name": null,
"description": null
}
},
"simplified_mode": false
}
Nequi
Below is an example of a payment request using Nequi. This example demonstrates how to create a payment operation using the cURL format.Request (cURL)
curl --location 'https://api-sandbox.y.uno/v1/payments' \
--header 'X-idempotency-key: <your-X-idempotency-key>' \
--header 'public-api-key: <your-public-api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"description": "Payment with Nequi",
"account_id":"<account_id>",
"merchant_order_id": "0000022",
"country": "CO",
"amount": {
"currency": "COP",
"value": 52000
},
"customer_payer": {
"merchant_customer_id": "1737124506",
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@example.com",
"document":{
"document_type": "CC",
"document_number": "1032765432"
},
"phone": {
"country_code": "57",
"number": "3991111111"
}
},
"payment_method": {
"type": "NEQUI"
},
"workflow":"REDIRECT",
"callback_url":"www.google.com"
}'
Response (JSON)
{
"id": "340c1be8-05b9-4e37-aabf-4e57f098bf03",
"account_id": "493e9374-510a-4201-9e09-de669d75f256",
"description": "Payment with Nequi",
"country": "CO",
"status": "READY_TO_PAY",
"sub_status": "CREATED",
"merchant_order_id": "0000022",
"created_at": "2025-01-17T14:35:08.157837Z",
"updated_at": "2025-01-17T14:35:18.879785Z",
"amount": {
"captured": 0.00,
"currency": "COP",
"currency_conversion": null,
"refunded": 0.00,
"value": 52000.00
},
"checkout": {
"session": "b1792599-fa77-44ac-a31e-87f2af2e30ac",
"sdk_action_required": true
},
"payment_method": {
"vaulted_token": "",
"type": "NEQUI",
"vault_on_success": false,
"token": "",
"parent_payment_method_type": null,
"payment_method_detail": {
"wallet": {
"verify": false,
"capture": false,
"installments": 0,
"installments_plan_id": null,
"first_installment_deferral": 0,
"installments_type": "MERCHANT",
"installment_amount": null,
"payment_method_id": null,
"payment_method_detail": null,
"date_of_expiration": null,
"money_release_date": null,
"sponsor_id": null,
"authorization_code": null,
"customer_data": null,
"card_data": {
"holder_name": "",
"iin": "",
"lfd": "",
"number_length": 0,
"security_code_length": 0,
"brand": "",
"issuer_name": "",
"issuer_code": null,
"country_code": "",
"category": null,
"type": "",
"fingerprint": null,
"expiration_month": null,
"expiration_year": null
},
"redirect_url": "https://checkout.sandbox.y.uno/payment?session=cd627381-11ea-45d7-8918-ee703098c265"
}
}
},
"customer_payer": {
"id": null,
"merchant_customer_id": "1737124506",
"first_name": "John",
"last_name": "Smith",
"gender": null,
"date_of_birth": null,
"email": "john.smith@example.com",
"nationality": null,
"ip_address": null,
"device_fingerprint": null,
"device_fingerprints": [],
"browser_info": {
"user_agent": "",
"accept_header": "",
"accept_content": null,
"accept_browser": null,
"color_depth": "",
"screen_height": "",
"screen_width": "",
"javascript_enabled": null,
"java_enabled": null,
"browser_time_difference": null,
"language": ""
},
"document": {
"document_type": "CC",
"document_number": "1032765432"
},
"phone": {
"number": "3991111111",
"country_code": "57"
},
"billing_address": null,
"shipping_address": null,
"merchant_customer_created_at": null
},
"additional_data": null,
"transactions": {
"id": "a55a645d-4fcd-4720-9128-abbcbe739d81",
"type": "PURCHASE",
"status": "CREATED",
"category": "WALLET",
"amount": 52000.00,
"provider_id": "DLOCAL",
"payment_method": {
"vaulted_token": "",
"type": "NEQUI",
"vault_on_success": false,
"token": "",
"parent_payment_method_type": null,
"detail": {
"wallet": {
"verify": false,
"capture": false,
"installments": 0,
"installments_plan_id": null,
"first_installment_deferral": 0,
"installments_type": "MERCHANT",
"installment_amount": null,
"payment_method_id": null,
"payment_method_detail": null,
"date_of_expiration": null,
"money_release_date": null,
"sponsor_id": null,
"authorization_code": null,
"customer_data": null,
"card_data": {
"holder_name": "",
"iin": "",
"lfd": "",
"number_length": 0,
"security_code_length": 0,
"brand": "",
"issuer_name": "",
"issuer_code": null,
"country_code": "",
"category": null,
"type": "",
"fingerprint": null,
"expiration_month": null,
"expiration_year": null
},
"redirect_url": "https://checkout.sandbox.y.uno/payment?session=cd627381-11ea-45d7-8918-ee703098c265"
}
}
},
"response_code": "SUCCEEDED",
"response_message": "Transaction successful",
"reason": null,
"description": "Payment with Nequi",
"merchant_reference": "0000022",
"provider_data": {
"id": "DLOCAL",
"transaction_id": "F-385928-c8516ec5-5b49-4ccf-9fc9-89000f3935bd",
"account_id": "1OABfzqFOD",
"status": "PENDING",
"sub_status": "",
"status_detail": "",
"response_message": "The payment is pending.",
"response_code": "100",
"raw_response": {
"value": "{\"id\":\"F-385928-c8516ec5-5b49-4ccf-9fc9-89000f3935bd\",\"amount\":52000,\"currency\":\"COP\",\"payment_method_id\":\"QP\",\"payment_method_type\":\"WALLET\",\"payment_method_flow\":\"REDIRECT\",\"country\":\"CO\",\"created_date\":\"2025-01-17T14:35:09.000+0000\",\"status\":\"PENDING\",\"status_detail\":\"The payment is pending.\",\"status_code\":\"100\",\"order_id\":\"a55a645d-4fcd-4720-9128-abbcbe739d81\",\"notification_url\":\"https://sandbox.y.uno/dlocal-webhook/v1/confirmations\"}"
},
"third_party_transaction_id": "",
"third_party_account_id": "",
"iso8583_response_code": null,
"iso8583_response_message": null
},
"connection_data": {
"id": "c3f18893-9318-4652-90f6-7bb9d12cc160",
"name": null
},
"device_fingerprint": null,
"created_at": "2025-01-17T14:35:08.314925Z",
"updated_at": "2025-01-17T14:35:18.832995Z"
},
"transactions_history": [
{
"id": "a55a645d-4fcd-4720-9128-abbcbe739d81",
"type": "PURCHASE",
"status": "CREATED",
"category": "WALLET",
"amount": 52000.00,
"provider_id": "DLOCAL",
"payment_method": {
"vaulted_token": "",
"type": "NEQUI",
"vault_on_success": false,
"token": "",
"parent_payment_method_type": null,
"detail": {
"wallet": {
"verify": false,
"capture": false,
"installments": 0,
"installments_plan_id": null,
"first_installment_deferral": 0,
"installments_type": "MERCHANT",
"installment_amount": null,
"payment_method_id": null,
"payment_method_detail": null,
"date_of_expiration": null,
"money_release_date": null,
"sponsor_id": null,
"authorization_code": null,
"customer_data": null,
"card_data": {
"holder_name": "",
"iin": "",
"lfd": "",
"number_length": 0,
"security_code_length": 0,
"brand": "",
"issuer_name": "",
"issuer_code": null,
"country_code": "",
"category": null,
"type": "",
"fingerprint": null,
"expiration_month": null,
"expiration_year": null
},
"redirect_url": "https://checkout.sandbox.y.uno/payment?session=cd627381-11ea-45d7-8918-ee703098c265"
}
}
},
"response_code": "SUCCEEDED",
"response_message": "Transaction successful",
"reason": null,
"description": "Payment with Nequi",
"merchant_reference": "0000022",
"provider_data": {
"id": "DLOCAL",
"transaction_id": "F-385928-c8516ec5-5b49-4ccf-9fc9-89000f3935bd",
"account_id": "1OABfzqFOD",
"status": "PENDING",
"sub_status": "",
"status_detail": "",
"response_message": "The payment is pending.",
"response_code": "100",
"raw_response": {
"value": "{\"id\":\"F-385928-c8516ec5-5b49-4ccf-9fc9-89000f3935bd\",\"amount\":52000,\"currency\":\"COP\",\"payment_method_id\":\"QP\",\"payment_method_type\":\"WALLET\",\"payment_method_flow\":\"REDIRECT\",\"country\":\"CO\",\"created_date\":\"2025-01-17T14:35:09.000+0000\",\"status\":\"PENDING\",\"status_detail\":\"The payment is pending.\",\"status_code\":\"100\",\"order_id\":\"a55a645d-4fcd-4720-9128-abbcbe739d81\",\"notification_url\":\"https://sandbox.y.uno/dlocal-webhook/v1/confirmations\"}"
},
"third_party_transaction_id": "",
"third_party_account_id": "",
"iso8583_response_code": null,
"iso8583_response_message": null
},
"connection_data": {
"id": "c3f18893-9318-4652-90f6-7bb9d12cc160",
"name": null
},
"device_fingerprint": null,
"created_at": "2025-01-17T14:35:08.314925Z",
"updated_at": "2025-01-17T14:35:18.832995Z"
}
],
"callback_url": "www.google.com",
"workflow": "REDIRECT",
"metadata": [],
"fraud_screening": null,
"payment_link_id": "",
"subscription_code": null,
"routing_rules": {
"smart_routing": false,
"condition": {
"id": 130132,
"name": null,
"description": null
}
},
"simplified_mode": false
}
DolarApp
Example of a request for a payment using DolarApp. Below are examples of a request and the received response for successful payment creation. The request is presented using the cURL format, and the response is a JSON object.Request (cURL)
curl --location 'https://api-sandbox.y.uno/v1/payments' \
--header 'X-idempotency-key: <your-X-idempotency-key>' \
--header 'public-api-key: <your-public-api-key>' \
--header 'private-secret-key: <your-private-secret-key>' \
--header 'Content-Type: application/json' \
--data '{
"account_id": "<account_id>",
"amount": {
"currency": "MXN",
"value": 5
},
"checkout": {
"session": "<checkout_session>"
},
"payment_method": {
"token": "<your_enrolled_token>",
"detail": {
"card": {
"capture": true
},
"wallet": {
"capture": true
}
},
"vault_on_success": false
},
"customer_payer": {
"id": "<customer_id>",
"nationality": "MX",
"browser_info": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/148.0.0.0 Safari/537.36",
"accept_header": "application/json",
"accept_content": "*/*",
"accept_browser": "*/*",
"color_depth": "8",
"screen_height": "8",
"screen_width": "8",
"javascript_enabled": true,
"java_enabled": false,
"browser_time_difference": "300",
"language": "en",
"platform": "WEB"
}
},
"merchant_order_id": "1780501099353",
"country": "MX",
"description": "Payment with DolarApp"
}'
Response (JSON)
{
"id": "48b4aa34-4006-4f5b-b444-8e0c0f54f3ea",
"account_id": "<account_id>",
"description": "Payment with DolarApp",
"country": "MX",
"status": "PENDING",
"sub_status": "PENDING_PROVIDER_CONFIRMATION",
"merchant_order_id": "1780501099353",
"created_at": "2026-06-03T15:46:05.027450Z",
"updated_at": "2026-06-03T15:46:05.774028Z",
"amount": {
"captured": 0,
"currency": "MXN",
"currency_conversion": null,
"refunded": 0,
"value": 5
},
"checkout": {
"session": "<checkout_session>",
"sdk_action_required": true
},
"payment_method": {
"vaulted_token": "<vaulted_token>",
"type": "DOLARAPP",
"vault_on_success": false,
"vault_on_decline": false,
"token": "<enrolled_token>",
"parent_payment_method_type": null,
"otp": {},
"payment_method_detail": {
"wallet": {
"verify": null,
"capture": true,
"installments": 0,
"installments_plan_id": null,
"first_installment_deferral": 0,
"installments_type": "",
"installment_amount": null,
"installments_total_amount": null,
"payment_method_id": null,
"payment_method_detail": null,
"date_of_expiration": null,
"money_release_date": null,
"sponsor_id": null,
"authorization_code": null,
"customer_data": null,
"card_data": {
"holder_name": "",
"iin": "",
"lfd": "",
"number_length": 0,
"security_code_length": 0,
"brand": "",
"scheme": "",
"issuer_name": "",
"issuer_code": null,
"country_code": null,
"category": null,
"type": "",
"fingerprint": null,
"expiration_month": null,
"expiration_year": null
},
"redirect_url": null,
"expires_at": null
}
}
},
"customer_payer": {
"id": "<customer_id>",
"merchant_customer_id": "1780428489539",
"first_name": "John",
"last_name": "Doe",
"gender": "",
"date_of_birth": "1990-02-28",
"email": "john.doe@email.com",
"nationality": "MX",
"ip_address": "190.18.30.39",
"device_fingerprint": null,
"device_fingerprints": [],
"browser_info": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/148.0.0.0 Safari/537.36",
"accept_header": "application/json",
"accept_content": "*/*",
"accept_browser": "*/*",
"color_depth": "8",
"screen_height": "8",
"screen_width": "8",
"javascript_enabled": true,
"java_enabled": false,
"browser_time_difference": "300",
"language": "en",
"platform": "WEB"
},
"document": {
"document_type": "RFC",
"document_number": "IESF960301230"
},
"phone": {
"number": "3991111111",
"country_code": "52"
},
"billing_address": null,
"shipping_address": null,
"merchant_customer_created_at": null,
"merchant_customer_validations": {
"account_is_verified": true,
"email_is_verified": true,
"phone_is_verified": true
}
},
"additional_data": null,
"transactions": {
"id": "2b8ab4d0-27ff-4641-be49-a706d1617a50",
"type": "PURCHASE",
"status": "PENDING",
"category": "WALLET",
"amount": 5,
"provider_id": "DOLARAPP",
"response_code": "PENDING_PROVIDER_CONFIRMATION",
"response_message": "Transaction waiting confirmation",
"reason": null,
"description": "Payment with DolarApp",
"merchant_reference": "1780501099353",
"provider_data": {
"id": "DOLARAPP",
"transaction_id": "2b8ab4d0-27ff-4641-be49-a706d1617a50",
"account_id": "",
"status": "PENDING",
"sub_status": "",
"status_detail": "",
"response_message": "Transaction waiting confirmation",
"response_code": "200",
"raw_response": null,
"third_party_transaction_id": "",
"third_party_account_id": null,
"iso8583_response_code": null,
"iso8583_response_message": null,
"merchant_advice_code": null,
"merchant_advice_code_message": null,
"reason_code": null,
"reason_description": null
},
"connection_data": {
"id": "<connection_id>",
"name": "<connection_name>"
},
"created_at": "2026-06-03T15:46:05.167801Z",
"updated_at": "2026-06-03T15:46:05.721788Z",
"split_marketplace": [],
"merchant_advice_code": null,
"merchant_advice_code_message": null
},
"callback_url": "https://demo.dev.y.uno/testing/checkout/status?checkoutSession=<checkout_session>",
"workflow": "SDK_CHECKOUT",
"metadata": [],
"fraud_screening": null,
"payment_link_id": "",
"subscription_code": null,
"routing_rules": {
"smart_routing": false,
"monitors": false,
"condition": {
"id": 122903,
"name": null,
"description": null
}
},
"simplified_mode": false
}