PayU Latam Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
PayU Latam
Services that work with Spreedly:
  • PayU Latam
Supported operations:
Purchase, Authorize, Capture, Refund, Void, Verify
Supported payment types:
Credit Card
Regions:
Latin America

Authentication and Security

Specific names for credentials:
Account, Api Login, Merchant, Payment Country, Api Key

Onboarding Merchants in:

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 Latam 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>RRUbEn0WYmlLHfwMc6iNquhCuxL</token>
  <gateway_type>payu_latam</gateway_type>
  <name>PayU Latam</name>
  <description 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_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_3dsecure_purchase type="boolean">false</supports_3dsecure_purchase>
    <supports_3dsecure_authorize type="boolean">false</supports_3dsecure_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_disburse type="boolean">false</supports_disburse>
  </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_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>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_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2018-07-09T12:57:21Z</created_at>
  <updated_at type="dateTime">2018-07-09T12:57:21Z</updated_at>
</gateway>


env = Spreedly::Environment.new('C7cRfNJGODKh4Iu5Ox3PToKjniY', '4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ', base_url: 'https://core.spreedly.com')
env.add_gateway(:payu_latam, merchant_id: "Your merchant id", account_id: "Your account id", api_login: "Your API login", api_key: "Your API key", payment_country: 'Your two-letter country code')


#<Spreedly::Gateway:0x007fd6b3b45370
@token="3UQSDU9MgRTgn9UzMVbzBa1XpXj",
@created_at="2018-01-05T19:12:58Z",
@updated_at="2018-01-05T19:12:58Z",
@gateway_type="payu_latam",
@state="retained",
@name="PayU Latam",
@credentials={"merchant_id"=>"Your merchant id", "account_id"=>"Your account id", "api_login"=>"Your API login", "payment_country"=>"Your two-letter country code"}>

Gateway Specific Fields

Spreedly supports the following gateway specific fields when transacting with PayU Latam:

  • dni_number
  • dni_type
  • cnpj
  • birth_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_number
  • user_agent
  • cookie
  • device_session_id ( required for all transactions – see instructions below )
  • buyer ( see Buyer section below )
  • verify_amount ( can be sent in verify API calls to override default minimum values. )
  • language (overrides the language used in emails and error messages. The default language is sent as en, but es or pt may be sent.)

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.

  • name
  • email
  • dni_number
  • dni_type
  • cnpj ( 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>
      <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@example.com</email>
        <dni_number>5415668464654</dni_number>
        <dni_type>TI</dni_type>
        <cnpj>12347890</cnpj>
      </buyer>
      <verify_amount>5100</verify_amount>
    </payu_latam>
  </gateway_specific_fields>
</transaction>'


<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2018-07-09T12:57:21Z</created_at>
  <updated_at type="dateTime">2018-07-09T12:57:21Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>TRgnhrYVT9CVOnymBmz0jqLPZ0N</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"/>
  <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>
      <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@example.com</email>
        <dni_number>5415668464654</dni_number>
        <dni_type>TI</dni_type>
        <cnpj>12347890</cnpj>
      </buyer>
      <verify_amount>5100</verify_amount>
    </payu_latam>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>54</gateway_transaction_id>
  <gateway_latency_ms type="integer">23</gateway_latency_ms>
  <amount type="integer">100</amount>
  <currency_code>USD</currency_code>
  <retain_on_success type="boolean">false</retain_on_success>
  <payment_method_added type="boolean">false</payment_method_added>
  <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></error_code>
    <error_detail nil="true"/>
    <cancelled type="boolean">false</cancelled>
    <fraud_review nil="true"/>
    <created_at type="dateTime">2018-07-09T12:57:21Z</created_at>
    <updated_at type="dateTime">2018-07-09T12:57:21Z</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">2018-06-29T21:12:11Z</updated_at>
    <email>joey@example.com</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>
    <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 nil="true"/>
    <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"/>
    <payment_method_type>credit_card</payment_method_type>
    <errors>
    </errors>
    <verification_value></verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <fingerprint>e3cef43464fc832f6e04f187df25af497994</fingerprint>
  </payment_method>
</transaction>

Gateway specific response fields

A response from PayU Latam gateway may contain an order_id field 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>
     </payu_latam>
  </gateway_specific_response_fields>
</transaction>