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
lng Alphanumeric 3 The language for the payment gateway.
See supported languages.		 No
merchantId Number 12 The unique ID number assigned to your shop in PayU’s system. You can find this number in the account creation email. Yes
accountId Number 6 The ID associated with the user account in each country. It determines the available payment methods for the corresponding country. Yes
algorithmSignature Alphanumeric 255 The encryption algorithm used for the digital signature (signature field). Available options: MD5, SHA, or SHA256. No
signature Alphanumeric 255 A digital signature for the transaction. Refer to Signature for Payment Form for instructions. Yes
sourceUrl Alphanumeric 255 The source URL where the merchant’s payment button is located. No
responseUrl Alphanumeric 255 The URL for the response page. No
confirmationUrl Alphanumeric 255 The URL for the confirmation page. No
expirationDate Alphanumeric 19 The expiration date for Cash payments in the format YYYY-MM-DD HH:mm:ss. Must be within the allowed range for cash payments (15 days for Argentina, 7 days for others). -
paymentMethods Alphanumeric 255 The list of payment methods enabled for the transaction.
This list must be separated by comma and without blanks, for example: VISA,MASTERCARD.
You can include installments using hyphens, for example: VISA-1-3,MASTERCARD-3-5-9.
See the available Payment Methods for your country in the column paymentMethod parameter.		 No
selectedPaymentMethod Alphanumeric 255 A preselected payment method when the user accesses the payment link. No
paymentMethodsDescription Alphanumeric 255 A description of the accepted payment methods and Bins for the transaction. No
iin Alphanumeric 2048 A list of Bins admitted during the payment process, separated by commas. Only merchants validating signatures can use this parameter. No
pseBanks Alphanumeric 255 A list of bank codes enabled for payments through PSE. No
partnerId Alphanumeric 255 An optional field to specify the partner’s name (e.g., ZOOZ). No
template Alphanumeric 255 The template to be used for the payment page. No
extra1 Alphanumeric 255 Additional field to send extra information about the purchase. No
extra2 Alphanumeric 255 Additional field to send extra information about the purchase. No
extra3 Alphanumeric 255 Additional field to send extra information about the purchase. No
extra4 Alphanumeric 255 Additional field to send extra information about the purchase. No
displayShippingInformation Number 1 Set to 1 to request shipping information, or 0 to disable it. No
additionalDeliveryDays Number 5 Additional days for order delivery, which will appear in the API query response as result.payload.transactions.extraParameters.ADDITIONAL_DELIVERY_DAYS. No
displayBuyerComments Number 1 Set to 1 to enable buyer comments, or 0 to disable it. This appears in the API response as result.payload.transactions.extraParameters.DISPLAY_BUYER_COMMENTS. No
buyerCommentsLabel Alphanumeric 255 The label for buyer comments, appearing in the API response as result.payload.transactions.extraParameters.BUYER_COMMENTS_LABEL. No
isCashOnDeliveryApply Number 1 Set to 1 to enable cash on delivery for the transaction, or 0 to disable it. No
test Number 1 Indicates whether the transaction is in test mode (1) or production mode (0). No
description Alphanumeric 255 A description of the sale. Yes
referenceCode Alphanumeric 255 A unique reference for the sale or order. It must be unique for each transaction sent to the system, typically used for tracking requests. Yes
amount Number 10 The total amount for the transaction, which can include two decimal digits. E.g., 10000.00 or 10000. Yes
tax Number 10.2 The VAT value for the transaction. In Colombia, if no VAT is provided, the system applies 19% automatically. If VAT is exempt, set to 0. Yes
taxReturnBase Number 10.2 The base value used to calculate the VAT. If the product is VAT exempt, set to 0. Yes
administrativeFee Number 10.2 The administrative fee for the transaction. No
taxAdministrativeFee Number 10.2 The tax applied to the administrative fee. No
taxAdministrativeFeeReturnBase Number 10.2 The base value for calculating the tax of the administrative fee. No
discount Number 10.2 The discount applied to the sale. No
currency Alphanumeric 3 The currency used for the payment. In colombia, reconciliations are done in Colombian pesos at the representative rate of the day.
See accepted currencies.		 Yes
airline Alphanumeric 4 The airline code for airline transactions. No
additionalValue Number 10.2 Any additional value added to the sale. No
payerFullName Alphanumeric 50 The payer’s full name, used to fill out the credit card form. Yes
payerEmail Alphanumeric 255 The email address of the payer. Yes
payerOfficePhone Alphanumeric Max. 20 The workplace phone number of the payer. No
payerPhone Alphanumeric Max. 20 The phone number of the payer. Yes
payerMobilePhone Alphanumeric Max. 20 The mobile phone number of the payer. No
payerDocumentType Alphanumeric 25 The type of identification document used by the payer. Examples: CC, DNI. NIT, Passport. Yes
payerDocument Alphanumeric 25 The payer’s identification number, used to fill out the credit card form. Yes
billingCountry Alphanumeric 2 The ISO country code for the billing address. No
payerState Alphanumeric N/A The payer’s billing state in ISO 3166 code (e.g., SP for São Paulo, AR-C for Buenos Aires). No
billingCity Alphanumeric 50 The city associated with the billing address. No
billingAddress Alphanumeric 255 The billing address for the transaction. No
billingAddress2 Alphanumeric 255 The secondary address line for the payer’s billing address. No
billingAddress3 Alphanumeric 255 The tertiary address line for the payer’s billing address. No
zipCode Alphanumeric 20 The postal code for the billing or shipping address. No
buyerFullName Alphanumeric 150 The full name of the buyer. Yes
buyerEmail Alphanumeric 255 The buyer’s email address, used for transaction notifications. Yes
buyerDocumentType Alphanumeric 25 The type of identification document used by the buyer. Examples: Examples: CC, DNI. NIT, Passport. Yes
buyerDocument Alphanumeric 25 The buyer’s identification number. Yes
officeTelephone Alphanumeric Max. 20 The buyer’s daytime phone number. No
telephone Alphanumeric Max. 20 The buyer’s residence phone number. Yes
mobilePhone Alphanumeric Max. 20 The buyer’s cell phone number, used to fill out the credit card form and as the contact phone. No
shippingCountry Alphanumeric 2 The ISO country code for the shipping address.
*Mandatory if the shop ships the product.
See processing countries.		 Yes*
shippingState Alphanumeric N/A The buyer’s shipping state in ISO 3166 code (e.g., SP for São Paulo, AR-C for Buenos Aires). No
shippingCity Alphanumeric 50 The city to which the merchant will deliver the product or service.
*Mandatory if the shop ships the product.		 Yes*
shippingAddress Alphanumeric 255 The address to which the merchant will deliver the product or service.
*Mandatory if the shop ships the product.		 Yes*
shippingAddress2 Alphanumeric 255 The secondary address line for the buyer’s shipping address. No
shippingAddress3 Alphanumeric 255 The tertiary address line for the buyer’s shipping address. No
payerShippingPostalCode Alphanumeric N/A The buyer’s shipping postal code. 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 January 30, 2025: Documentation Updates (e6f7f9ba4)