PayU Latam gateway guide
| Additional notes |
|---|
| For cvv less transactions, contact PayU LATAM gateway support to enable it on your account. Spreedly automatically sets processWithoutCvv2 flag based on cvv availability. |
| If you are using PayU LATAM in Chile, Panama, or Colombia, it’s important to note that PayU LATAM does not support the following API calls: authorize, capture, void, and verify. Affected customers should contact their PayU account manager for more advice and best practices if their transaction flow involves these API calls. |
Adding a PayU Latam gateway
To add a PayU gateway:
curl https://core.spreedly.com/v1/gateways.xml \
-u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
-H 'Content-Type: application/xml' \
-d '<gateway>
<gateway_type>payu_latam</gateway_type>
<merchant_id>Your merchant id</merchant_id>
<account_id>Your account id</account_id>
<api_login>Your API login</api_login>
<api_key>Your API key</api_key>
<payment_country>Your two-letter country code</payment_country>
</gateway>'<gateway>
<token>KDr8N47WhkkKCdeg9alKMiMxjqv</token>
<gateway_type>payu_latam</gateway_type>
<name>PayU Latam</name>
<description nil="true"/>
<merchant_profile_key nil="true"/>
<sub_merchant_key nil="true"/>
<merchant_id>Your merchant id</merchant_id>
<account_id>Your account id</account_id>
<api_login>Your API login</api_login>
<payment_country>Your two-letter country code</payment_country>
<characteristics>
<supports_purchase type="boolean">true</supports_purchase>
<supports_authorize type="boolean">true</supports_authorize>
<supports_capture type="boolean">true</supports_capture>
<supports_credit type="boolean">true</supports_credit>
<supports_general_credit type="boolean">false</supports_general_credit>
<supports_void type="boolean">true</supports_void>
<supports_adjust type="boolean">false</supports_adjust>
<supports_verify type="boolean">true</supports_verify>
<supports_reference_purchase type="boolean">false</supports_reference_purchase>
<supports_purchase_via_preauthorization type="boolean">false</supports_purchase_via_preauthorization>
<supports_offsite_purchase type="boolean">false</supports_offsite_purchase>
<supports_offsite_authorize type="boolean">false</supports_offsite_authorize>
<supports_offsite_synchronous_purchase type="boolean">false</supports_offsite_synchronous_purchase>
<supports_offsite_synchronous_authorize type="boolean">false</supports_offsite_synchronous_authorize>
<supports_3dsecure_purchase type="boolean">false</supports_3dsecure_purchase>
<supports_3dsecure_authorize type="boolean">false</supports_3dsecure_authorize>
<supports_3dsecure_2_mpi_purchase type="boolean">false</supports_3dsecure_2_mpi_purchase>
<supports_3dsecure_2_mpi_authorize type="boolean">false</supports_3dsecure_2_mpi_authorize>
<supports_store type="boolean">false</supports_store>
<supports_remove type="boolean">false</supports_remove>
<supports_fraud_review type="boolean">false</supports_fraud_review>
<supports_network_tokenization type="boolean">false</supports_network_tokenization>
</characteristics>
<credentials>
<credential>
<name>merchant_id</name>
<value>Your merchant id</value>
</credential>
<credential>
<name>account_id</name>
<value>Your account id</value>
</credential>
<credential>
<name>api_login</name>
<value>Your API login</value>
</credential>
<credential>
<name>payment_country</name>
<value>Your two-letter country code</value>
</credential>
</credentials>
<gateway_settings>
</gateway_settings>
<gateway_specific_fields>
<gateway_specific_field>installments_number</gateway_specific_field>
<gateway_specific_field>user_agent</gateway_specific_field>
<gateway_specific_field>cookie</gateway_specific_field>
<gateway_specific_field>device_session_id</gateway_specific_field>
<gateway_specific_field>dni_number</gateway_specific_field>
<gateway_specific_field>dni_type</gateway_specific_field>
<gateway_specific_field>merchant_buyer_id</gateway_specific_field>
<gateway_specific_field>tax</gateway_specific_field>
<gateway_specific_field>tax_return_base</gateway_specific_field>
<gateway_specific_field>cnpj</gateway_specific_field>
<gateway_specific_field>birth_date</gateway_specific_field>
<gateway_specific_field>description</gateway_specific_field>
<gateway_specific_field>buyer</gateway_specific_field>
<gateway_specific_field>verify_amount</gateway_specific_field>
<gateway_specific_field>language</gateway_specific_field>
<gateway_specific_field>extra_1</gateway_specific_field>
<gateway_specific_field>extra_2</gateway_specific_field>
<gateway_specific_field>extra_3</gateway_specific_field>
<gateway_specific_field>promotion_id</gateway_specific_field>
</gateway_specific_fields>
<payment_methods>
<payment_method>credit_card</payment_method>
</payment_methods>
<state>retained</state>
<redacted type="boolean">false</redacted>
<sandbox type="boolean">false</sandbox>
<mode>default</mode>
<created_at type="dateTime">2022-08-31T18:48:11Z</created_at>
<updated_at type="dateTime">2022-08-31T18:48:11Z</updated_at>
</gateway>Gateway specific fields
Spreedly supports the following gateway specific fields when transacting with PayU Latam:
dni_numberdni_typemerchant_buyer_idcnpjbirth_date( required for transactions in Mexico )description( can be sent to override the default value of: ‘Compra en merchant_name’ )tax( required for transactions in Colombia )tax_return_base( required for transactions in Colombia )installments_numberuser_agentcookiedevice_session_id( required for all transactions – see instructions below )buyer( see section below )verify_amount( can be sent inverifyAPI calls to override default minimum values. )language(overrides the language used in emails and error messages. The default language is sent asen, butesorptmay be sent.)extra_1extra_2extra_3promotion_id
Instructions for finding device_session_id can be found here under 'Devicesessionid variable’.
Buyer
The buyer gateway specific field is an element in which you may specify the following fields specific to the Buyer (as opposed to the Payer). If this element is not sent, the payer’s information will be used instead. If the element is sent with partial information, any missing fields will be sent as empty. In addition to these fields, PayU receives the buyer-specific phone number present in the shipping_address element if provided.
nameemaildni_numberdni_typemerchant_buyer_idcnpj( required for transactions in Brazil )
All gateway specific fields can be specified as follows:
curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.xml \
-u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
-H 'Content-Type: application/xml' \
-d '<transaction>
<payment_method_token>56wyNnSmuA6CWYP7w0MiYCVIbW6</payment_method_token>
<amount>100</amount>
<currency_code>USD</currency_code>
<gateway_specific_fields>
<payu_latam>
<installments_number>1</installments_number>
<user_agent>Mozilla/5.0 (Windows NT 5.1; rv:18.0) Gecko/20100101 Firefox/18.0</user_agent>
<cookie>pt1t38347bs6jc9ruv2ecpv7o2</cookie>
<device_session_id>vghs6tvkcle931686k1900o6e1</device_session_id>
<dni_number>5415668464654</dni_number>
<dni_type>TI</dni_type>
<merchant_buyer_id>1</merchant_buyer_id>
<tax>0</tax>
<tax_return_base>0</tax_return_base>
<cnpj>12347890</cnpj>
<birth_date>1982-03-01</birth_date>
<description>transaction description</description>
<language>es</language>
<buyer>
<name>Buyer Name</name>
<email>[email protected]</email>
<dni_number>5415668464654</dni_number>
<dni_type>TI</dni_type>
<merchant_buyer_id>1</merchant_buyer_id>
<cnpj>12347890</cnpj>
</buyer>
<verify_amount>5100</verify_amount>
<extra_1>123</extra_1>
<extra_2>456</extra_2>
<extra_3>7890</extra_3>
<promotion_id>1234567</promotion_id>
</payu_latam>
</gateway_specific_fields>
</transaction>'<transaction>
<on_test_gateway type="boolean">true</on_test_gateway>
<created_at type="dateTime">2022-08-31T18:48:10Z</created_at>
<updated_at type="dateTime">2022-08-31T18:48:10Z</updated_at>
<succeeded type="boolean">true</succeeded>
<state>succeeded</state>
<token>EaYLwVnt2wq9V16dD0eTVCgrAHQ</token>
<transaction_type>Purchase</transaction_type>
<order_id nil="true"/>
<ip nil="true"/>
<description nil="true"/>
<email nil="true"/>
<merchant_name_descriptor nil="true"/>
<merchant_location_descriptor nil="true"/>
<merchant_profile_key nil="true"/>
<gateway_specific_fields>
<payu_latam>
<installments_number>1</installments_number>
<user_agent>Mozilla/5.0 (Windows NT 5.1; rv:18.0) Gecko/20100101 Firefox/18.0</user_agent>
<cookie>pt1t38347bs6jc9ruv2ecpv7o2</cookie>
<device_session_id>vghs6tvkcle931686k1900o6e1</device_session_id>
<dni_number>5415668464654</dni_number>
<dni_type>TI</dni_type>
<merchant_buyer_id>1</merchant_buyer_id>
<tax>0</tax>
<tax_return_base>0</tax_return_base>
<cnpj>12347890</cnpj>
<birth_date>1982-03-01</birth_date>
<description>transaction description</description>
<language>es</language>
<buyer>
<name>Buyer Name</name>
<email>[email protected]</email>
<dni_number>5415668464654</dni_number>
<dni_type>TI</dni_type>
<merchant_buyer_id>1</merchant_buyer_id>
<cnpj>12347890</cnpj>
</buyer>
<verify_amount>5100</verify_amount>
<extra_1>123</extra_1>
<extra_2>456</extra_2>
<extra_3>7890</extra_3>
<promotion_id>1234567</promotion_id>
</payu_latam>
</gateway_specific_fields>
<gateway_specific_response_fields>
</gateway_specific_response_fields>
<gateway_transaction_id>45</gateway_transaction_id>
<sub_merchant_key nil="true"/>
<gateway_latency_ms type="integer">1</gateway_latency_ms>
<stored_credential_initiator nil="true"/>
<stored_credential_reason_type nil="true"/>
<populate_mit_fields type="boolean">false</populate_mit_fields>
<warning nil="true"/>
<application_id nil="true"/>
<amount type="integer">100</amount>
<local_amount nil="true"/>
<currency_code>USD</currency_code>
<retain_on_success type="boolean">false</retain_on_success>
<payment_method_added type="boolean">false</payment_method_added>
<smart_routed type="boolean">false</smart_routed>
<message key="messages.transaction_succeeded">Succeeded!</message>
<gateway_token>T11bJAANtTWnxl36GYjKWvbNK0g</gateway_token>
<gateway_type>test</gateway_type>
<shipping_address>
<name>Newfirst Newlast</name>
<address1 nil="true"/>
<address2 nil="true"/>
<city nil="true"/>
<state nil="true"/>
<zip nil="true"/>
<country nil="true"/>
<phone_number nil="true"/>
</shipping_address>
<response>
<success type="boolean">true</success>
<message>Successful purchase</message>
<avs_code nil="true"/>
<avs_message nil="true"/>
<cvv_code nil="true"/>
<cvv_message nil="true"/>
<pending type="boolean">false</pending>
<result_unknown type="boolean">false</result_unknown>
<error_code nil="true"/>
<error_detail nil="true"/>
<cancelled type="boolean">false</cancelled>
<fraud_review nil="true"/>
<created_at type="dateTime">2022-08-31T18:48:10Z</created_at>
<updated_at type="dateTime">2022-08-31T18:48:10Z</updated_at>
</response>
<api_urls>
</api_urls>
<payment_method>
<token>1rpKvP8zOUhj4Y9EDrIoIYQzzD5</token>
<created_at type="dateTime">2017-06-26T17:04:38Z</created_at>
<updated_at type="dateTime">2022-08-31T17:42:51Z</updated_at>
<email>[email protected]</email>
<data>
<my_payment_method_identifier>448</my_payment_method_identifier>
<extra_stuff>
<some_other_things>Can be anything really</some_other_things>
</extra_stuff>
</data>
<storage_state>retained</storage_state>
<test type="boolean">true</test>
<metadata>
<key>string value</key>
</metadata>
<callback_url nil="true"/>
<last_four_digits>1111</last_four_digits>
<first_six_digits>411111</first_six_digits>
<card_type>visa</card_type>
<first_name>Newfirst</first_name>
<last_name>Newlast</last_name>
<month type="integer">3</month>
<year type="integer">2032</year>
<address1 nil="true"/>
<address2 nil="true"/>
<city nil="true"/>
<state nil="true"/>
<zip nil="true"/>
<country nil="true"/>
<phone_number nil="true"/>
<company nil="true"/>
<full_name>Newfirst Newlast</full_name>
<eligible_for_card_updater type="boolean">true</eligible_for_card_updater>
<shipping_address1 nil="true"/>
<shipping_address2 nil="true"/>
<shipping_city nil="true"/>
<shipping_state nil="true"/>
<shipping_zip nil="true"/>
<shipping_country nil="true"/>
<shipping_phone_number nil="true"/>
<issuer_identification_number nil="true"/>
<payment_method_type>credit_card</payment_method_type>
<errors>
</errors>
<verification_value></verification_value>
<number>XXXX-XXXX-XXXX-1111</number>
<fingerprint>e3cef43464fc832f6e04f187df25af497994</fingerprint>
<stored_credential_usage>
<test>
<original_network_transaction_id>37be5367d6dbe4a88c9d</original_network_transaction_id>
<network_transaction_id>37be5367d6dbe4a88c9d</network_transaction_id>
</test>
</stored_credential_usage>
</payment_method>
<attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>Gateway specific response fields
A response from PayU Latam gateway may contain order_id, authorization_code, and additional_info fields, which you can find in the gateway_specific_response_fields. For example, a transaction could have something like this:
<transaction>
<token>LgpTNGjsWQs9DwdxcbreUVz0R8p</token>
<transaction_type>Purchase</transaction_type>
<gateway_specific_response_fields>
<payu_latam>
<order_id>abc123</order_id>
<authorization_code>123456</authorization_code>
<additional_info>
<paymentNetwork>VISANET_PE_V3</paymentNetwork>
<rejectionType>N/A</rejectionType>
</additional_info>
</payu_latam>
</gateway_specific_response_fields>
</transaction>To request any gateway_specific_fields or gateway_specific_response_fields, please contact Support with your request and the gateway documentation for the fields of interest.
Local Payment Methods
PayU LATAM is a leading payment service provider focused on Latin America, enabling merchants to accept a wide range of payment methods across key markets such as Argentina, Brazil, Chile, Colombia, Mexico, Panama, and Peru. PayU LATAM supports both traditional card payments and a diverse set of local payment methods (LPMs), including cash-based options like Oxxo (Mexico), Pago Efectivo (Peru), and Seven Eleven (Mexico), which are essential for maximizing market penetration in the region.
Spreedly supports a variety of payment methods through PayU LATAM. Each may require unique parameters and flows. Please expand each payment method's details to find implementation information.
PIX
PIX
PIX is an instant payment system developed by the Central Bank of Brazil that enables real-time bank transfers, 24/7, including weekends and holidays. When integrated through PayU Latam, PIX allows customers in Brazil to complete payments quickly using QR codes or PIX keys without needing credit cards.
PayU acts as the payment gateway, handling communication with Brazilian banks, generating QR codes, and managing transaction states (pending, approved, failed). For more information about PIX see Pix PayU documentation.
This integration is widely used for e-commerce, subscriptions, and digital services due to its speed and low failure rates.
Create Gateway Method
Endpoint
POST /v1/gateways.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"gateway": {
"gateway_type": "payu_latam", //Must be "payu_latam
"payment_country": "BR",
"merchant_id": "508029",
"account_id": "512327",
"api_login": "pRRXKOl8ikMmt9u",
"api_key": "4Vj8eK4rloUd272L48hsrarnUA",
"sandbox": true
}
}// Status Code: 201 Created
{
"gateway": {
"token": "4ZTE802Y7D8P0RQMNR7NWF7FAN", //Unique identifier for the payment method
"gateway_type": "payu_latam",
"description": null,
"merchant_profile_key": null,
"sub_merchant_key": null,
"payment_methods": [
"credit_card",
"efecty",
"pago_facil",
"rapi_pago",
"cobro_express",
"webpay",
"pix"
],
"state": "retained",
"created_at": "2025-12-09T11:09:07Z",
"updated_at": "2025-12-09T11:09:07Z",
"name": "PayU Latam",
"merchant_id": "508029",
"account_id": "512327",
"api_login": "pRRXKOl8ikMmt9u",
"payment_country": "BR",
"characteristics": [
"purchase",
"authorize",
"capture",
"partial_capture",
"credit",
"void",
"verify",
"offsite_purchase",
"transaction_retry"
],
"credentials": [
{
"name": "merchant_id",
"value": "508029"
},
{
"name": "account_id",
"value": "512327"
},
{
"name": "api_login",
"value": "pRRXKOl8ikMmt9u"
},
{
"name": "payment_country",
"value": "BR"
}
],
"gateway_settings": {},
"gateway_specific_fields": [
"installments_number",
"user_agent",
"cookie",
"device_session_id",
"dni_number",
"dni_type",
"merchant_buyer_id",
"tax",
"tax_return_base",
"cnpj",
"birth_date",
"description",
"buyer",
"verify_amount",
"language",
"extra_1",
"extra_2",
"extra_3"
],
"redacted": false,
"sandbox": true,
"mode": "default"
}
}Create Payment Method
Endpoint
POST /v1/payment_methods.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"payment_method": {
"email": "[email protected]",
"payment_method_type": "pix", //must be "pix"
"full_name": "S W User02",
"document_id": "456575749821",
"country": "BR",
"zip": "12345",
"address1": "1234 test ave",
"city": "Rio",
"state": "CE",
"phone_number": "1234567890"
}
}//Status Code: 201 Created
{
"transaction": {
"token": "HKQradKV9D2PXVsU7RrVCRxRdLG", //Unique identifier for the payment method
"created_at": "2025-12-08T13:56:04Z",
"updated_at": "2025-12-08T13:56:05Z",
"succeeded": true,
"transaction_type": "AddPaymentMethod",
"retained": false,
"state": "succeeded",
"message_key": "messages.transaction_succeeded",
"message": "Succeeded!",
"payment_method": {
"token": "ArSNbVML8S7hz4W09ga0mU67HX2",
"created_at": "2025-12-08T13:56:04Z",
"updated_at": "2025-12-08T13:56:05Z",
"email": "[email protected]",
"data": null,
"storage_state": "cached",
"test": false,
"metadata": null,
"callback_url": null,
"address1": "1234 test ave",
"address2": null,
"city": "Rio",
"state": "CE",
"zip": "12345",
"country": "BR",
"phone_number": "1234567890",
"full_name": "S W User01",
"first_name": "S W",
"last_name": "User01",
"payment_method_type": "pix",
"errors": [],
"document_id": "9821"
}
}
}Create QR Code
Endpoint
POST /v1/gateways/{{gateway_token}}/purchase.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"transaction": {
"payment_method_token": "{{payment_method_token}}", //Must be "payu_latam"
"amount": 600,
"currency_code": "USD",
"callback_url": "https://example.com",
"redirect_url": "https://example.com"
}
}//Status Code: 201 Created
{
"gateway": {
"token": "4ZTE802Y7D8P0RQMNR7NWF7FAN",
"gateway_type": "payu_latam",
"description": null,
"merchant_profile_key": null,
"sub_merchant_key": null,
"payment_methods": [
"credit_card",
"efecty",
"pago_facil",
"rapi_pago",
"cobro_express",
"webpay",
"pix"
],
"state": "retained",
"created_at": "2025-12-09T11:09:07Z",
"updated_at": "2025-12-09T11:09:07Z",
"name": "PayU Latam",
"merchant_id": "508029",
"account_id": "512327",
"api_login": "pRRXKOl8ikMmt9u",
"payment_country": "BR",
"characteristics": [
"purchase",
"authorize",
"capture",
"partial_capture",
"credit",
"void",
"verify",
"offsite_purchase",
"transaction_retry"
],
"credentials": [
{
"name": "merchant_id",
"value": "508029"
},
{
"name": "account_id",
"value": "512327"
},
{
"name": "api_login",
"value": "pRRXKOl8ikMmt9u"
},
{
"name": "payment_country",
"value": "BR"
}
],
"gateway_settings": {},
"gateway_specific_fields": [
"installments_number",
"user_agent",
"cookie",
"device_session_id",
"dni_number",
"dni_type",
"merchant_buyer_id",
"tax",
"tax_return_base",
"cnpj",
"birth_date",
"description",
"buyer",
"verify_amount",
"language",
"extra_1",
"extra_2",
"extra_3"
],
"redacted": false,
"sandbox": true,
"mode": "default"
}
}{
"transaction": {
"on_test_gateway": true,
"created_at": "2025-12-08T13:07:42Z",
"updated_at": "2025-12-08T13:08:29Z",
"succeeded": false,
"state": "pending",
"token": "D2TO4heHiZfX1pFHsLhys1J0Wvi",
"transaction_type": "OffsitePurchase",
"order_id": null,
"ip": null,
"description": null,
"email": null,
"merchant_name_descriptor": null,
"merchant_location_descriptor": null,
"merchant_profile_key": null,
"gateway_specific_fields": null,
"gateway_specific_response_fields": {
"payu_latam": {
"order_id": 2156067394,
"vid": "69668ac5-1320-45a9-a0da-2485c37ad8d5"
"additional_info": {
"paymentNetwork": "PIX",
"rejectionType": "NONE",
"responseNetworkMessage": null,
"travelAgencyAuthorizationCode": null,
"cardType": null,
"transactionType": "AUTHORIZATION_AND_CAPTURE"
}
}
},
"gateway_transaction_id": "69668ac5-1320-45a9-a0da-2485c37ad8d5",
"sub_merchant_key": null,
"gateway_latency_ms": 1077,
"warning": null,
"application_id": null,
"risk_data": null,
"merchant_metadata": null,
"customer_data": null,
"order_data": null,
"workflow_key": null,
"protection_parameters": null,
"amount": 300,
"local_amount": null,
"currency_code": "USD",
"reference": "2156067394|69668ac5-1320-45a9-a0da-2485c37ad8d5",
"setup_verification": null,
"expiration_date": "2025-12-08 19:37:43 +0530",
"stored_credential_initiator": null,
"stored_credential_reason_type": null,
"stored_credential_alternate_gateway": null,
"stored_credential_final_payment": false,
"retain_on_success": false,
"message_key": "messages.transaction_pending",
"message": "Pending",
"gateway_token": "3DG01F3S5Q8049FXR976941PPC",
"gateway_type": "payu_latam",
"response": {
"success": true,
"message": "PENDING_PAYMENT_IN_ENTITY",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-12-08T13:08:28Z",
"updated_at": "2025-12-08T13:08:29Z",
"status": null,
"checkout_url": "http://ppp-web-gateway-payu.transactional.payu.sandbox/ppp-web-gateway-payu/app/v2?vid=2156067394Y69668ac5132045aY357c92b96cb13bc"
},
"shipping_address": {
"name": "S W User01",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": null,
"phone_number": null
},
"api_urls": [
{
"callback_conversations": [
"http://core.spreedly.test/v1/callbacks/0P3C48M4KR9E28BSV6VQPCZSTC/conversations.xml"
]
}
],
"redirect_url": "https://example.com",
"checkout_url": "http://ppp-web-gateway-payu.transactional.payu.sandbox/ppp-web-gateway-payu/app/v2?vid=2156067394Y69668ac5132045aY357c92b96cb13bc",
"callback_url": "https://example.com",
"attempt_3dsecure": false,
"challenge_url": null,
"required_action": "none",
"three_ds_context": null,
"setup_response": {
"success": true,
"message": "PENDING_PAYMENT_IN_ENTITY",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-12-08T13:08:28Z",
"updated_at": "2025-12-08T13:08:29Z",
"status": null,
"checkout_url": "http://ppp-web-gateway-payu.transactional.payu.sandbox/ppp-web-gateway-payu/app/v2?vid=2156067394Y69668ac5132045aY357c92b96cb13bc"
},
"payment_method": {
"token": "OyP3fuAuXydZ4cPhi6YMAGlu7XL",
"created_at": "2025-12-08T12:01:30Z",
"updated_at": "2025-12-08T12:01:30Z",
"email": "[email protected]",
"data": null,
"storage_state": "cached",
"test": false,
"metadata": null,
"callback_url": null,
"full_name": "S W User01",
"first_name": "S W",
"last_name": "User01",
"payment_method_type": "pix",
"errors": []
}
}
}//Status Code: 408 Request Timeout
{
"transaction": {
"on_test_gateway": true,
"created_at": "2025-12-09T10:55:00Z",
"updated_at": "2025-12-09T11:10:05Z",
"succeeded": false,
"state": "failed",
"token": "TXN_TIMEOUT_789XYZ",
"transaction_type": "OffsitePurchase",
"gateway_transaction_id": "timeout-7890-4567-1234",
"amount": 600,
"currency_code": "USD",
"reference": "2156068123|timeout-7890-4567-1234",
"message_key": "messages.transaction_failed",
"message": "Failed",
"gateway_type": "payu_latam",
"response": {
"success": false,
"message": "EXPIRED",
"pending": false,
"result_unknown": false,
"error_code": "PAYU_PIX_002",
"error_detail": "The PIX QR code expired before the payment was completed.",
"status": "EXPIRED",
"created_at": "2025-12-09T11:10:05Z",
"updated_at": "2025-12-09T11:10:05Z",
"checkout_url": null
},
"gateway_specific_response_fields": {
"payu_latam": {
"order_id": 2156068123,
"additional_info": {
"paymentNetwork": "PIX",
"rejectionType": "EXPIRED",
"responseNetworkMessage": "QR code expired",
"transactionType": "AUTHORIZATION_AND_CAPTURE"
}
}
},
"callback_url": "https://example.com",
"redirect_url": "https://example.com"
}
}QR Code Details
The QR code is available in two formats:
- QR Code URL
You can redirect the customer to this hosted page:
transaction.response.checkout_urlExample:
http://ppp-web-gateway-payu.transactional.payu.sandbox/ppp-web-gateway-payu/app/v2?vid=...- QR Code Base64 Image
In some configurations, PayU may also return a Base64-encoded QR image that you can embed directly in your UI.
You can use it like this:
<img src="data:image/png;base64,{{qr_base64}}" />- Approval of Payment
After scanning the QR code, the payment status is automatically updated from Pending to Succeeded.
Payment Flow
- Create the PIX payment method
- Call the purchase endpoint (this API)
- Receive QR code + checkout URL
- Display QR code to the customer
- Customer scans & completes payment
- PayU sends status update to your callback_url
Possible Transaction States
PIX transactions go through clear states as below:
| Sate | Description |
|---|---|
| PENDING | Customer has not completed payment yet |
| APPROVED | Payment completed successfully |
| FAILED | Payment failed |
| DECLINED | Bank rejected the transaction |
Notes
- The QR code expires at the time specified in expiration_date.
- Always rely on callback/web-hook updates for final payment status.
PagoFacil
PagoFacil
PagoFacil, specifically, is a widely used cash payment network in Argentina. It allows customers to initiate online purchases and complete payment in cash at any PagoFacil location, making it a critical payment option for merchants targeting the Argentine market. For more information about Pago Facil see Pago Facil PayU documentation.
Create Payment Method
Endpoint
POST /v1/payment_methods.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"payment_method": {
"email": "[email protected]",
"payment_method_type": "pago_facil", //Must be "pago_facil"
"full_name": "test pago",
"document_id": "575345678",
"phone_number": "8522849999",
"country": "AR"
}
}// Status Code: 201 Created
{
"transaction": {
"token": "9xIu4Pq3IL9m42ve4mMvFQRK0Zq", // Unique identifier for the payment method
"created_at": "2025-11-06T10:50:20Z",
"updated_at": "2025-11-06T10:50:20Z",
"succeeded": true,
"transaction_type": "AddPaymentMethod",
"retained": false,
"state": "succeeded",
"message_key": "messages.transaction_succeeded",
"message": "Succeeded!",
"payment_method": {
"token": "PkYb7WTTvjTr8A7CQsCMgPAKLiq",
"created_at": "2025-11-06T10:50:20Z",
"updated_at": "2025-11-06T10:50:20Z",
"email": "[email protected]",
"data": null,
"storage_state": "cached",
"test": false,
"metadata": null,
"callback_url": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": "CO",
"phone_number": "8522849999",
"full_name": "test pago",
"first_name": "test",
"last_name": "pago",
"payment_method_type": "pago_facil",
"errors": [],
"document_id": "5678"
}
}
}Create Purchase Transaction
Endpoint
POST /v1/gateways/{{payu_gateway_token}}/purchase.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"transaction": {
"payment_method_token": "{{payment_method_token}}", //AlphaNumeric, required): “hf748yh8f4h8fh4g8fh4g“
"amount": 1000, //(Numeric, required): 1000
"currency_code": "USD", //(String, required): “USD“
"callback_url": "https://example.com",
"redirect_url": "https://example.com"
}
}// Status Code: 202 Accepted
{
"transaction": {
"on_test_gateway": true,
"created_at": "2025-11-06T04:38:50Z",
"updated_at": "2025-11-06T04:38:53Z",
"succeeded": false,
"state": "pending",
"token": "SYBy3hmjxpn1ROA4GKnrfUofbjE",
"transaction_type": "OffsitePurchase",
"order_id": null,
"ip": null,
"description": null,
"email": null,
"merchant_name_descriptor": null,
"merchant_location_descriptor": null,
"merchant_profile_key": null,
"gateway_specific_fields": null,
"gateway_specific_response_fields": {
"payu_latam": {
"order_id": 2155818942,
"additional_info": {
"paymentNetwork": "PAGOFACIL",
"rejectionType": "NONE",
"responseNetworkMessage": null,
"travelAgencyAuthorizationCode": null,
"cardType": null,
"transactionType": "AUTHORIZATION_AND_CAPTURE"
}
}
},
"gateway_transaction_id": "1f5a43a0-d8de-4adc-af10-16769353b1b1",
"sub_merchant_key": null,
"gateway_latency_ms": 1919,
"warning": null,
"application_id": null,
"risk_data": null,
"merchant_metadata": null,
"customer_data": null,
"order_data": null,
"workflow_key": null,
"protection_parameters": null,
"amount": 1000,
"local_amount": null,
"currency_code": "USD",
"reference": "2155818942|1f5a43a0-d8de-4adc-af10-16769353b1b1",
"setup_verification": null,
"expiration_date": "2025-11-21 10:29:59 +0530",
"stored_credential_initiator": null,
"stored_credential_reason_type": null,
"stored_credential_alternate_gateway": null,
"stored_credential_final_payment": false,
"retain_on_success": false,
"message_key": "messages.transaction_pending",
"message": "Pending",
"gateway_token": "1JP4WS16NG8DBTTHDY3JPQENCS",
"gateway_type": "payu_latam",
"response": {
"success": true,
"message": "PENDING_TRANSACTION_CONFIRMATION",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-11-06T04:38:52Z",
"updated_at": "2025-11-06T04:38:53Z",
"status": null,
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2155818942Y1f5a43a0d8de4adYa46d3e88b6b659b"
},
"shipping_address": {
"name": "test pago",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": null,
"phone_number": null
},
"api_urls": [
{
"callback_conversations": [
"http://core.spreedly.test/v1/callbacks/2EY6V55DZ694AVYPM2HJ5T6D57/conversations.xml"
]
}
],
"redirect_url": "https://example.com",
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2155818942Y1f5a43a0d8de4adYa46d3e88b6b659b",
"callback_url": "https://example.com",
"attempt_3dsecure": false,
"challenge_url": null,
"required_action": "none",
"three_ds_context": null,
"setup_response": {
"success": true,
"message": "PENDING_TRANSACTION_CONFIRMATION",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-11-06T04:38:52Z",
"updated_at": "2025-11-06T04:38:53Z",
"status": null,
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2155818942Y1f5a43a0d8de4adYa46d3e88b6b659b"
},
"payment_method": {
"token": "JSRIW4o0Di5WzSloyq4eHeoKxoD",
"created_at": "2025-11-06T04:38:09Z",
"updated_at": "2025-11-06T04:38:09Z",
"email": "[email protected]",
"data": null,
"storage_state": "cached",
"test": false,
"metadata": null,
"callback_url": null,
"full_name": "test pago",
"first_name": "test",
"last_name": "pago",
"payment_method_type": "pago_facil",
"errors": []
}
}
}Transaction Response Mapping
| Field Name | Notes |
|---|---|
token | (string): Unique identifier for the payment method |
success | (boolean): Must be true for successful purchase |
message | (string): Must be PENDING_TRANSACTION_CONFIRMATION for cash based transactions. |
Gateway Specific Response Mapping
| Field Name | Notes |
|---|---|
order_id | (Number): Unique identifier for the order confirmation |
success | (Boolean): Must be true for successful purchase |
paymentNetwork | (String): Should be PAGOFACIL |
transactionType | (Boolean): Must be AUTHORIZATION_AND_CAPTURE for cash based successful purchase |
RapiPago
RapiPago
Rapi Pago is one of the major local payment methods (LPM) that allows customers to pay for online purchases with cash at physical collection points across the country. For detailed information about Rapi Pago see Rapi Pago PayU documentation.
Create Payment Method
Endpoint
POST /v1/payment_methods.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"payment_method": {
"email": "[email protected]",
"payment_method_type": "rapi_pago", //(string, required): Must be "rapi_pago"
"full_name": "test rapi pago",
"document_id": "5753727345",
"phone_number": "8522843025",
"country": "AR"
}
}//Status Code: 201 Created
{
"transaction": {
"token": "ToEAjLZH7NcvcveWEuEsFO670yR", //Unique identifier for the payment method
"created_at": "2025-11-06T10:56:52Z",
"updated_at": "2025-11-06T10:56:52Z",
"succeeded": true,
"transaction_type": "AddPaymentMethod",
"retained": false,
"state": "succeeded",
"message_key": "messages.transaction_succeeded",
"message": "Succeeded!",
"payment_method": {
"token": "52PBgf8keDGD0OaGOBs5WVMreyQ",
"created_at": "2025-11-06T10:56:52Z",
"updated_at": "2025-11-06T10:56:52Z",
"email": "[email protected]",
"data": null,
"storage_state": "cached",
"test": false,
"metadata": null,
"callback_url": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": "AR",
"phone_number": "8522843025",
"full_name": "test rapi pago",
"first_name": "test rapi",
"last_name": "pago",
"payment_method_type": "rapi_pago",
"errors": [],
"document_id": "7345"
}
}
}Create Purchase Transaction
Endpoint
POST /v1/gateways/{{payu_gateway_token}}/purchase.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"transaction": {
"payment_method_token": "{{payment_method_token}}", //(AlphaNumeric, required): “hf748yh8f4h8fh4g8fh4g“
"amount": 1000, //(Numeric, required): 1000
"currency_code": "USD", //(String, requied): "USD"
"callback_url": "https://example.com",
"redirect_url": "https://example.com"
}
}//Status Code: 202 Accepted
{
"transaction": {
"on_test_gateway": true,
"created_at": "2025-11-15T18:01:20Z",
"updated_at": "2025-11-15T18:01:25Z",
"succeeded": false,
"state": "pending",
"token": "OFERoXhtFbYhXKfdL4tzXfSpmls",
"transaction_type": "OffsitePurchase",
"order_id": null,
"ip": null,
"description": null,
"email": null,
"merchant_name_descriptor": null,
"merchant_location_descriptor": null,
"merchant_profile_key": null,
"gateway_specific_fields": null,
"gateway_specific_response_fields": {
"payu_latam": {
"order_id": 2155893209,
"additional_info": {
"paymentNetwork": "RAPIPAGO",
"rejectionType": "NONE",
"responseNetworkMessage": null,
"travelAgencyAuthorizationCode": null,
"cardType": null,
"transactionType": "AUTHORIZATION_AND_CAPTURE"
}
}
},
"gateway_transaction_id": "14a22c3d-be49-473f-b992-c3bdb82579d9",
"sub_merchant_key": null,
"gateway_latency_ms": 2089,
"warning": null,
"application_id": null,
"risk_data": null,
"merchant_metadata": null,
"customer_data": null,
"order_data": null,
"workflow_key": null,
"protection_parameters": null,
"amount": 1000,
"local_amount": null,
"currency_code": "USD",
"reference": "2155893209|14a22c3d-be49-473f-b992-c3bdb82579d9",
"setup_verification": null,
"expiration_date": "2025-12-01 10:29:59 +0530",
"stored_credential_initiator": null,
"stored_credential_reason_type": null,
"stored_credential_alternate_gateway": null,
"stored_credential_final_payment": false,
"retain_on_success": false,
"message_key": "messages.transaction_pending",
"message": "Pending",
"gateway_token": "6HAW26A5RE8NWSX3VXDCAAK6B6",
"gateway_type": "payu_latam",
"response": {
"success": true,
"message": "PENDING_TRANSACTION_CONFIRMATION",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-11-15T18:01:22Z",
"updated_at": "2025-11-15T18:01:25Z",
"status": null,
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2155893209Y14a22c3dbe49473Y05ff31ef1766e5f"
},
"shipping_address": {
"name": "test rapi pago",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": null,
"phone_number": null
},
"api_urls": [
{
"callback_conversations": [
"http://core.spreedly.test/v1/callbacks/1P84GC3GNQ8A7A8Q374YAF0CPG/conversations.xml"
]
}
],
"redirect_url": "https://example.com",
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2155893209Y14a22c3dbe49473Y05ff31ef1766e5f",
"callback_url": "https://example.com",
"attempt_3dsecure": false,
"challenge_url": null,
"required_action": "none",
"three_ds_context": null,
"setup_response": {
"success": true,
"message": "PENDING_TRANSACTION_CONFIRMATION",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-11-15T18:01:22Z",
"updated_at": "2025-11-15T18:01:25Z",
"status": null,
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2155893209Y14a22c3dbe49473Y05ff31ef1766e5f"
},
"payment_method": {
"token": "DnJldeq5alc0Rsjuzpv4RbojOnT",
"created_at": "2025-11-15T17:56:55Z",
"updated_at": "2025-11-15T17:56:55Z",
"email": "[email protected]",
"data": null,
"storage_state": "cached",
"test": false,
"metadata": null,
"callback_url": null,
"full_name": "test rapi pago",
"first_name": "test rapi",
"last_name": "pago",
"payment_method_type": "rapi_pago",
"errors": []
}
}
}Transaction Response Mapping
| Field Name | Notes |
|---|---|
token | (string): Unique identifier for the payment method |
success | (boolean): Must be true for successful purchase |
message | (string): Must be PENDING_TRANSACTION_CONFIRMATION for cash based transactions. |
Gateway Specific Response Mapping
| Field Name | Notes |
|---|---|
order_id | (Number): Unique identifier for the order confirmation |
success | (Boolean): Must be true for successful purchase |
paymentNetwork | (String): Should be RAPIPAGO |
transactionType | (Boolean): Must be AUTHORIZATION_AND_CAPTURE for cash based successful purchase |
CobroExpress
My Accordion Title
Cobro Express is one of the widely used local payment methods (LPM) that allows customers to pay for online purchases with cash at physical collection points across the country. For more information about Cobro Express see Cobro Express documentation.
Create Payment Method
Endpoint
POST /v1/payment_methods.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"payment_method": {
"email": "[email protected]",
"payment_method_type": "cobro_express", //Must be "cobro_express"
"full_name": "test cobro express",
"document_id": "573727345",
"phone_number": "8529843025",
"country": "AR"
}
}//Status Code: 201 Created
{
"transaction": {
"token": "ObvgX0aJx5C4rOaa8CeEJ9QA2WK", //Unique identifier for the payment method
"created_at": "2025-11-15T18:26:53Z",
"updated_at": "2025-11-15T18:26:53Z",
"succeeded": true,
"transaction_type": "AddPaymentMethod",
"retained": false,
"state": "succeeded",
"message_key": "messages.transaction_succeeded",
"message": "Succeeded!",
"payment_method": {
"token": "1aHXEETaiItvcVUyeQwjvlkLUlD",
"created_at": "2025-11-15T18:26:53Z",
"updated_at": "2025-11-15T18:26:53Z",
"email": "[email protected]",
"data": null,
"storage_state": "cached",
"test": false,
"metadata": null,
"callback_url": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": "AR",
"phone_number": "8529843025",
"full_name": "test cobro express",
"first_name": "test cobro",
"last_name": "express",
"payment_method_type": "cobro_express",
"errors": [],
"document_id": "7345"
}
}
}Create Purchase Transaction
Endpoint
POST /v1/gateways/{{payu_gateway_token}}/purchase.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"transaction": {
"payment_method_token": "{{payment_method_token}}", //(AlphaNumeric, required): “hf748yh8f4h8fh4g8fh4g“
"amount": 1000, //(Numeric, required): 1000
"currency_code": "USD", //(String, required) "USD"
"callback_url": "https://example.com",
"redirect_url": "https://example.com"
}
}//Status Code: 202 Accepted
{
"transaction": {
"on_test_gateway": false,
"created_at": "2025-11-24T12:03:23Z",
"updated_at": "2025-11-24T12:03:26Z",
"succeeded": false,
"state": "pending",
"token": "AEIFvhqrgJMBjbkHHTHZz8wagL7",
"transaction_type": "OffsitePurchase",
"order_id": null,
"ip": null,
"description": null,
"email": null,
"merchant_name_descriptor": null,
"merchant_location_descriptor": null,
"merchant_profile_key": null,
"gateway_specific_fields": null,
"gateway_specific_response_fields": {
"payu_latam": {
"order_id": 876436283,
"additional_info": {
"paymentNetwork": "COBROEXPRESS",
"rejectionType": "NONE",
"responseNetworkMessage": null,
"travelAgencyAuthorizationCode": null,
"cardType": null,
"transactionType": "AUTHORIZATION_AND_CAPTURE"
}
}
},
"gateway_transaction_id": "bd455d33-54aa-4697-81c8-ee833398a2e3",
"sub_merchant_key": null,
"gateway_latency_ms": 2497,
"warning": null,
"application_id": null,
"risk_data": null,
"merchant_metadata": null,
"customer_data": null,
"order_data": null,
"workflow_key": null,
"protection_parameters": null,
"amount": 1000,
"local_amount": null,
"currency_code": "USD",
"reference": null,
"setup_verification": null,
"expiration_date": "2025-12-10 10:29:59 +0530",
"stored_credential_initiator": null,
"stored_credential_reason_type": null,
"stored_credential_alternate_gateway": null,
"stored_credential_final_payment": false,
"retain_on_success": false,
"message_key": "messages.transaction_pending",
"message": "Pending",
"gateway_token": "4XCDRYKMYJ9DK99EKC0R8R3DYH",
"gateway_type": "payu_latam",
"response": {
"success": true,
"message": "PENDING_TRANSACTION_CONFIRMATION",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-11-24T12:03:25Z",
"updated_at": "2025-11-24T12:03:26Z",
"status": null,
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app?vid=876436283Ybd455d3354aa469Y193f226b0e8cef4"
},
"shipping_address": {
"name": "test cobro express",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": null,
"phone_number": null
},
"api_urls": [
{
"callback_conversations": [
"http://core.spreedly.test/v1/callbacks/1P84GC3GNQ8A7A8Q374YAF0CPG/conversations.xml"
]
}
],
"redirect_url": "https://example.com",
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app?vid=876436283Ybd455d3354aa469Y193f226b0e8cef4",
"callback_url": "https://webhook.site/975550d4-2d27-4a41-b549-c57667a24376",
"attempt_3dsecure": false,
"challenge_url": null,
"required_action": "none",
"three_ds_context": null,
"setup_response": {
"success": true,
"message": "PENDING_TRANSACTION_CONFIRMATION",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-11-24T12:03:25Z",
"updated_at": "2025-11-24T12:03:26Z",
"status": null,
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app?vid=876436283Ybd455d3354aa469Y193f226b0e8cef4"
},
"payment_method": {
"token": "01KATVC9AF8RKMSPE88MC2SWFR",
"created_at": "2025-11-24T11:53:24.558Z",
"updated_at": "2025-11-24T11:53:24.558Z",
"email": "[email protected]",
"data": null,
"storage_state": "cached",
"test": false,
"metadata": null,
"callback_url": null,
"full_name": "test cobro express",
"first_name": "test cobro",
"last_name": "express",
"payment_method_type": "cobro_express",
"errors": []
}
}
}Transaction Response Mapping
| Field Name | Notes |
|---|---|
token | (string): Unique identifier for the payment method |
success | (boolean): Must be true for successful purchase |
message | (string): Must be PENDING_TRANSACTION_CONFIRMATION for cash based transactions. |
Gateway Specific Response Mapping
| Field Name | Notes |
|---|---|
order_id | (Number): Unique identifier for the order confirmation |
success | (Boolean): Must be true for successful purchase |
paymentNetwork | (String): Should be COBROEXPRESS |
transactionType | (Boolean): Must be AUTHORIZATION_AND_CAPTURE for cash based successful purchase |
Efecty
Efecty
Efecty is a cash-based local payment method supported by PayU LATAM and available exclusively in Colombia. It allows customers to pay for online purchases in cash at a large network of authorized Efecty physical locations across the country. For more information about Efecty see Efecty PayU documentation.
Efecty follows an offsite payment flow, where PayU generates a payment voucher and notifies the merchant asynchronously once the customer completes the cash payment.
Create Gateway Method
Endpoint
POST /v1/gateways.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"gateway": {
"gateway_type": "payu_latam", //Must be "payu_latam"
"payment_country": "CO",
"merchant_id": "511896",
"account_id": "516943",
"api_login": "F4VeC0yy4nXP50N",
"api_key": "ZuirOq3U5Kq55tWINW4a408pn2",
"sandbox": true
}
}//Status Code: 201 Created
{
"gateway": {
"token": "13Y1M1HVJ79NN9151R329SCHCR", //Unique identifier for the PayU Latam gateway
"gateway_type": "payu_latam",
"description": null,
"merchant_profile_key": null,
"sub_merchant_key": null,
"payment_methods": [ //Enabled methods including efecty
"credit_card",
"efecty",
"pago_facil",
"rapi_pago",
"cobro_express",
"webpay",
"pago_efectivo",
"pagos_farmacias",
"seven_eleven",
"pix",
"oxxo",
"pse"
],
"state": "retained",
"created_at": "2025-12-19T07:10:43Z",
"updated_at": "2025-12-19T07:10:43Z",
"name": "PayU Latam",
"merchant_id": "511896",
"account_id": "516943",
"api_login": "F4VeC0yy4nXP50N",
"payment_country": "CO",
"characteristics": [
"purchase",
"authorize",
"capture",
"partial_capture",
"credit",
"void",
"verify",
"offsite_purchase",
"transaction_retry"
],
"credentials": [
{
"name": "merchant_id",
"value": "511896"
},
{
"name": "account_id",
"value": "516943"
},
{
"name": "api_login",
"value": "F4VeC0yy4nXP50N"
},
{
"name": "payment_country",
"value": "CO"
}
],
"gateway_settings": {},
"gateway_specific_fields": [
"installments_number",
"user_agent",
"cookie",
"device_session_id",
"dni_number",
"dni_type",
"merchant_buyer_id",
"tax",
"tax_return_base",
"cnpj",
"birth_date",
"description",
"buyer",
"verify_amount",
"language",
"extra_1",
"extra_2",
"extra_3",
"expiration_date",
"pse_code",
"financial_institution_code",
"user_type"
],
"redacted": false,
"sandbox": true,
"mode": "default"
}
}API Parameters
| Field Name | Description |
|---|---|
| gateway_type | Must be payu_latam |
| payment_country | CO (Colombia) |
| merchant_id | PayU merchant ID |
| account_id | PayU account ID |
| api_login | PayU API login |
| api_key | PayU API key |
| sandbox | Enable sandbox mode |
Create Payment Method
Endpoint
POST /v1/payment_methods.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"payment_method": {
"email": "[email protected]",
"payment_method_type": "efecty", //Must be "efecty
"full_name": "test efecty",
"document_id": "575345678",
"phone_number": "8522849999",
"country": "CO"
}
}//Status Code: 201 Created
{
"transaction": {
"token": "9xIu4Pq3IL9m42ve4mMvFQRK0Zq",
"created_at": "2025-11-06T10:50:20Z",
"updated_at": "2025-11-06T10:50:20Z",
"succeeded": true,
"transaction_type": "AddPaymentMethod",
"retained": false,
"state": "succeeded",
"message_key": "messages.transaction_succeeded",
"message": "Succeeded!",
"payment_method": {
"token": "PkYb7WTTvjTr8A7CQsCMgPAKLiq", //Unique identifier for the payment method
"created_at": "2025-11-06T10:50:20Z",
"updated_at": "2025-11-06T10:50:20Z",
"email": "[email protected]",
"data": null,
"storage_state": "cached",
"test": false,
"metadata": null,
"callback_url": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": "CO",
"phone_number": "8522849999",
"full_name": "test efecty",
"first_name": "test",
"last_name": "efecty",
"payment_method_type": "efecty",
"errors": [],
"document_id": "5678"
}
}
}Create Purchase Transaction
Endpoint
POST /v1/gateways/{{payu_gateway_token}}/purchase.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"transaction": {
"payment_method_token": "{{payment_method_token}}", //(AlphaNumeric, required): “hf748yh8f4h8fh4g8fh4g“
"amount": 1000, //(Numeric, required): 1000
"currency_code": "USD", //currency_code": "USD",
"callback_url": "https://example.com", //string
"redirect_url": "https://example.com" //string
}
}//Status Code: 202 Accepted
{
"transaction": {
"on_test_gateway": true,
"created_at": "2025-11-06T04:38:50Z",
"updated_at": "2025-11-06T04:38:53Z",
"succeeded": false,
"state": "pending",
"token": "SYBy3hmjxpn1ROA4GKnrfUofbjE",
"transaction_type": "OffsitePurchase",
"order_id": null,
"ip": null,
"description": null,
"email": null,
"merchant_name_descriptor": null,
"merchant_location_descriptor": null,
"merchant_profile_key": null,
"gateway_specific_fields": null,
"gateway_specific_response_fields": {
"payu_latam": {
"order_id": 2155818942,
"additional_info": {
"paymentNetwork": "EFECTY",
"rejectionType": "NONE",
"responseNetworkMessage": null,
"travelAgencyAuthorizationCode": null,
"cardType": null,
"transactionType": "AUTHORIZATION_AND_CAPTURE"
}
}
},
"gateway_transaction_id": "1f5a43a0-d8de-4adc-af10-16769353b1b1",
"sub_merchant_key": null,
"gateway_latency_ms": 1919,
"warning": null,
"application_id": null,
"risk_data": null,
"merchant_metadata": null,
"customer_data": null,
"order_data": null,
"workflow_key": null,
"protection_parameters": null,
"amount": 1000,
"local_amount": null,
"currency_code": "USD",
"reference": "2155818942|1f5a43a0-d8de-4adc-af10-16769353b1b1",
"setup_verification": null,
"expiration_date": "2025-11-21 10:29:59 +0530",
"stored_credential_initiator": null,
"stored_credential_reason_type": null,
"stored_credential_alternate_gateway": null,
"stored_credential_final_payment": false,
"retain_on_success": false,
"message_key": "messages.transaction_pending",
"message": "Pending",
"gateway_token": "1JP4WS16NG8DBTTHDY3JPQENCS",
"gateway_type": "payu_latam",
"response": {
"success": true,
"message": "PENDING_TRANSACTION_CONFIRMATION",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-11-06T04:38:52Z",
"updated_at": "2025-11-06T04:38:53Z",
"status": null,
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2155818942Y1f5a43a0d8de4adYa46d3e88b6b659b"
},
"shipping_address": {
"name": "test efecty",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": null,
"phone_number": null
},
"api_urls": [
{
"callback_conversations": [
"http://core.spreedly.test/v1/callbacks/2EY6V55DZ694AVYPM2HJ5T6D57/conversations.xml"
]
}
],
"redirect_url": "https://example.com",
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2155818942Y1f5a43a0d8de4adYa46d3e88b6b659b",
"callback_url": "https://example.com",
"attempt_3dsecure": false,
"challenge_url": null,
"required_action": "none",
"three_ds_context": null,
"setup_response": {
"success": true,
"message": "PENDING_TRANSACTION_CONFIRMATION",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-11-06T04:38:52Z",
"updated_at": "2025-11-06T04:38:53Z",
"status": null,
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2155818942Y1f5a43a0d8de4adYa46d3e88b6b659b"
},
"payment_method": {
"token": "JSRIW4o0Di5WzSloyq4eHeoKxoD",
"created_at": "2025-11-06T04:38:09Z",
"updated_at": "2025-11-06T04:38:09Z",
"email": "[email protected]",
"data": null,
"storage_state": "cached",
"test": false,
"metadata": null,
"callback_url": null,
"full_name": "test efecty",
"first_name": "test",
"last_name": "efecty",
"payment_method_type": "efecty",
"errors": []
}
}
}Transaction Response Mapping
| Field Name | Notes |
|---|---|
token | (string): Unique identifier for the payment method |
success | (boolean): Must be true for successful purchase |
message | (string): Must be PENDING_TRANSACTION_CONFIRMATION for cash based transactions. |
Gateway Specific Mapping
| Field Name | Notes |
|---|---|
order_id | (Number): Unique identifier for the order confirmation |
success | (Boolean): Must be true for successful purchase |
paymentNetwork | (String): Should be EFECTY |
transactionType | (Boolean): Must be AUTHORIZATION_AND_CAPTURE for cash based successful purchase |
WebPay
WebPay
WebPay is Chile’s leading payment ecosystem that allows merchants to accept local debit and prepaid cards through a secure, real-time redirection flow. Transactions are processed as immediate charges, offering high security and wide local coverage for both domestic and international businesses. For more information about WebPay see WebPay PayU documentation
Create Payment Method
Endpoint
POST /v1/payment_methods.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"payment_method": {
"email": "[email protected]",
"payment_method_type": "webpay", //Must be "webpay"
"full_name": "test webpay",
"document_id": "3456789876",
"phone_number": "8524343025",
"country": "CL"
}
}//Status Code: 201 Created
{
"transaction": {
"token": "NyKmJVceyud0NswNRdslUcjz9H", //String: Unique identifier for the payment method
"created_at": "2025-11-17T14:01:45Z",
"updated_at": "2025-11-17T14:01:46Z",
"succeeded": true,
"transaction_type": "AddPaymentMethod",
"retained": false,
"state": "succeeded",
"message_key": "messages.transaction_succeeded",
"message": "Succeeded!",
"payment_method": {
"token": "01KA91Y9K594ZTN0G4F8FTNE3E",
"created_at": "2025-11-17T14:01:46.341Z",
"updated_at": "2025-11-17T14:01:46.341Z",
"email": "[email protected]",
"data": null,
"storage_state": "cached",
"test": false,
"metadata": null,
"callback_url": null,
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": "CL",
"phone_number": "8524343025",
"full_name": "test webpay",
"first_name": "test",
"last_name": "webpay",
"payment_method_type": "webpay",
"errors": [],
"document_id": "9876"
}
}
}Create Purchase Transaction
Endpoint
POST /v1/gateways/{{payu_gateway_token}}/purchase.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"transaction": {
"payment_method_token": "{{payment_method_token}}", //(AlphaNumeric, required): “hf748yh8f4h8fh4g8fh4g“
"amount": 1000, //(Numeric, required): 1000
"currency_code": "USD", //(String, required): “USD“
"callback_url": "https://example.com", //String
"redirect_url": "https://example.com" //String
}
}//Status Code: 202 Accepted
{
"transaction": {
"on_test_gateway": true,
"created_at": "2025-11-24T10:59:18Z",
"updated_at": "2025-11-24T10:59:24Z",
"succeeded": false,
"state": "pending",
"token": "VLcPOXMNTuU4xjfbODNxwa56zx",
"transaction_type": "OffsitePurchase",
"order_id": null,
"ip": null,
"description": null,
"email": null,
"merchant_name_descriptor": null,
"merchant_location_descriptor": null,
"merchant_profile_key": null,
"gateway_specific_fields": null,
"gateway_specific_response_fields": {
"payu_latam": {
"order_id": 2155960795,
"additional_info": {
"paymentNetwork": "TRANSBANK_DEBIT",
"rejectionType": "NONE",
"responseNetworkMessage": null,
"travelAgencyAuthorizationCode": null,
"cardType": null,
"transactionType": "AUTHORIZATION_AND_CAPTURE"
}
}
},
"gateway_transaction_id": "dcdfe19a-56c1-45b2-a020-ec5027536c13",
"sub_merchant_key": null,
"gateway_latency_ms": 2800,
"warning": null,
"application_id": null,
"risk_data": null,
"merchant_metadata": null,
"customer_data": null,
"order_data": null,
"workflow_key": null,
"protection_parameters": null,
"amount": 1000,
"local_amount": null,
"currency_code": "USD",
"reference": "2155960795|dcdfe19a-56c1-45b2-a020-ec5027536c13",
"setup_verification": null,
"expiration_date": "2025-11-30 22:43:40 +0530",
"stored_credential_initiator": null,
"stored_credential_reason_type": null,
"stored_credential_alternate_gateway": null,
"stored_credential_final_payment": false,
"retain_on_success": false,
"message_key": "messages.transaction_pending",
"message": "Pending",
"gateway_token": "7FSDS0X48J9BHV2KKQKSCQ228H",
"gateway_type": "payu_latam",
"response": {
"success": true,
"message": "PENDING_PAYMENT_IN_ENTITY",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-11-24T10:59:21Z",
"updated_at": "2025-11-24T10:59:24Z",
"status": null,
"checkout_url": "https://webpay3gint.transbank.cl/webpayserver/initTransaction?token_ws=01ab5eb34c303e1b51a20d0a87c22c4a6c7c14c9ead330e6ece19b51174cd7c9"
},
"shipping_address": {
"name": "test webpay",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": null,
"phone_number": null
},
"api_urls": [
{
"callback_conversations": [
"http://core.spreedly.test/v1/callbacks/1P84GC3GNQ8A7A8Q374YAF0CPG/conversations.xml"
]
}
],
"redirect_url": "http://www.test.com/response",
"checkout_url": "https://webpay3gint.transbank.cl/webpayserver/initTransaction?token_ws=01ab5eb34c303e1b51a20d0a87c22c4a6c7c14c9ead330e6ece19b51174cd7c9",
"callback_url": "https://webhook.site/975550d4-2d27-4a41-b549-c57667a24376",
"attempt_3dsecure": false,
"challenge_url": null,
"required_action": "none",
"three_ds_context": null,
"setup_response": {
"success": true,
"message": "PENDING_PAYMENT_IN_ENTITY",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-11-24T10:59:21Z",
"updated_at": "2025-11-24T10:59:24Z",
"status": null,
"checkout_url": "https://webpay3gint.transbank.cl/webpayserver/initTransaction?token_ws=01ab5eb34c303e1b51a20d0a87c22c4a6c7c14c9ead330e6ece19b51174cd7c9"
},
"payment_method": {
"token": "01KAJY2RGM8XN876B2J8G82Z08",
"created_at": "2025-11-21T10:06:42.708Z",
"updated_at": "2025-11-21T10:06:42.708Z",
"email": "[email protected]",
"data": null,
"storage_state": "cached",
"test": false,
"metadata": null,
"callback_url": null,
"full_name": "test webpay",
"first_name": "test",
"last_name": "webpay",
"payment_method_type": "webpay",
"errors": []
}
}
}Transaction Response Mapping
| Field Name | Notes |
|---|---|
token | (string): Unique identifier for the payment method |
success | (boolean): Must be true for successful purchase |
message | (string): Must be PENDING_TRANSACTION_CONFIRMATION for cash based transactions. |
Gateway Specific Response Mapping
| Field Name | Notes |
|---|---|
order_id | (Number): Unique identifier for the order confirmation |
success | (Boolean): Must be true for successful purchase |
paymentNetwork | (String): Should be WEBPAY |
transactionType | (Boolean): Must be AUTHORIZATION_AND_CAPTURE for cash based successful purchase |
PSE
PSE
PSE (Pagos Seguros en Línea) is an online bank transfer system in Colombia that allows customers to pay directly from their bank accounts through their bank’s secure authentication flow. When integrated via PayU Latam, PSE enables merchants to accept real-time bank payments without requiring cards.
PayU acts as the payment gateway, redirecting customers to the PSE banking network, handling transaction lifecycle management, and asynchronously updating transaction states (pending, succeeded, failed) through callbacks. For more information on PSE see PSE PayU documentation.
Create Gateway Method
Endpoint
POST /v1/gateways.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"gateway": {
"gateway_type": "payu_latam", //Must be "payu_latam"
"payment_country": "CO",
"merchant_id": "511896",
"account_id": "516943",
"api_login": "F4VeC0yy4nXP50N",
"api_key": "ZuirOq3U5Kq55tWINW4a408pn2",
"sandbox": true
}
}//Status Code: 201 Created
{
"gateway": {
"token": "13Y1M1HVJ79NN9151R329SCHCR", //Unique identifier for the PayU Latam gateway
"gateway_type": "payu_latam",
"description": null,
"merchant_profile_key": null,
"sub_merchant_key": null,
"payment_methods": [
"credit_card",
"efecty",
"pago_facil",
"rapi_pago",
"cobro_express",
"webpay",
"pago_efectivo",
"pagos_farmacias",
"seven_eleven",
"pix",
"oxxo",
"pse"
],
"state": "retained",
"created_at": "2025-12-19T07:10:43Z",
"updated_at": "2025-12-19T07:10:43Z",
"name": "PayU Latam",
"merchant_id": "511896",
"account_id": "516943",
"api_login": "F4VeC0yy4nXP50N",
"payment_country": "CO",
"characteristics": [
"purchase",
"authorize",
"capture",
"partial_capture",
"credit",
"void",
"verify",
"offsite_purchase",
"transaction_retry"
],
"credentials": [
{
"name": "merchant_id",
"value": "511896"
},
{
"name": "account_id",
"value": "516943"
},
{
"name": "api_login",
"value": "F4VeC0yy4nXP50N"
},
{
"name": "payment_country",
"value": "CO"
}
],
"gateway_settings": {},
"gateway_specific_fields": [
"installments_number",
"user_agent",
"cookie",
"device_session_id",
"dni_number",
"dni_type",
"merchant_buyer_id",
"tax",
"tax_return_base",
"cnpj",
"birth_date",
"description",
"buyer",
"verify_amount",
"language",
"extra_1",
"extra_2",
"extra_3",
"expiration_date",
"pse_code",
"financial_institution_code",
"user_type"
],
"redacted": false,
"sandbox": true,
"mode": "default"
}
}API Parameters
| Field Name | Description |
|---|---|
| gateway_type | Must be payu_latam |
| payment_country | CO (Colombia) |
| merchant_id | PayU merchant ID |
| account_id | PayU account ID |
| api_login | PayU API login |
| api_key | PayU API key |
| sandbox | Enable sandbox mode |
Create Payment Method
Endpoint
POST /v1/payment_methods.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"payment_method": {
"email": "[email protected]",
"payment_method_type": "pse",
"full_name": "S W User",
"document_id": "456575749821",
"country": "CO",
"zip": "12345",
"address1": "1234 test ave",
"city": "Rio",
"state": "CE",
"phone_number": "1234567890"
}
}//Status Code: 201 Created
{
"transaction": {
"token": "4J1APPJP139PFVTSZBKG3KEF3P",
"created_at": "2025-12-19T07:11:11Z",
"updated_at": "2025-12-19T07:11:11Z",
"succeeded": true,
"transaction_type": "AddPaymentMethod",
"retained": false,
"state": "succeeded",
"message_key": "messages.transaction_succeeded",
"message": "Succeeded!",
"payment_method": {
"token": "01KCTQ5FPQX4Q1S2VFGXRASM29", //Unique identifier for the PSE payment method
"created_at": "2025-12-19T07:11:11.063Z",
"updated_at": "2025-12-19T07:11:11.063Z",
"email": "[email protected]",
"data": null,
"storage_state": "cached",
"test": false,
"metadata": null,
"callback_url": null,
"address1": "1234 test ave",
"address2": null,
"city": "Rio",
"state": "CE",
"zip": "12345",
"country": "CO",
"phone_number": "1234567890",
"full_name": "S W User",
"first_name": "S W",
"last_name": "User",
"bic": null,
"payment_method_type": "pse",
"errors": [],
"document_id": "9821"
}
}
}Create Purchase Transaction
Endpoint
POST /v1/gateways/{{gateway_token}}/purchase.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"transaction": {
"payment_method_token": "{{payment_method_token}}",
"amount": 65000,
"currency_code": "COP",
"callback_url": "https://example.com",
"redirect_url": "https://example.com",
"gateway_specific_fields": {
"payu_latam": {
"pse_code": "1022", //Bank identifier in PSE network
"financial_institution_code": "1022", //same as pse_code
"user_type": "N" //N = Natural person, J = Legal entity
}
}
}
}//Status Code: 201 Created
{
"transaction": {
"on_test_gateway": true,
"created_at": "2025-12-19T07:11:52Z",
"updated_at": "2025-12-19T07:11:53Z",
"succeeded": false,
"state": "pending",
"token": "01KCTQ6RDKCP8WBP46NTK5D0T1",
"transaction_type": "OffsitePurchase",
"order_id": null,
"ip": null,
"description": null,
"email": null,
"merchant_name_descriptor": null,
"merchant_location_descriptor": null,
"merchant_profile_key": null,
"gateway_specific_fields": {
"payu_latam": {
"pse_code": "1022",
"financial_institution_code": "1022",
"user_type": "N"
}
},
"gateway_specific_response_fields": {
"payu_latam": {
"order_id": 2156149988,
"additional_info": {
"paymentNetwork": "PSE",
"rejectionType": "NONE",
"responseNetworkMessage": null,
"travelAgencyAuthorizationCode": null,
"cardType": null,
"transactionType": "AUTHORIZATION_AND_CAPTURE"
}
}
},
"gateway_transaction_id": "5e11f82a-c2d0-49f5-984c-602b1f86b00f",
"sub_merchant_key": null,
"gateway_latency_ms": 947,
"warning": null,
"application_id": null,
"risk_data": {},
"merchant_metadata": {},
"customer_data": {},
"order_data": {},
"workflow_key": null,
"protection_parameters": {},
"amount": 65000,
"local_amount": null,
"currency_code": "COP",
"reference": "2156149988|5e11f82a-c2d0-49f5-984c-602b1f86b00f",
"setup_verification": null,
"expiration_date": null,
"stored_credential_initiator": null,
"stored_credential_reason_type": null,
"stored_credential_alternate_gateway": null,
"stored_credential_final_payment": false,
"retain_on_success": false,
"message_key": "messages.transaction_pending",
"message": "Pending",
"gateway_token": "13Y1M1HVJ79NN9151R329SCHCR",
"gateway_type": "payu_latam",
"response": {
"success": true,
"message": "PENDING_TRANSACTION_CONFIRMATION",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-12-19T07:11:53Z",
"updated_at": "2025-12-19T07:11:53Z",
"status": null,
"checkout_url": "https://sandbox.api.payulatam.com/payments-api/pse-caller?enc=aHR0cHM6Ly9yZWdpc3Ryby5kZXNhcnJvbGxvLnBzZS5jb20uY28vUFNFVXNlclJlZ2lzdGVyL1N0YXJ0VHJhbnNhY3Rpb24uYXNweD9lbmM9dG5QY0pITUtsU25tUnBITThmQWJ1ekVBQjl6VjBHWU0lMmZ3RGxvelBNTmV1M004eDBsUkN0SGZqWGs4VVVRQXJ6IyNzaHViaGFtdGVzdEBwaXguY29tIyM0NTY1NzU3NDk4MjEjIw=="
},
"shipping_address": {
"name": "S W User",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": null,
"phone_number": null
},
"api_urls": [
{
"callback_conversations": [
"https://core.spreedly.com/v1/callbacks/3R33YM0S1J8AKAT713867B7KQ9/conversations.xml"
]
}
],
"redirect_url": "https://example.com",
"checkout_url": "https://sandbox.api.payulatam.com/payments-api/pse-caller?enc=aHR0cHM6Ly9yZWdpc3Ryby5kZXNhcnJvbGxvLnBzZS5jb20uY28vUFNFVXNlclJlZ2lzdGVyL1N0YXJ0VHJhbnNhY3Rpb24uYXNweD9lbmM9dG5QY0pITUtsU25tUnBITThmQWJ1ekVBQjl6VjBHWU0lMmZ3RGxvelBNTmV1M004eDBsUkN0SGZqWGs4VVVRQXJ6IyNzaHViaGFtdGVzdEBwaXguY29tIyM0NTY1NzU3NDk4MjEjIw==",
"callback_url": "https://example.com",
"attempt_3dsecure": false,
"challenge_url": null,
"required_action": "none",
"three_ds_context": null,
"setup_response": {
"success": true,
"message": "PENDING_TRANSACTION_CONFIRMATION",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-12-19T07:11:53Z",
"updated_at": "2025-12-19T07:11:53Z",
"status": null,
"checkout_url": "https://sandbox.api.payulatam.com/payments-api/pse-caller?enc=aHR0cHM6Ly9yZWdpc3Ryby5kZXNhcnJvbGxvLnBzZS5jb20uY28vUFNFVXNlclJlZ2lzdGVyL1N0YXJ0VHJhbnNhY3Rpb24uYXNweD9lbmM9dG5QY0pITUtsU25tUnBITThmQWJ1ekVBQjl6VjBHWU0lMmZ3RGxvelBNTmV1M004eDBsUkN0SGZqWGs4VVVRQXJ6IyNzaHViaGFtdGVzdEBwaXguY29tIyM0NTY1NzU3NDk4MjEjIw=="
},
"payment_method": {
"token": "01KCTQ5FPQX4Q1S2VFGXRASM29",
"created_at": "2025-12-19T07:11:11.063Z",
"updated_at": "2025-12-19T07:11:11.063Z",
"email": "[email protected]",
"data": null,
"storage_state": "cached",
"test": false,
"metadata": null,
"callback_url": null,
"full_name": "S W User",
"first_name": "S W",
"last_name": "User",
"bic": null,
"payment_method_type": "pse",
"errors": []
}
}
}URL Redirection
Redirects the customer to:
transaction.response.checkout_urlThis URL launches the PSE flow:
- Bank selection
- Bank authentication
- Payment authorization
- Redirect back to merchant
Payment Flow
- Create PSE payment method
- Call purchase endpoint
- Receive checkout_url
- Redirect customer to PSE bank page
- Customer authenticates and authorizes payment
- PayU sends final status to callback_url
- Merchant updates order based on callbackPossible Transaction States
Possible Transaction States
| State | Description |
|---|---|
| Pending | Awaiting bank confirmation |
| Succeeded | Payment completed successfully |
| Failed | Payment rejected, cancelled, or expired |
Notes
- PSE payments are asynchronous
- Initial
pendingresponse does not guarantee success - Always rely on callback/webhook notifications for final state
callback_urlis mandatory for reconciliationredirect_urlis for customer UX only
PagoEfectivo
PagoEfectivo
PagoEfectivo is a cash payment method in Peru supported by PayuLatam. The merchant creates a voucher (ticket) that customers pay online or at locations that support PagoEfectivo. The transaction remains pending until payment gateway confirms payment (or it expires). For more information on Pago Efectivo see Pago Efectivo PayU documentation.
Constraints
- Country: PE (Peru) only; Currency: PEN only
- Payment method id: PAGOEFECTIVO (PayuLatam)
- Voucher expiration: Customer can set their own expiration date that is earlier than the default of 7 days
Create Payment Method
Endpoint
POST /v1/payment_methods.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"payment_method": {
"payment_method_type": "pago_efectivo", //String, required: Must be "pago_efectivo"
"country_code": "PE",
"full_name": "Jane Doe",
"email": "[email protected]",
"document_id": "12345678"
}
}
//Status Code: 201 Created
{
"transaction": {
"token": "Ft3FP24PecDskKeKQ2JX1aBOdv4",
"created_at": "2025-11-18T13:43:35Z",
"updated_at": "2025-11-18T13:43:35Z",
"succeeded": true,
"transaction_type": "AddPaymentMethod",
"retained": true,
"state": "succeeded",
"message_key": "messages.transaction_succeeded",
"message": "Succeeded!",
"payment_method": {
"token": "VkwPFqbN34Nc5x4lr9iM2aEcD9u", //Unique identifier for the payment method
"created_at": "2025-11-18T13:43:35Z",
"updated_at": "2025-11-18T13:43:35Z",
"email": "[email protected]",
"data": null,
"storage_state": "retained",
"test": false,
"metadata": null,
"callback_url": null,
"address1": "1234 test ave",
"address2": null,
"city": "Rio",
"state": "CE",
"zip": "12345",
"country": "PE",
"phone_number": "8522847035",
"full_name": "Spreedly GWI",
"first_name": "Spreedly",
"last_name": "GWI",
"payment_method_type": "pago_efectivo",
"errors": [],
"document_id": "7737"
}
}
}Create Purchase Transaction (Voucher)
Gateway Specific Fields
Maximum date and time that the payer has to make the payment. This has to be earlier than the default value of 7 days or PagoEfectivo will ignore it and set the default value instead.
"gateway_specific_fields": {
"payu_latam": {
"expiration_date": "2021-06-12T16:07:11.586" //which needs a date value in `YYYY-MM-DDTHH:MM:SS` format.
}
}Endpoint
POST /v1/gateways/{{gateway_token}}/purchase.json{
"transaction": {
"payment_method_token": "{{pago_efectivo_payment_method_token}}",
"amount": 5000,
"currency_code": "PEN",
"callback_url": "https://example.com",
"redirect_url": "https://example.com"
}
}//Status Code: 201 Created
{
"transaction": {
"on_test_gateway": true,
"created_at": "2025-12-03T15:23:58Z",
"updated_at": "2025-12-03T15:23:59Z",
"succeeded": false,
"state": "pending",
"token": "01KBJD0AMDCSYPJ6CF0CXFY60H",
"transaction_type": "OffsitePurchase",
"order_id": null,
"ip": null,
"description": null,
"email": null,
"merchant_name_descriptor": null,
"merchant_location_descriptor": null,
"merchant_profile_key": null,
"gateway_specific_fields": {},
"gateway_specific_response_fields": {
"payu_latam": {
"order_id": 2156034368
}
},
"gateway_transaction_id": "dac85353-3cf5-4dc3-91fa-6ca4b846c2f0",
"sub_merchant_key": null,
"gateway_latency_ms": 466,
"warning": null,
"application_id": null,
"risk_data": {},
"merchant_metadata": {},
"customer_data": {},
"order_data": {},
"workflow_key": null,
"protection_parameters": {},
"amount": 5000,
"local_amount": null,
"currency_code": "PEN",
"reference": "2156034368|dac85353-3cf5-4dc3-91fa-6ca4b846c2f0",
"setup_verification": null,
"expiration_date": "2025-12-10 09:23:59 -0600",
"stored_credential_initiator": null,
"stored_credential_reason_type": null,
"stored_credential_alternate_gateway": null,
"stored_credential_final_payment": false,
"retain_on_success": false,
"message_key": "messages.transaction_pending",
"message": "Pending",
"gateway_token": "5H0WTD4GM4875VS7GWAKYJ8VFM",
"gateway_type": "payu_latam",
"response": {
"success": true,
"message": "PENDING_TRANSACTION_CONFIRMATION",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": "100",
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-12-03T15:23:59Z",
"updated_at": "2025-12-03T15:23:59Z",
"status": null,
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2156034368Ydac853533cf54dcY1a4bcb4d65a6c7b"
},
"shipping_address": {
"name": "amit e",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": null,
"phone_number": null
},
"api_urls": [
{
"callback_conversations": [
"https://alma-core.ngrok.io/v1/callbacks/7656N0N4Z1877T9S72PX8WF60Q/conversations.xml"
]
}
],
"redirect_url": "https://example.com",
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2156034368Ydac853533cf54dcY1a4bcb4d65a6c7b",
"callback_url": "https://example.com",
"attempt_3dsecure": false,
"challenge_url": null,
"required_action": "none",
"three_ds_context": null,
"setup_response": {
"success": true,
"message": "PENDING_TRANSACTION_CONFIRMATION",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": "100",
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-12-03T15:23:59Z",
"updated_at": "2025-12-03T15:23:59Z",
"status": null,
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2156034368Ydac853533cf54dcY1a4bcb4d65a6c7b"
},
"payment_method": {
"token": "LYfX5SvwK2PH3D8xmF6WtItgNHe",
"created_at": "2025-12-03T15:23:58Z",
"updated_at": "2025-12-03T15:23:58Z",
"email": "[email protected]",
"data": null,
"storage_state": "cached",
"test": false,
"metadata": null,
"callback_url": null,
"full_name": "Spreedly GWI",
"first_name": "Spreedly",
"last_name": "GWI",
"payment_method_type": "pago_efectivo",
"errors": []
}
}
}API Field Reference
| Field Name | Type/Example | Notes |
|---|---|---|
| paymentMethod | "PAGOEFECTIVO" | |
| notifyURL | https://merchant.example.com/notifications/payu | Receive async status updates. This will be a Spreedly custom URL |
Status Mapping
| Status | Meaning | Action |
|---|---|---|
| PENDING | Voucher generated; awaiting cash payment | Display voucher; await webhook |
| PAID | Customer paid at PagoEfectivo; funds confirmed by gateway | Fulfill order; allow refunds |
| EXPIRED/REJECTED | Payment window expired or cancelled/failed | Release reservation; show new voucher option |
OXXO
OXXO
Oxxo is a cash payment method in Mexico supported by PayuLatam. The merchant creates a voucher (ticket) that customers pay at Oxxo convenience stores. The transaction remains pending until payment gateway confirms payment (or it expires). For more information on Oxxo see Oxxo PayU documentation.
Constraints
- Country: MX (Mexico) only; Currency: MXN only
- Payment method id: OTHERS_CASH_MX
- Voucher expiration: Customer can set their own expiration date that is earlier than the default of 7 days for PayU
Create Payment Method
Endpoint
POST /v1/payment_methods.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"payment_method": {
"payment_method_type": "oxxo", //Must be "oxxo"
"country_code": "MX", //Must be "MX" or “mx'
"full_name": "Jane Doe",
"email": "[email protected]"
}
}//Status Code: 201 Created
{
"transaction": {
"token": "Ft3FP24PecDskKeKQ2JX1aBOdv4",
"created_at": "2025-11-18T13:43:35Z",
"updated_at": "2025-11-18T13:43:35Z",
"succeeded": true,
"transaction_type": "AddPaymentMethod",
"retained": true,
"state": "succeeded",
"message_key": "messages.transaction_succeeded",
"message": "Succeeded!",
"payment_method": {
"token": "VkwPFqbN34Nc5x4lr9iM2aEcD9u", //Unique identifier for the payment method
"created_at": "2025-11-18T13:43:35Z",
"updated_at": "2025-11-18T13:43:35Z",
"email": "[email protected]",
"data": null,
"storage_state": "retained",
"test": false,
"metadata": null,
"callback_url": null,
"address1": "1234 test ave",
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": "MX",
"phone_number": "8522847035",
"full_name": "Jane Doe",
"first_name": "Jane",
"last_name": "Doe",
"payment_method_type": "oxxo",
"errors": []
}
}
}Create Purchase Transaction (Voucher)
Gateway Specific Fields
Maximum date and time that the payer has to make the payment. This has to be earlier than the default value of 7 days or PayuLatam will ignore it and set the default value instead.
"gateway_specific_fields": {
"payu_latam": {
"expiration_date": "2021-06-12T16:07:11.586" //which needs a date value in `YYYY-MM-DDTHH:MM:SS` format.
}
}Endpoint
POST /v1/gateways/{{gateway_token}}/purchase.json{
"transaction": {
"payment_method_token": "{{oxxo_payment_method_token}}",
"amount": 5000,
"currency_code": "MXN",
"callback_url": "https://example.com", //where Spreedly will posts status updates
"redirect_url": "https://example.com" //where Spreedly will redirect the user
}
}//Status Code: 202 Accepted
{
"transaction": {
"on_test_gateway": true,
"created_at": "2025-12-05T22:36:15Z",
"updated_at": "2025-12-05T22:36:16Z",
"succeeded": false,
"state": "pending",
"token": "01KBRAH94EQQBCN0W5QK749R7D",
"transaction_type": "OffsitePurchase",
"order_id": null,
"ip": null,
"description": null,
"email": null,
"merchant_name_descriptor": null,
"merchant_location_descriptor": null,
"merchant_profile_key": null,
"gateway_specific_fields": {},
"gateway_specific_response_fields": {
"payu_latam": {
"order_id": 2156053984,
"additional_info": {
"paymentNetwork": "DIESTEL",
"rejectionType": "NONE",
"responseNetworkMessage": null,
"travelAgencyAuthorizationCode": null,
"cardType": null,
"transactionType": "AUTHORIZATION_AND_CAPTURE"
}
}
},
"gateway_transaction_id": "d376ebba-0e94-4b7c-9bbd-f156e96cc3e7",
"sub_merchant_key": null,
"gateway_latency_ms": 545,
"warning": null,
"application_id": null,
"risk_data": {},
"merchant_metadata": {},
"customer_data": {},
"order_data": {},
"workflow_key": null,
"protection_parameters": {},
"amount": 100,
"local_amount": null,
"currency_code": "MXN",
"reference": "2156053984|d376ebba-0e94-4b7c-9bbd-f156e96cc3e7",
"setup_verification": null,
"expiration_date": "2025-12-12 22:59:59 -0600",
"stored_credential_initiator": null,
"stored_credential_reason_type": null,
"stored_credential_alternate_gateway": null,
"stored_credential_final_payment": false,
"retain_on_success": false,
"message_key": "messages.transaction_pending",
"message": "Pending",
"gateway_token": "4C8N9XK73Y8RT8P8DGAW2EQ9A4",
"gateway_type": "payu_latam",
"response": {
"success": true,
"message": "PENDING_TRANSACTION_CONFIRMATION",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-12-05T22:36:16Z",
"updated_at": "2025-12-05T22:36:16Z",
"status": null,
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2156053984Yd376ebba0e944b7Ya389694f6a5ef9b"
},
"shipping_address": {
"name": "Jane Doe",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": null,
"phone_number": null
},
"api_urls": [
{
"callback_conversations": [
"http://core.spreedly.test/v1/callbacks/0F7V0EKHB59G586ZKQXM894TR8/conversations.xml"
]
}
],
"redirect_url": "https://example.com",
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2156053984Yd376ebba0e944b7Ya389694f6a5ef9b",
"callback_url": "https://example.com",
"attempt_3dsecure": false,
"challenge_url": null,
"required_action": "none",
"three_ds_context": null,
"setup_response": {
"success": true,
"message": "PENDING_TRANSACTION_CONFIRMATION",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-12-05T22:36:16Z",
"updated_at": "2025-12-05T22:36:16Z",
"status": null,
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2156053984Yd376ebba0e944b7Ya389694f6a5ef9b"
},
"payment_method": {
"token": "4xDbfAULGPgYHoP198FQUJe84f9",
"created_at": "2025-12-05T22:36:15Z",
"updated_at": "2025-12-05T22:36:15Z",
"email": "[email protected]",
"data": null,
"storage_state": "cached",
"test": false,
"metadata": null,
"callback_url": null,
"full_name": "Jane Doe",
"first_name": "Jane",
"last_name": "Doe",
"payment_method_type": "oxxo",
"errors": []
}
}
}Webhook Notifications (notification_url)
The gateways posts asynchronous updates to the Spreedly notification_url. After, we have update the transaction we will post updates to the callback_url.
SevenEleven
SevenEleven
SevenEleven is a cash payment method in Mexico supported by PayuLatam. The merchant creates a voucher (ticket) that customers pay any Seven Eleven. The transaction remains pending until payment gateway confirms payment (or it expires). For more information on Seven Eleven see Seven Eleven PayU documentation.
Constraints
- Country: MX (Mexico) only; Currency: MXN only
- Payment method id: SEVEN_ELEVEN
- Voucher expiration: Customer can set their own expiration date that is earlier than the default of 7 days
Create Payment Method
Endpoint
POST /v1/payment_methods.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"payment_method": {
"payment_method_type": "seven_eleven", //string, required: Must be "seven_eleven"
"country_code": "MX", //(string, required): Must be "MX" or “mx'
"full_name": "Jane Doe",
"email": "[email protected]"
}
}
//Status Code: 201 Created
{
"transaction": {
"token": "Ft3FP24PecDskKeKQ2JX1aBOdv4",
"created_at": "2025-11-18T13:43:35Z",
"updated_at": "2025-11-18T13:43:35Z",
"succeeded": true,
"transaction_type": "AddPaymentMethod",
"retained": true,
"state": "succeeded",
"message_key": "messages.transaction_succeeded",
"message": "Succeeded!",
"payment_method": {
"token": "VkwPFqbN34Nc5x4lr9iM2aEcD9u", //(string): Unique identifier for the payment method
"created_at": "2025-11-18T13:43:35Z",
"updated_at": "2025-11-18T13:43:35Z",
"email": "[email protected]",
"data": null,
"storage_state": "retained",
"test": false,
"metadata": null,
"callback_url": null,
"address1": "1234 test ave",
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": "MX",
"phone_number": "8522847035",
"full_name": "Jane Doe",
"first_name": "Jane",
"last_name": "Doe",
"payment_method_type": "seven_eleven",
"errors": []
}
}
}Create Purchase Transaction (Voucher)
Gateway Specific Fields
Maximum date and time that the payer has to make the payment. This has to be earlier than the default value of 7 days or PayuLatam will ignore it and set the default value instead.
"gateway_specific_fields": {
"payu_latam": {
"expiration_date": "2021-06-12T16:07:11.586" //which needs a date value in `YYYY-MM-DDTHH:MM:SS` format.
}
}Endpoint
POST /v1/gateways/{{gateway_token}}/purchase.json{
"transaction": {
"payment_method_token": "{{seven_eleven_payment_method_token}}",
"amount": 5000,
"currency_code": "MXN",
"callback_url": "https://example.com", //where Spreedly will posts status updates
"redirect_url": "https://example.com" //where Spreedly will redirects the user
}
}//Status Code: 202 Accepted
{
"transaction": {
"on_test_gateway": true,
"created_at": "2025-12-05T22:36:15Z",
"updated_at": "2025-12-05T22:36:16Z",
"succeeded": false,
"state": "pending",
"token": "01KBRAH94EQQBCN0W5QK749R7D",
"transaction_type": "OffsitePurchase",
"order_id": null,
"ip": null,
"description": null,
"email": null,
"merchant_name_descriptor": null,
"merchant_location_descriptor": null,
"merchant_profile_key": null,
"gateway_specific_fields": {},
"gateway_specific_response_fields": {
"payu_latam": {
"order_id": 2156053984,
"additional_info": {
"paymentNetwork": "DIESTEL",
"rejectionType": "NONE",
"responseNetworkMessage": null,
"travelAgencyAuthorizationCode": null,
"cardType": null,
"transactionType": "AUTHORIZATION_AND_CAPTURE"
}
}
},
"gateway_transaction_id": "d376ebba-0e94-4b7c-9bbd-f156e96cc3e7",
"sub_merchant_key": null,
"gateway_latency_ms": 545,
"warning": null,
"application_id": null,
"risk_data": {},
"merchant_metadata": {},
"customer_data": {},
"order_data": {},
"workflow_key": null,
"protection_parameters": {},
"amount": 100,
"local_amount": null,
"currency_code": "MXN",
"reference": "2156053984|d376ebba-0e94-4b7c-9bbd-f156e96cc3e7",
"setup_verification": null,
"expiration_date": "2025-12-12 22:59:59 -0600",
"stored_credential_initiator": null,
"stored_credential_reason_type": null,
"stored_credential_alternate_gateway": null,
"stored_credential_final_payment": false,
"retain_on_success": false,
"message_key": "messages.transaction_pending",
"message": "Pending",
"gateway_token": "4C8N9XK73Y8RT8P8DGAW2EQ9A4",
"gateway_type": "payu_latam",
"response": {
"success": true,
"message": "PENDING_TRANSACTION_CONFIRMATION",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-12-05T22:36:16Z",
"updated_at": "2025-12-05T22:36:16Z",
"status": null,
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2156053984Yd376ebba0e944b7Ya389694f6a5ef9b"
},
"shipping_address": {
"name": "Jane Doe",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": null,
"phone_number": null
},
"api_urls": [
{
"callback_conversations": [
"http://core.spreedly.test/v1/callbacks/0F7V0EKHB59G586ZKQXM894TR8/conversations.xml"
]
}
],
"redirect_url": "https://example.com",
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2156053984Yd376ebba0e944b7Ya389694f6a5ef9b",
"callback_url": "https://example.com",
"attempt_3dsecure": false,
"challenge_url": null,
"required_action": "none",
"three_ds_context": null,
"setup_response": {
"success": true,
"message": "PENDING_TRANSACTION_CONFIRMATION",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-12-05T22:36:16Z",
"updated_at": "2025-12-05T22:36:16Z",
"status": null,
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2156053984Yd376ebba0e944b7Ya389694f6a5ef9b"
},
"payment_method": {
"token": "4xDbfAULGPgYHoP198FQUJe84f9",
"created_at": "2025-12-05T22:36:15Z",
"updated_at": "2025-12-05T22:36:15Z",
"email": "[email protected]",
"data": null,
"storage_state": "cached",
"test": false,
"metadata": null,
"callback_url": null,
"full_name": "Jane Doe",
"first_name": "Jane",
"last_name": "Doe",
"payment_method_type": "seven_eleven",
"errors": []
}
}
}Webhook Notifications (notification_url)
The gateways posts asynchronous updates to the Spreedly notification_url. After, we have update the transaction we will post updates to the callback_url.
PagosFarmacias
PagosFarmacias
PagosFarmacias is a cash payment method in Mexico supported by PayuLatam. The merchant creates a voucher (ticket) that customers pay at Farmacias del Ahorro or Farmacias Benavides. The transaction remains pending until payment gateway confirms payment (or it expires). For more information on Pago Farmacias see Pago Farmacias PayU documentation.
Constraints
- Country: MX (Mexico) only; Currency: MXN only
- Payment method id: OTHERS_CASH_MX
- Voucher expiration: Customer can set their own expiration date that is earlier than the default of 7 days
Create Payment Method
Endpoint
POST /v1/payment_methods.jsonContent-Type: application/json
Authorization: Bearer {access_token}{
"payment_method": {
"payment_method_type": "pagos_farmacias", //Must be "pagos_farmacias"
"country_code": "MX", //Must be "MX" or “mx'
"full_name": "Jane Doe",
"email": "[email protected]"
}
}
//Status Code: 201 Created
{
"transaction": {
"token": "Ft3FP24PecDskKeKQ2JX1aBOdv4",
"created_at": "2025-11-18T13:43:35Z",
"updated_at": "2025-11-18T13:43:35Z",
"succeeded": true,
"transaction_type": "AddPaymentMethod",
"retained": true,
"state": "succeeded",
"message_key": "messages.transaction_succeeded",
"message": "Succeeded!",
"payment_method": {
"token": "VkwPFqbN34Nc5x4lr9iM2aEcD9u", //Unique identifier for the payment method
"created_at": "2025-11-18T13:43:35Z",
"updated_at": "2025-11-18T13:43:35Z",
"email": "[email protected]",
"data": null,
"storage_state": "retained",
"test": false,
"metadata": null,
"callback_url": null,
"address1": "1234 test ave",
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": "MX",
"phone_number": "8522847035",
"full_name": "Jane Doe",
"first_name": "Jane",
"last_name": "Doe",
"payment_method_type": "pagos_farmacias",
"errors": []
}
}
}Create Purchase Transaction (Voucher)
Gateway Specific Fields
Maximum date and time that the payer has to make the payment. This has to be earlier than the default value of 7 days or PayuLatam will ignore it and set the default value instead.
"gateway_specific_fields": {
"payu_latam": {
"expiration_date": "2021-06-12T16:07:11.586" //which needs a date value in `YYYY-MM-DDTHH:MM:SS` format.
}
}Endpoint
POST /v1/gateways/{{gateway_token}}/purchase.json{
"transaction": {
"payment_method_token": "{{pagos_farmacias_payment_method_token}}",
"amount": 5000,
"currency_code": "MXN",
"callback_url": "https://example.com", //where Spreedly will posts status updates
"redirect_url": "https://example.com" //where Spreedly will redirect the user
}
}//Status Code: 202 Accepted
{
"transaction": {
"on_test_gateway": true,
"created_at": "2025-12-05T22:36:15Z",
"updated_at": "2025-12-05T22:36:16Z",
"succeeded": false,
"state": "pending",
"token": "01KBRAH94EQQBCN0W5QK749R7D",
"transaction_type": "OffsitePurchase",
"order_id": null,
"ip": null,
"description": null,
"email": null,
"merchant_name_descriptor": null,
"merchant_location_descriptor": null,
"merchant_profile_key": null,
"gateway_specific_fields": {},
"gateway_specific_response_fields": {
"payu_latam": {
"order_id": 2156053984,
"additional_info": {
"paymentNetwork": "DIESTEL",
"rejectionType": "NONE",
"responseNetworkMessage": null,
"travelAgencyAuthorizationCode": null,
"cardType": null,
"transactionType": "AUTHORIZATION_AND_CAPTURE"
}
}
},
"gateway_transaction_id": "d376ebba-0e94-4b7c-9bbd-f156e96cc3e7",
"sub_merchant_key": null,
"gateway_latency_ms": 545,
"warning": null,
"application_id": null,
"risk_data": {},
"merchant_metadata": {},
"customer_data": {},
"order_data": {},
"workflow_key": null,
"protection_parameters": {},
"amount": 100,
"local_amount": null,
"currency_code": "MXN",
"reference": "2156053984|d376ebba-0e94-4b7c-9bbd-f156e96cc3e7",
"setup_verification": null,
"expiration_date": "2025-12-12 22:59:59 -0600",
"stored_credential_initiator": null,
"stored_credential_reason_type": null,
"stored_credential_alternate_gateway": null,
"stored_credential_final_payment": false,
"retain_on_success": false,
"message_key": "messages.transaction_pending",
"message": "Pending",
"gateway_token": "4C8N9XK73Y8RT8P8DGAW2EQ9A4",
"gateway_type": "payu_latam",
"response": {
"success": true,
"message": "PENDING_TRANSACTION_CONFIRMATION",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-12-05T22:36:16Z",
"updated_at": "2025-12-05T22:36:16Z",
"status": null,
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2156053984Yd376ebba0e944b7Ya389694f6a5ef9b"
},
"shipping_address": {
"name": "Jane Doe",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": null,
"phone_number": null
},
"api_urls": [
{
"callback_conversations": [
"http://core.spreedly.test/v1/callbacks/0F7V0EKHB59G586ZKQXM894TR8/conversations.xml"
]
}
],
"redirect_url": "https://example.com",
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2156053984Yd376ebba0e944b7Ya389694f6a5ef9b",
"callback_url": "https://example.com",
"attempt_3dsecure": false,
"challenge_url": null,
"required_action": "none",
"three_ds_context": null,
"setup_response": {
"success": true,
"message": "PENDING_TRANSACTION_CONFIRMATION",
"avs_code": null,
"avs_message": null,
"cvv_code": null,
"cvv_message": null,
"pending": true,
"result_unknown": false,
"error_code": null,
"error_detail": null,
"cancelled": false,
"fraud_review": null,
"created_at": "2025-12-05T22:36:16Z",
"updated_at": "2025-12-05T22:36:16Z",
"status": null,
"checkout_url": "https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/cld/app/v2?vid=2156053984Yd376ebba0e944b7Ya389694f6a5ef9b"
},
"payment_method": {
"token": "4xDbfAULGPgYHoP198FQUJe84f9",
"created_at": "2025-12-05T22:36:15Z",
"updated_at": "2025-12-05T22:36:15Z",
"email": "[email protected]",
"data": null,
"storage_state": "cached",
"test": false,
"metadata": null,
"callback_url": null,
"full_name": "Jane Doe",
"first_name": "Jane",
"last_name": "Doe",
"payment_method_type": "pagos_farmacias",
"errors": []
}
}
}Webhook Notifications (notification_url)
The gateways posts asynchronous updates to the Spreedly notification_url. After, we have update the transaction we will post updates to the callback_url.
Updated 4 days ago