This page presents examples of requests and responses for creating payments using the Create Payment endpoint and Payment Link as payment method.
To test the creation of each payment, you can copy the content from the request code and use it on your machine or paste it on the Create Payment endpoint to test using Readme.
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.
Payment Link available examples
Payvalida
Example of a request for a Payment Link payment using Payvalida. 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.
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 wiht Payvalida",
"account_id":"<account_id>",
"merchant_order_id": "0000022",
"country": "CO",
"amount": {
"currency": "COP",
"value": 52000
},
"customer_payer": {
"email": "[email protected]",
"first_name": "John",
"last_name": "Smith"
},
"payment_method": {
"type": "PAYVALIDA"
},
"workflow":"REDIRECT",
"callback_url":"www.y.uno",
"taxes": {
"value": 100,
"percentage": 21,
"type":"VAT",
"tax_base": 1000
}
}
'{
"id": "c6c81ce5-acbe-480b-9bd4-1f401a3c2c96",
"account_id": "493e9374-510a-4201-9e09-de669d75f256",
"description": "Payment wiht Payvalida",
"country": "CO",
"status": "READY_TO_PAY",
"sub_status": "CREATED",
"merchant_order_id": "0000022",
"created_at": "2023-07-23T23:03:32.571147Z",
"updated_at": "2023-07-23T23:03:36.459433Z",
"amount": {
"captured": 0.00,
"currency": "COP",
"refunded": 0.00,
"value": 52000.00
},
"checkout": {
"session": "d8707bff-a7e2-4ff3-9466-919d5bb4fe2b",
"sdk_action_required": true
},
"payment_method": {
"vaulted_token": "",
"type": "PAYVALIDA",
"vault_on_success": false,
"token": "",
"payment_method_detail": {
"payment_link": {
"verify": null,
"capture": null,
"installments": null,
"payment_method_id": null,
"payment_method_detail": null,
"date_of_expiration": null,
"money_release_date": null,
"sponsor_id": null,
"authorization_code": null,
"redirect_url": "https://checkout.sandbox.y.uno/payment?session=e497ea54-0063-47cb-a755-30fb7eed6d54"
}
}
},
"customer_payer": {
"id": null,
"merchant_customer_id": null,
"first_name": "John",
"last_name": "Smith",
"gender": null,
"date_of_birth": null,
"email": "[email protected]",
"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": null,
"taxes": {
"type": "VAT",
"tax_base": 1000,
"value": 100,
"percentage": 21
},
"transactions": {
"id": "1fcd5118-8201-4b80-8cc0-b65f264f434a",
"type": "PURCHASE",
"status": "CREATED",
"category": "PAYMENT_LINK",
"amount": 52000.00,
"provider_id": "PAYVALIDA",
"payment_method": {
"vaulted_token": "",
"type": "PAYVALIDA",
"vault_on_success": false,
"token": "",
"detail": {}
},
"response_code": "SUCCEEDED",
"response_message": "Transaction successful",
"reason": null,
"description": "Test Payvalida",
"merchant_reference": null,
"provider_data": {
"id": "PAYVALIDA",
"transaction_id": "2415421",
"account_id": "",
"status": "CREADA",
"sub_status": "",
"status_detail": "",
"response_message": "",
"raw_response": {
"value": "{\"CODE\":\"0000\",\"DATA\":{\"Monto\":\"52000.0\",\"Operacion\":\"CREADA\",\"OrdenID\":\"yuno304314951\",\"PVordenID\":\"2415421\",\"Referencia\":\"90972200867\",\"checkout\":\"sandbox-checkout.payvalida.com?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJNRVJDSEFOVF9DRUwiOiIrNTczMDE3ODc1MTA1IiwiTUVSQ0hBTlRfQ09ERSI6MzE2MTQsIk9SREVSX0NPREUiOjI0MTU0MjEsIk1FUkNIQU5UX0VNQUlMIjoiaW5mb0B5LnVubyIsIk1FUkNIQU5UX0xPR08iOiIiLCJNRVJDSEFOVF9VUkxfUkVUVVJOIjoiIiwiTUVSQ0hBTlRfTkFNRSI6IllVTk8gQ09MT01CSUEgKENPKSIsIkVYUElSQVRJT04iOiIyNS8wNy8yMDIzIiwiT1JERVJfQlJJRUYiOiJUZXN0IFBheXZhbGlkYSIsIk9SREVSX0NVUlJFTkNZIjoiQ09QIiwiT1JERVJfQU1PVVQiOiI1MjAwMC4wIiwiTUVSQ0hBTlRfSUQiOiJ5dW5vY29sb21iaWFzYXMiLCJPUkRFUl9SRUZFUkVOQ0UiOiI5MDk3MjIwMDg2NyIsIk9SREVSX01FVEhPRCI6IiIsIlVTRVJfREkiOiIiLCJVU0VSX1RZUEVfREkiOiIiLCJVU0VSX05BTUUiOiIiLCJSRURJUkVDVF9USU1FT1VUIjoiIiwiTUVSQ0hBTlRfVEVNUExBVEUiOiJkZWZhdWx0IiwiZXhwIjoxNjkwMzQ3NjAwLCJpc3MiOiJhdXRoMCJ9.qbcmiq2Emguk4TK5oMtvC6QR9WcRfB-7IMVSwf4IOrw\"},\"DESC\":\"OK\"}"
},
"third_party_transaction_id": ""
},
"created_at": "2023-07-23T23:03:32.795957Z",
"updated_at": "2023-07-23T23:03:36.386080Z"
},
"split": [],
"callback_url": "www.y.uno",
"workflow": "REDIRECT",
"metadata": []
}Tarjeta Clave
Example of a request for a Payment Link payment using Tarjeta Clave. 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.
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 Tarjeta Clave",
"account_id":"<account_id>",
"merchant_order_id": "0000022",
"country": "PA",
"amount": {
"currency": "USD",
"value": 5200
},
"customer_payer": {
"email": "[email protected]",
"first_name": "John",
"last_name": "Smith",
"document":{
"document_type": "CC",
"document_number": "1032765432"
}
},
"payment_method": {
"type": "TARJETA_CLAVE"
},
"workflow":"REDIRECT",
"callback_url":"www.y.uno"
}
'{
"id": "137d6ae2-5c26-4489-bfeb-cd5221d4d00e",
"account_id": "493e9374-510a-4201-9e09-de669d75f256",
"description": "Payment with Tarjeta Clave",
"country": "PA",
"status": "READY_TO_PAY",
"sub_status": "CREATED",
"merchant_order_id": "0000022",
"created_at": "2023-07-23T23:06:56.422863Z",
"updated_at": "2023-07-23T23:06:58.356461Z",
"amount": {
"captured": 0.00,
"currency": "USD",
"refunded": 0.00,
"value": 5200.00
},
"checkout": {
"session": "2761b558-393c-4214-96ed-94a2da4af6e6",
"sdk_action_required": true
},
"payment_method": {
"vaulted_token": "",
"type": "TARJETA_CLAVE",
"vault_on_success": false,
"token": "",
"payment_method_detail": {
"payment_link": {
"verify": null,
"capture": null,
"installments": null,
"payment_method_id": null,
"payment_method_detail": null,
"date_of_expiration": null,
"money_release_date": null,
"sponsor_id": null,
"authorization_code": "R-385928-db2ba20e-5b8e-4740-a184-786a9bae925a",
"redirect_url": "https://checkout.sandbox.y.uno/payment?session=683fcf52-4ccf-4ab6-8fd9-0482679a097f"
}
}
},
"customer_payer": {
"id": null,
"merchant_customer_id": null,
"first_name": "John",
"last_name": "Smith",
"gender": null,
"date_of_birth": null,
"email": "[email protected]",
"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": "CC",
"document_number": "1032765432"
},
"phone": null,
"billing_address": null,
"shipping_address": null
},
"additional_data": null,
"taxes": null,
"transactions": {
"id": "0d11cbb2-c28e-4366-bf24-cb4f86b00d79",
"type": "PURCHASE",
"status": "CREATED",
"category": "PAYMENT_LINK",
"amount": 5200.00,
"provider_id": "DLOCAL",
"payment_method": {
"vaulted_token": "",
"type": "TARJETA_CLAVE",
"vault_on_success": false,
"token": "",
"detail": {}
},
"response_code": "SUCCEEDED",
"response_message": "Transaction successful",
"reason": null,
"description": "Payment with Tarjeta Clave",
"merchant_reference": null,
"provider_data": {
"id": "DLOCAL",
"transaction_id": "R-385928-db2ba20e-5b8e-4740-a184-786a9bae925a",
"account_id": "",
"status": "PENDING",
"sub_status": "",
"status_detail": "100",
"response_message": "The payment is pending.",
"raw_response": {
"value": "{\"id\":\"R-385928-db2ba20e-5b8e-4740-a184-786a9bae925a\",\"amount\":5200.00,\"currency\":\"USD\",\"payment_method_id\":\"CV\",\"payment_method_type\":\"TICKET\",\"payment_method_flow\":\"REDIRECT\",\"country\":\"PA\",\"created_date\":\"2023-07-23T23:06:57.000+0000\",\"status\":\"PENDING\",\"status_detail\":\"The payment is pending.\",\"status_code\":\"100\",\"order_id\":\"0d11cbb2-c28e-4366-bf24-cb4f86b00d79\",\"notification_url\":\"https://sandbox.y.uno/dlocal-webhook/v1/confirmations\",\"redirect_url\":\"https://sandbox.dlocal.com/gmf-apm/payments/M-d01e3d17-6082-4b1b-a1fb-d5a601260deb\"}"
},
"third_party_transaction_id": ""
},
"created_at": "2023-07-23T23:06:56.598311Z",
"updated_at": "2023-07-23T23:06:58.259852Z"
},
"split": [],
"callback_url": "www.y.uno",
"workflow": "REDIRECT",
"metadata": []
}Webpay
Example of a request for a Payment Link payment using Webpay. 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.
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 Webpay",
"account_id":"<account_id>",
"merchant_order_id": "0000022",
"country": "CL",
"amount": {
"currency": "CLP",
"value": 5000
},
"customer_payer": {
"email": "[email protected]",
"first_name": "John",
"last_name": "Smith"
},
"payment_method": {
"type": "WEBPAY"
},
"workflow":"REDIRECT",
"callback_url":"www.y.uno"
}
'{
"id": "9c1f6ba0-d483-42a9-8d06-d53a07c284e0",
"account_id": "493e9374-510a-4201-9e09-de669d75f256",
"description": "Payment with Webpay",
"country": "CL",
"status": "READY_TO_PAY",
"sub_status": "CREATED",
"merchant_order_id": "0000022",
"created_at": "2023-07-23T23:11:24.724037Z",
"updated_at": "2023-07-23T23:11:26.318691Z",
"amount": {
"captured": 0,
"currency": "CLP",
"refunded": 0,
"value": 5000
},
"checkout": {
"session": "3c9eb446-388a-4c2e-9818-573d54300dd1",
"sdk_action_required": true
},
"payment_method": {
"vaulted_token": "",
"type": "WEBPAY",
"vault_on_success": false,
"token": "",
"payment_method_detail": {
"payment_link": {
"verify": null,
"capture": null,
"installments": null,
"payment_method_id": null,
"payment_method_detail": null,
"date_of_expiration": null,
"money_release_date": null,
"sponsor_id": null,
"authorization_code": null,
"redirect_url": "https://checkout.sandbox.y.uno/payment?session=40ebcd0c-3598-4bd9-81cc-9f8e29c86987"
}
}
},
"customer_payer": {
"id": null,
"merchant_customer_id": null,
"first_name": "John",
"last_name": "Smith",
"gender": null,
"date_of_birth": null,
"email": "[email protected]",
"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": null,
"taxes": null,
"transactions": {
"id": "762abda0-2de5-43ba-a52b-04279acfb869",
"type": "PURCHASE",
"status": "CREATED",
"category": "PAYMENT_LINK",
"amount": 5000.00,
"provider_id": "TRANSBANK_2",
"payment_method": {
"vaulted_token": "",
"type": "WEBPAY",
"vault_on_success": false,
"token": "",
"detail": {}
},
"response_code": "SUCCEEDED",
"response_message": "Transaction successful",
"reason": null,
"description": "Payment with Webpay",
"merchant_reference": null,
"provider_data": {
"id": "TRANSBANK_2",
"transaction_id": "",
"account_id": "",
"status": "",
"sub_status": "",
"status_detail": "",
"response_message": "",
"raw_response": {
"token": "01aba0f569c8a78370aa35461ca482b57d1b767365535de9a0540c03791a3d97",
"url": "https://webpay3gint.transbank.cl/webpayserver/initTransaction"
},
"third_party_transaction_id": ""
},
"created_at": "2023-07-23T23:11:24.842815Z",
"updated_at": "2023-07-23T23:11:26.242431Z"
},
"split": [],
"callback_url": "www.y.uno",
"workflow": "REDIRECT",
"metadata": []
}Pago Efectivo
Example of a request for a Payment Link payment using Pago Efectivo. 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.
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 Pago Efectivo",
"account_id": "<account_id>",
"merchant_order_id": "0000023",
"country": "CO",
"merchant_reference": "reference-0001",
"amount": {
"currency": "COP",
"value": 3000
},
"customer_payer": {
"email": "[email protected]",
"first_name": "John",
"last_name": "Smith",
"document": {
"document_type": "CC",
"document_number": "1032765432"
}
},
"payment_method": {
"type": "PAGO_EFECTIVO"
},
"workflow": "REDIRECT",
"callback_url":"www.y.uno"
}
'{
"id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"account_id": "<account_id>",
"description": "Payment with Pago Efectivo",
"country": "CO",
"status": "READY_TO_PAY",
"sub_status": "CREATED",
"merchant_order_id": "0000023",
"created_at": "2025-06-20T12:15:00.000000Z",
"updated_at": "2025-06-20T12:15:01.000000Z",
"amount": {
"captured": 0,
"currency": "COP",
"refunded": 0,
"value": 3000
},
"checkout": {
"session": "f9e8d7c6-b5a4-3210-fedc-ba9876543210",
"sdk_action_required": true
},
"payment_method": {
"vaulted_token": "",
"type": "PAGO_EFECTIVO",
"vault_on_success": false,
"token": "",
"payment_method_detail": {
"payment_link": {
"verify": null,
"capture": null,
"installments": null,
"payment_method_id": null,
"payment_method_detail": null,
"date_of_expiration": "2025-06-23T23:59:59Z",
"money_release_date": null,
"sponsor_id": null,
"authorization_code": null,
"redirect_url": "https://checkout.sandbox.y.uno/payment?session=f9e8d7c6-b5a4-3210-fedc-ba9876543210"
}
}
},
"customer_payer": {
"id": null,
"merchant_customer_id": null,
"first_name": "John",
"last_name": "Smith",
"gender": null,
"date_of_birth": null,
"email": "[email protected]",
"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": "CC",
"document_number": "1032765432"
},
"phone": null,
"billing_address": null,
"shipping_address": null
},
"additional_data": null,
"taxes": null,
"transactions": {
"id": "e0d9c8b7-a6f5-4321-0fed-cba987654321",
"type": "PURCHASE",
"status": "CREATED",
"category": "PAYMENT_LINK",
"amount": 3000.00,
"provider_id": "PAGO_EFECTIVO_CO",
"payment_method": {
"vaulted_token": "",
"type": "PAGO_EFECTIVO",
"vault_on_success": false,
"token": "",
"detail": {}
},
"response_code": "SUCCEEDED",
"response_message": "Transaction successful",
"reason": null,
"description": "Payment with Pago Efectivo",
"merchant_reference": "reference-0001",
"provider_data": {
"id": "PAGO_EFECTIVO_CO",
"transaction_id": "REF-ABC123XYZ",
"account_id": "",
"status": "",
"sub_status": "",
"status_detail": "",
"response_message": "",
"raw_response": {
"cie": "987654321098765",
"expiration_date": "2025-06-23"
},
"third_party_transaction_id": ""
},
"created_at": "2025-06-20T12:15:00.123456Z",
"updated_at": "2025-06-20T12:15:01.234567Z"
},
"split": [],
"callback_url": "www.y.uno",
"workflow": "REDIRECT",
"metadata": []
}