Payment Form

In this section, you’ll learn how to send transaction data to the PayU payment gateway. This document provides the information needed to create an HTML form with the required transaction details and submit it to our system using the HTTP POST method.

Considerations

  • Ensure you have the correct merchantId, accountId, and apiKey.
  • Use a unique payment reference for each transaction.
  • Avoid including spaces in parameter values.
  • Limit decimal values to two places.
  • Exclude special characters from the referenceCode parameter.

Parameters

You can include the following parameters in the payment form.

Parameters in the payment form
Field Type Size Description Mandatory
merchantId Number 12 ID number of your shop in PayU’s system, you will find this number in the account creation e-mail. Yes
referenceCode Alphanumeric 255 Reference of the sale or order. It must be unique for each transaction that is sent to the system. Usually, this is a way to identify the requests sent to the payment gateway. Yes
accountId Number 6 ID of the user account for each country associated with the shop. This variable is used to display the available payment methods for this country. Yes
description Alphanumeric 255 Sale’s description. Yes
currency Alphanumeric 3 The respective currency in which the payment is made. The reconciliation process is performed in Colombian pesos at the representative rate of the day.
See accepted currencies.		 Yes
amount Number 10 Total amount of the transaction. It can contain two decimal digits. Example 10000.00 or 10000. Yes
tax Number 10.2 Value of the VAT of the transaction.
In Colombia, if no VAT is sent, the system applies 19% automatically. It can contain two decimal digits, for example 19000.00.
If the product or service is VAT exempt, assign 0 to this variable.		 Yes
discount Number 10.2 Discount value applied to the sale. No
taxReturnBase Number 10.2 Base value to calculate the VAT.
If the product or service is VAT exempt, assign 0 to this variable.		 Yes
additionalValue Number 10.2 Additional value of the sale. No
signature Alphanumeric 255 Digital signature created for each transaction. Refer to Signature for Payment form to learn how to generate it. Yes
algorithmSignature Alphanumeric 255 Encryption algorithm of the digital signature (signature field). The three available algorithms are: MD5, SHA and SHA256. No
test Number 1 Indicates whether the transaction is in test or production mode. Set 1 for test and 0 for production. No
lng Alphanumeric 3 Language in which the payment gateway is wished to be displayed.
See supported languages.		 No
extra1 Alphanumeric 255 Additional field to send information about the purchase. No
extra2 Alphanumeric 255 Additional field to send information about the purchase. No
extra3 Alphanumeric 255 Additional field to send information about the purchase. No
template Alphanumeric 255 Template for the payment page. No
responseUrl Alphanumeric 255 The URL of the response page. No
confirmationUrl Alphanumeric 255 The URL of the confirmation page. No
sourceUrl Alphanumeric 255 Source URL of the merchant transactions. This is where the payment button is located. No
airline Alphanumeric 4 Airline code. No
billingAddress Alphanumeric 255 The correspondence address. No
shippingAddress Alphanumeric 255 The delivery address of the merchandise.
* Mandatory if your shop ships the product.		 Yes*
billingCity Alphanumeric 50 City associated with the billing address. No
shippingCity Alphanumeric 50 The delivery City of the merchandise
* Mandatory if your shop ships the product.		 Yes*
zipCode Alphanumeric 20 Postal code. No
billingCountry Alphanumeric 2 The ISO country code associated with the billing address. No
shippingCountry Alphanumeric 2 The delivery ISO country code for the merchandise.
* Mandatory if your shop ships the product.
See processing countries.		 Yes*
buyerEmail Alphanumeric 255 Field that contains the buyer’s e-mail to notify the result of the transaction by e-mail. It is recommended to validate if this field has been provided in the form. Yes
telephone Alphanumeric Max. 20 The buyer’s residence phone. Yes
officeTelephone Alphanumeric Max. 20 The buyer’s daytime phone. No
mobilePhone Alphanumeric Max. 20 The buyer’s cell phone number. This value will be taken to fill out the credit card form and will be the contact telephone number. No
buyerFullName Alphanumeric 150 The buyer’s full name. Yes
paymentMethods Alphanumeric 255 List of payment methods enabled in the payment process.
This list must be separated by comma and without blanks. For example: VISA,MASTERCARD.
You can include installments for the payment methods adding them using hyphens. Example: VISA-1-3,MASTERCARD-3-5-9.
See the available Payment Methods for your country in the column paymentMethod parameter.		 No
administrativeFee Number 10.2 Amount of the administrative fee. No
taxAdministrativeFee Number 10.2 Amount of tax of the administrative fee. No
taxAdministrativeFeeReturnBase Number 10.2 Base value to calculate the tax of the administrative fee. No
payerEmail Alphanumeric 255 The payer’s e-mail. Yes
payerPhone Alphanumeric Max. 20 The payer’s phone number. Yes
payerOfficePhone Alphanumeric Max. 20 The payer’s workplace phone number. No
payerMobilePhone Alphanumeric Max. 20 The payer’s mobile phone number. No
expirationDate Alphanumeric 19 Expiration date of the transactions for Cash payments. Format: YYYY-MM-DD HH:mm:ss.
This value must be lower than the default number of days for the cash payment (15 days for Argentina and 7 days for the other countries).		 -
payerFullName Alphanumeric 50 The payer’s name. This value will be taken to fill out the credit card form. Yes
payerDocument Alphanumeric 25 The buyer’s identification number. This value will be taken to fill out the credit card form. Yes
payerDocumentType Alphanumeric 25 The buyer’s identification number. This value will be taken to fill out the credit card form. Yes
iin Alphanumeric 2048 List of Bins admitted during the payment process (separated by comma).
This parameter can only be used by merchants that validate signature.		 No
paymentMethodsDescription Alphanumeric 255 Description of the payment methods and Bins admitted during the payment process. No
pseBanks Alphanumeric 255 List of bank codes enabled in the payment process through PSE.
This list must be separated by comma and without blanks.		 No

Parameters Considerations

  • The tax parameter represents VAT, applicable in certain countries, while taxReturnBase is the base amount to calculate the VAT. If your product is tax-exempt, set both variables to 0 (tax=0, taxReturnBase=0).
  • When some products are taxed, while others are not, calculate and set values as shown in the table below to ensure accurate submission to the payment platform.

VAT Calculation Example:

Product taxReturnBase tax Amount
A 84.033 15.966 (19%) 100.000
B 181.818 18.181 (10%) 200.000
C 0 0 (0%) 150.000
Total 268.851 34.147 450.000
  • For businesses in Colombia registered under the Régimen Común, if tax is not provided, PayU automatically calculates it at 19%. For businesses under the Régimen Simplificado, if tax is not specified, PayU assigns a value of zero (0).

HTML Fields Example

The following is an example of the mandatory fields for a payment form in HTML format, pointing the request to the sandbox environment (test mode).

 <form method="post" action="https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/">
  <input name="merchantId"      type="hidden"  value="508029"   >
  <input name="accountId"       type="hidden"  value="512321" >
  <input name="description"     type="hidden"  value="Test PAYU"  >
  <input name="referenceCode"   type="hidden"  value="TestPayU" >
  <input name="amount"          type="hidden"  value="20000"   >
  <input name="tax"             type="hidden"  value="3193"  >
  <input name="taxReturnBase"   type="hidden"  value="16806" >
  <input name="currency"        type="hidden"  value="COP" >
  <input name="signature"       type="hidden"  value="7ee7cf808ce6a39b17481c54f2c57acc"  >
  <input name="test"            type="hidden"  value="0" >
  <input name="buyerEmail"      type="hidden"  value="test@test.com" >
  <input name="responseUrl"     type="hidden"  value="http://www.test.com/response" >
  <input name="confirmationUrl" type="hidden"  value="http://www.test.com/confirmation" >
  <input name="Submit"          type="submit"  value="Send" >
</form>

If your shop ships the products, you need to include the following values:

  <input name="shippingAddress"    type="hidden"  value="calle 93 n 47 - 65"   >
  <input name="shippingCity"       type="hidden"  value="Bogotá" >
  <input name="shippingCountry"    type="hidden"  value="CO"  >

The URL configured in action depends on the environment:

Test: https://sandbox.checkout.payulatam.com/ppp-web-gateway-payu/
Production: https://checkout.payulatam.com/ppp-web-gateway-payu/

Payment Form Example

This dynamic payment form example is designed for testing in our sandbox environment. It offers a glimpse into the potential fields and features you can incorporate into your own payment forms. Below is an overview of its key features:

  • Transaction Signature Generation: The form calculates a signature string using the PayU LATAM API key, merchant ID, and various user inputs such as payment method and bank information. This signature is hashed using a specified algorithm (MD5, SHA, or SHA256) to ensure secure transactions. For more details, refer to Signature for Payment Form

  • Dynamic Form Population: Based on the selected country and account, the form populates various fields such as document types, billing information (e.g., city, state, zip code), and payer information. This allows the form to adjust for region-specific data requirements (e.g., CPF for Brazil or CUIT for Argentina).

  • Visibility Management: Several functions are included to dynamically show or hide fields based on the type of account selected. This is particularly useful for handling specific cases like PSE banks in Colombia or additional fields for airlines and travel agencies.

  • Shipping Information Handling: The form allows the user to either use the billing information as the shipping address or specify separate shipping details. If the user doesn’t select an alternate shipping option, the billing information is used by default.

  • Event Listeners and Form Submission: The page can use event listeners to update form fields when certain input values (e.g., account ID) change and ensures the form submission process respects user input, with fallback options in place (e.g., using billing info if no shipping option is selected).

PayU LATAM WebCheckout

Payment Form Example

1. Select a value from the accountId field according to the country where you want to run the tests.

2. Click the button:

3. Click the button: ⓘ :

Remember that you can edit or add additional fields as needed. If you modify or enter values in the paymentMethods, iin, or pseBanks fields after generating a signature, it will be necessary to generate it again.

4. Click the button:





Signature for Payment Form

The signature is a method to validate payments made through the platform and ensuring its authenticity. It consists of a string encrypted using MD5, SHA1, or SHA256. The string is created as follows:

"ApiKey~merchantId~referenceCode~amount~currency"

For example, with the following data:

merchantId: 508029
ApiKey: 4Vj8eK4rloUd272L48hsrarnUA
referenceCode: TestPayU
amount: 20000
currency: COP
accountId: 512326
buyerEmail: test@test.com

The signature is:

"4Vj8eK4rloUd272L48hsrarnUA~508029~TestPayU~20000~COP"

Encrypted using MD5:

"7ee7cf808ce6a39b17481c54f2c57acc"

Encrypted using SHA1:

"fa890d3f94e12b5cdb62e8771453b99b78e7ccdc"

Encrypted using SHA256:

"af3899a22336b79db46006491d15813158826f944599bf3bf601e2327f898022"

Generate a Signature

This calculator lets you generate the signature using any of the available encryption methods.

Algorithm:  

 ( ~ ~ ~ ~ )


Result: 
Last modified November 28, 2024: Documentation Updates (d002e8d69)