Maintenance Work Notice!

We will carry out maintenance work on this documentation on Tuesday, 15.06.2021 between 3 pm and 4 pm CEST. Thank you for your understanding.

Page tree

Search

Skip to end of metadata
Go to start of metadata


About PayU LatAm

General information about payment methods via PayU LatAm


Logo

Info

Within the extremely heterogeneous e-commerce market of Latin America success depends on offering the requested payment methods. The integration of PayU gives the merchant access to 74 payment methods from Mexico to Argentina. Besides all major online transfers as well as credit and debit cards PayU also offers payments with modern e-wallets and popular cash-in-payments.

TypeMixed payment methods EN

Card Scheme

MasterCard

VISA

AMEX

DINERS

Hipercard

Elo

NARANJA

SHOPPING

CABAL

ARGENCARD

CENCOSUD


Process flow charts


PayU LatAm process flow



Process flow PayU LatAm via form interface payssl.aspx



Process flow PayU LatAm via server-to-server interface direct.aspx


Paygate interface

Definitions

Data formats

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

ISODateTime (YYYY-MM-DDThh:mm:ss)


Abbreviations

Abbreviation

Description

Comment

CND

condition


M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional


Notice: Please note that the names of parameters can be returned in upper or lower case.


Payment with PayU LatAm via Paygate form interface

To make a payment with PayU LatAm in Latin America, go to the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

Merchant transaction number, which must be unique

RefNr

ans..30

M

Unique reference number. Format must be mutually agreed beforehand with Computop!

Amount

n..10

M

Amount in the smallest currency unit (e.g. USD Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three character DIN / ISO 4217. Presently only ARS, BRL, CLP, COP, MXN, PEN and USD permitted.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

URLSuccess

ans..256

M

Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

URLFailure

ans..256

M

Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

Response

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

URLNotify

ans..256

M

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop

ReqID

ans..32

O

To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

Discount

n..10

O

Discount in the smallest currency unit

Language

a2

O

Language:

EN – English (default)
ES – Spanish
PT – Portuguese

CountryCode

a2

M

Country code of that country where the transaction should be executed - 2 characters according to ISO 3166: AR, BR, CO, CL, MX, PA, PE

TaxCode

n..4

O

VAT rate, e.g. 1900 for 19%

Default is 0 (no VAT)

NetAmount

n..10

OC

Total amount of the order without VAT and delivery costs in the smallest currency unit. NetAmount may only be used if also TaxCode is submitted.

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Contact data

Name

ans..128

O

Name of the customer

CreditCardHolder

ans..50

O

Name of the credit card holder

AddrStreet

ans..255

O

Street name in the invoicing address

AddrCity

ans..50

O

Name of town/city in the billing address

AddrZip

ans..20

O

Postcode in the invoicing address

AddrCountryCode

a2

O

Country code for the invoicing address, 2 characters according to ISO 3166

eMail

ans..128

M

Email address of the purchaser. Only characters a-zA-Z0-9.-_@ are allowed.

Phone

ans..40

O

Purchaser’s telephone number

WorkPhone

ans..40

O

Phone number of the customer at working place

MobileNo

ans..20

O

Mobile phone number of the customer

TaxNumber

ans..20

O

Identification number of the customer. This value will be used in the credit card form.

bdeMail

ans..128

O

Email address of the purchaser

bdPhone

ans..40

O

Phone number of the payor

bdWorkPhone

ans..40

O

Phone number of the payor at working place

bdMobileNo

ans..20

O

Mobile phone number of the payor

sdStreet

ans..255

O

Street in the delivery address

sdCity

ans..50

O

Town/city in the delivery address

sdCountryCode

a2

O

Country code for the delivery address, 2 characters according to ISO 3166

Parameters for payments with PayU LatAm in Latin America


The following table describes the result parameters that the Paygate transmits to your URLSuccess or URLFailure. If you have specified the Response=encrypt parameter, the following parameters are forwarded Blowfish encrypted to your system:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK, AUTHORIZE_REQUEST or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

CodeExt

n..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Return parameters for URLSuccess and URLFailure with PayU LatAm in Latin America


The following table gives the results parameters which the Paygate transfers to URLNotify:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

CodeExt

n..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop

AmountAuth

n..10

M

Actually authorized amount in the smallest currency unit.

For installment payments the charges are added automatically to the initial amount.

Currency

a3

M

Currency, three digits DIN / ISO 4217

TransactionID

ans..25

O

RefNr from PayU system

PayType

ans..25

O

Name of used payment method

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Return parameters for URLNotify with PayU LatAm in Latin America



Credit card payment with PayU LatAm via Paygate form interface

In order to execute an SSL credit card payment in Latin America with PayU LatAm via a Paygate form, visit the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..30

M

Unique reference number which appears on your printed card account or in the EPA-file (Electronic Payment Advice). Format must be mutually agreed beforehand with Computop!

Amount

n..10

M

Amount in the smallest currency unit (e.g. USD Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three character DIN / ISO 4217; only ARS, BRL, CLP, COP, MXN, PEN and USD permitted

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

URLSuccess

ans..256

M

Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

URLFailure

ans..256

M

Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

Response

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

URLNotify

ans..256

M

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop

Capture

ans..6

O

Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696).

ReqID

ans..32

O

To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

InstallmentNumber

n..2

O

Number of months of the payment by instalments (1-12), default=1

Language

a2

O

Language:

EN – English (default)
ES – Spanish
PT – Portuguese

CountryCode

a2

O

Country code of that country where the transaction should be executed - 2 characters according to ISO 3166: AR, BR, CO, CL, MX, PA, PE

TermsAndConditions

a..3

OC

yes or no.

Terms and Conditions from PayU, which the customer has to accept.

It is only mandatory if a PayU-account which is registered in Brazil is connected with a bank within another country.

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Contact data

Name

ans..128

OC

Name of the customer. If not specified, the CreditCardHolder must be submitted

CreditCardHolder

ans..128

OC

Name of the credit card holder. If not specified, the Name must be submitted.

Mail

ans..128

O

Email address of the customer

AddrStreet

ans..255

O

Customer’s street name

AddrCity

ans..50

O

Town/city of the customer

AddrState

ans..40

O

Federal State of the customer

AddrCountryCode

a2

O

Country code of the customer, 2 characters according to ISO 3166.

eMail

ans..128

O

Email address of the purchaser

AddrZIP

ans..20

O

Postcode of the customer

Phone

ans..40

O

Customer’s phone number

CustomerID

ans..16

O

Customer ID or customer number

CustomerClassification

a..8

O

Customer classification (business/private) default=private

TaxNumber

an11/an14

O

Identification number of the customer

In Brazil there are two kinds of tax numbers:

CPF for persons and CNPJ for companies. The discrimination is made by the parameter CustomerClassification.

CPF: 11 characters without separators, e.g. 12312312312

CNPJ: 14 characters without separators, e.g. 12345678000123

bdeMail

ans..128

O

Email address in the billing address

bdCustomerID

ans..16

O

Customer number in the billing address

bdDateOfBirth

ans10

O

Date of birth in the format YYYY-MM-DD

bdPhone

ans..40

O

Phone number in the billing address

bdTaxNumber

n11

O

Identification number of the payor. This value is used in the credit card form.

CPF: 11 characters without separators, e.g. 12312312312

bdStreet

ans..255

O

Street name in the invoicing address

bdAddrAddition

ans..50

O

Address addition in the billing address

bdCity

ans..50

O

Name of town/city in the billing address

bdZip

ans..20

O

Postcode in the invoicing address

bdState

ans..40

O

Federal State in the billing address

bdCountryCode

a2

O

Country code for the invoicing address, 2 characters according to ISO 3166

sdStreet

ans..255

O

Street in the delivery address

sdAddrAddition

ans..50

O

Address addition in the delivery address

sdCity

ans..50

O

Town/city in the delivery address

sdState

ans..40

O

Federal State in the delivery address

sdCountryCode

a2

O

Country code for the delivery address, 2 characters according to ISO 3166

sdZip

ans..20

O

Postcode in the delivery address

sdPhone

ans..40

O

Phone number in the delivery address

Parameters for credit card payments with PayU LatAm in Latin America


To adapt the layout of the SSL-page to your shop you can use the following unencrypted parameters to configure colours, fonts and images.

Parameter

Format

CND

Description

Template

ans..20

M

Name of XSLT-file with your own layout for the pay form. If you want to use the redesigned and downwards compatible Computop template, please transfer the template name “ct_compatible”. If you want to use the responsive Computop template for mobile devices, please transfer the template name “ct_responsive”.

Background

ans..256

M

Background ambiance of form:

URL for a background image

- HTML-colour value for background colour as HEX value or

- HTML-colour name

BGColor

ans..7

M

Form background colour:

- HTML-colour value for background colour as HEX value or

- HTML-colour name

BGImage

ans..256

M

Form background image:

URL for a background image

Please note that this value supersedes “BGColor”.

FColor

ans..6

M

Text colour:

- HTML-colour value as HEX value or

- HTML-colour name

FFace

a..10

M

HTML-name for the font

FSize

n2

M

Number for font size

Language

a2

(enum)

M

Language code: <de> German, <al> Albanian, <at> Austrian, <cz/cs> Czech, <dk> Danish, <en> English, <fi> Finish, <fr> French, <gr> Greek, <hu> Hungarian, <it> Italian, <jp> Japanese,  <nl> Dutch, <no> Norwegian, <pl> Polish,
<pt> Portuguese, <ro> Romanian, <ru> Russian, <sp> Spanish, <se> Swedish, <sk> Slovakian, <sl> Slovenian, <tr> Turkey, <zh> Simplified Chinese.

No details means the language is German.

CCSelect

a..10

M

Determines preselected card type in the form: VISA, MasterCard, AMEX, DINERS, Elo, Hipercard, NARANJA, SHOPPING, CABAL, ARGENCARD, CENCOSUD

URLBack

ans..256

M

URL for "Cancel" button

Center

n1

M

By default the form is centered vertically and horizontally. The value <1> centres the form at the top.

tWidth

ans..4

M

Width of table for input of the credit card data as percent- (50%) or pixel values (320).

tHeight

ans..4

M

Height of table for input of the credit card data as percent- (70%) or pixel values (480).

Layout parameters for Paygate forms for credit card payments with PayU LatAm


The following table describes the result parameters that the Paygate transmits to your URLSuccess, URLFailure or URLNotify. If you have specified the Response=encrypt parameter, the following parameters are forwarded Blowfish encrypted to your system:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Additionally only for URLNotify: AUTHORIZE_REQUEST

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

CodeExt

ans..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

RefNr

ans..30

O

Merchant’s unique reference number

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

PCNr

n..16

O

Pseudo Card Number: Random number generated by Paygate which represents a genuine credit card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. You can use the PCN like a genuine card number for authorisation, capture and credits.

CCBrand

a..22

O

In combination with PCNr: Description of the credit card brand like VISA, MasterCard, AMEX, DINERS, Elo, Hipercard, NARANJA, SHOPPING, CABAL, ARGENCARD, CENCOSUD

CCExpiry

n6

O

In combination with PCNr: Expiry date of the credit card in the format YYYYMM.

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Return parameters for URLSuccess, URLFailure and URLNotify with PayU LatAm



Credit card payment via Server-to-Server connection

In order to execute an SSL credit card payment with PayU LatAm in Latin America via a server-to-server connection, call the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

M

Merchant’s unique reference number

Amount

n..10

M

Amount in the smallest currency unit (e.g. USD Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three character DIN / ISO 4217; only ARS, BRL, CLO, COP, MXN, PEN and USD permitted

Capture

ans..6

OC

Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696).

Only in Brazil but not with brand Hipercard.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop

URLNotify

ans..256

O

Complete URL, which calls up Paygate in order to notify the shop about a status change of a credit. The URL can also be stored permanently at Computop. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

CCNr

n..19

M

Credit card number at least 12-digit, numerical without spaces. You can optionally transmit also a pseudo card number (PCN)

CCCVC

n..4

O

Card verification number: The last 3 digits on the signature strip of the credit card. 4 characters in the case of AMEX.

CCExpiry

n6

M

Credit card expiry date (YYYYMM), e.g. 201607

CCBrand

a..22

M

Card type: VISA, MasterCard, AMEX, DINERS, Elo, Hipercard, NARANJA, SHOPPING, CABAL, ARGENCARD, CENCOSUD

Please note the spelling!

CreditCardHolder

ans..60

O

Name of the card holder

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

ReqID

ans..32

O

To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

InstallmentNumber

n..2

O

Number of months of the payment by instalments (1-12), default=1

Language

a2

O

Language:

EN – English (default)
ES – Spanish
PT – Portuguese

CountryCode

a2

M

Country code of that country where the transaction should be executed - 2 characters according to ISO 3166: AR, BR, CO, CL, MX, PA, PE

TermsAndCoditions

a..3

O

yes or no.

Terms and Conditions from PayU, which the customer has to accept.

It is only mandatory if a PayU-account which is registered in Brazil is connected with a bank within another country.

Contact data

Name

ans..128

OC

Name of the customer. If not specified, the CreditCardHolder must be submitted

CreditCardHolder

ans..128

OC

Name of the credit card holder. If not specified, the Name must be submitted.

Mail

ans..128

O

Email address of the customer

AddrStreet

ans..255

O

Customer’s street name

AddrCity

ans..50

O

Town/city of the customer

AddrState

ans..40

O

Federal State of the customer

AddrCountryCode

a2

O

Country code of the customer, 2 characters according to ISO 3166.

AddrZIP

ans..20

O

Postcode of the customer

Phone

ans..40

O

Customer’s phone number

eMail

ans..128

O

Email address of the customer

CustomerID

ans..16

O

Customer ID or customer number

CustomerClassification

a..8

O

Customer classification (business/private) default=private

TaxNumber

an11/an14

O

Identification number of the customer

In Brazil there are two kinds of tax numbers:

CPF for persons and CNPJ for companies. The discrimination is made by the parameter CustomerClassification.

CPF: 11 characters without separators, e.g. 12312312312

CNPJ: 14 characters without separators, e.g. 12345678000123

bdeMail

ans..128

O

Email address in the billing address

bdCustomerID

ans..16

O

Customer number in the billing address

bdDateOfBirth

ans10

O

Date of birth in the format YYYY-MM-DD

bdPhone

ans..40

O

Phone number in the billing address

bdTaxNumber

n11

O

Identification number of the payor. This value is used in the credit card form.

CPF: 11 characters without separators, e.g. 12312312312

bdStreet

ans..255

O

Street name in the invoicing address

bdAddrAddition

ans..50

O

Address addition in the billing address

bdCity

ans..50

O

Name of town/city in the billing address

bdZip

ans..20

O

Postcode in the invoicing address

bdState

ans..40

O

Federal State in the billing address

bdCountryCode

a2

O

Country code for the invoicing address, 2 characters according to ISO 3166

sdStreet

ans..255

O

Street in the delivery address

sdAddrAddition

ans..50

O

Address addition in the delivery address

sdCity

ans..50

O

Town/city in the delivery address

sdState

ans..40

O

Federal State in the delivery address

sdCountryCode

a2

O

Country code for the delivery address, 2 characters according to ISO 3166

sdZip

ans..20

O

Postcode in the delivery address

sdPhone

ans..40

O

Phone number in the delivery address

Parameters for credit card payments with PayU LatAm via socket connection


The following table gives the parameters with which the Paygate responds:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment Important for future reference

XID

an32

M

ID assigned by Paygate for the payment transaction

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK, AUTHORIZE-REQUEST or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

CodeExt

ans..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

RefNr

ans..30

O

Merchant’s unique reference number

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

PCNr

n..16

O

Pseudo Card Number; random number generated by Paygate which represents a genuine credit card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. You can use the PCN like a genuine card number for authorisation, capture and credits.

CCBrand

a..22

O

In combination with PCNr: Name of credit card brand, e.g. Visa, MasterCard, Amex, DINERS etc.

CCExpiry

n6

O

In combination with PCNr: Expiry date of the credit card in the format YYYYMM.

Results parameters for socket connection with PayU LatAm



Cash payment with PayU in Latin America

In order to execute a CashPayment payment with PayU LatAm in Latin America via a server-to-server connection, call the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

M

Merchant’s unique reference number

Amount

n..10

M

Amount in the smallest currency unit (e.g. USD Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three character DIN / ISO 4217; only ARS, BRL, CLO, COP, MXN, PEN and USD permitted

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop

ReqID

ans..32

O

To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

URLNotify

ans..256

O

Complete URL, which calls up Paygate in order to notify the shop about a status change of a credit. The URL can also be stored permanently at Computop. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

IPAddr

ans..15

O

IP address. If you transfer the IP address, Paygate can determine in which country and in which town your customer has connected with the Internet (see also IPZone). Format: 123.456.789.012

Language

a2

O

Language:

EN – English (default)
ES – Spanish
PT – Portuguese

CountryCode

a2

M

Country code of that country where the transaction should be executed - 2 characters according to ISO 3166: AR, BR, CO, CL, MX, PA, PE

TermsAndCoditions

a..3

OC

yes or no.

Terms and Conditions from PayU, which the customer has to accept.

It is mandatory if a PayU-account which is registered in Brazil is connected with a bank within another country.

PayType

a..25

O

Name of used payment method

Argentina:

PAGOFACIL, RAPIPAGO, COBRO_EXPRESS, BAPRO, RIPSA

Brazil:

BOLETO_BANCARIO

Colombia:

BALOTO, EFECTY, PSE

Mexico:

OXXO, BANCOMER, IXE, SCOTIABANK, SANTANDER, SEVEN_ELEVEN

Peru:

BCP

Contact data

Name

ans..128

OC

Mandatory In Brazil: Name of the customer

Mail

ans..128

OC

Mandatory In Brazil: Email address of the customer

AddrStreet

ans..255

OC

Mandatory In Brazil: Customer’s street name

AddrCity

ans..50

OC

Mandatory In Brazil: Town/city of the customer

AddrState

ans..40

OC

Mandatory In Brazil: Federal State of the customer

AddrZIP

ans..20

OC

Mandatory In Brazil: Postcode of the customer

AddrCountryCode

a2

O

Country code of the customer, 2 characters according to ISO 3166.

Phone

ans..40

O

Customer’s phone number

CustomerID

ans..16

O

Customer ID or customer number

CustomerClassification

a..8

O

Customer classification (business/private) default=private

TaxNumber

ans..20

OC

Mandatory In Brazil: Identification number of the customer

In Brazil there are two kinds of tax numbers:

CPF for persons and CNPJ for companies. The discrimination is made by the parameter CustomerClassification.

CPF: 11 characters without separators, e.g. 12312312312

CNPJ: 14 characters without separators, e.g. 12345678000123

bdeMail

ans..128

O

Email address in the billing address

bdCustomer­­ID

ans..16

O

Customer number in the billing address

bdDateOfBirth

ans10

O

Date of birth in the format YYYY-MM-DD

bdPhone

ans..40

O

Phone number in the billing address

bdTaxNumber

n11

O

Identification number of the payor. This value is used in the credit card form.

CPF: 11 characters without separators, e.g. 12312312312

bdStreet

ans..255

O

Street name in the invoicing address

bdAddrAddition

ans..50

O

Address addition in the billing address

bdCity

ans..50

O

Name of town/city in the billing address

bdZip

ans..20

O

Postcode in the invoicing address

bdState

ans..40

O

Federal State in the billing address

bdCountryCode

a2

O

Country code for the invoicing address, 2 characters according to ISO 3166

sdStreet

ans..255

O

Street in the delivery address

sdAddrAddition

ans..50

O

Address addition in the delivery address

sdCity

ans..50

O

Town/city in the delivery address

sdState

ans..40

O

Federal State in the delivery address

sdCountryCode

a2

O

Country code for the delivery address, 2 characters according to ISO 3166

sdZip

ans..20

O

Postcode in the delivery address

sdPhone

ans..40

O

Phone number in the delivery address

Parameters for payments with PayU CashPayment via socket connection


The following table gives the parameters with which the Paygate responds:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

ID assigned by Paygate for the payment transaction

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK, AUTHORIZE-REQUEST or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

CodeExt

ans..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

RefNr

ans..30

O

Reference number is returned, if it was previously submitted

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

PaymentSlipLink

ans..256

M

Complete URL (URL-encoded) for the page which presents the payment form

Results parameters for socket connection with PayU CashPayment


The following table describes the parameters which the Paygate returns to URLNotify:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

ID assigned by Paygate for the payment transaction

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

CodeExt

ans..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

RefNr

ans..30

O

Reference number is returned, if it was previously submitted

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Amount

n..10

M

Amount in the smallest currency unit (e.g. USD Cent)

Currency

a3

M

Currency, three character DIN / ISO 4217; only ARS, BRL, CLO, COP, MXN, PEN and USD permitted

Response parameters to URLNotify for payments with PayU CashPayment



Capture of a credit card payment with PayU LatAm

Captures are possible via a Server-to-Server connection. To carry out a Capture for a credit card payment with PayU LatAm via a Server-to-Server connection please use the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment to be captured

TransID

ans..64

M

ID assigned by Merchant for the payment process to be captured

Amount

n..10

M

Amount in the smallest currency unit (e.g. USD Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a..3

M

Currency, three character DIN / ISO 4217; only ARS, BRL, CLO, COP, MXN, PEN and USD permitted

RefNr

ans..30

O

Unique reference number which appears on your printed card account or in the EPA-file (Electronic Payment Advice). Format must be mutually agreed beforehand with Computop!

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Parameters for captures of PayU LatAm via socket connections


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment to be captured, e.g. for referencing in batch files

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ans..30

O

Merchant’s unique reference number

CodeExt

n..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

Response parameters for captures of PayU LatAm via socket connections



Credit with reference

Credits (refunds) are possible via a Server-to-Server connection. For a Credit with reference to a capture the amount of the Credit is limited to the amount of the previous capture.

To carry out a credit, please use the following URL:


The following tables describe the transfer parameters and return values which are exchanged via the socket connection.

Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment to be credited

TransID

ans..64

M

ID assigned by Merchant for the payment process to be credited

Amount

n..10

M

Amount in the smallest currency unit (e.g. USD Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a..3

M

Currency, three character DIN / ISO 4217; only ARS, BRL, CLO, COP, MXN, PEN and USD permitted

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

OrderDesc

ans..768

O

Description of refunded goods, unit prices, merchant’s comment etc.

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Parameters for credit payments with PayU LatAm via socket connection


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

CodeExt

n..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

Response parameters for credit payments with PayU LatAm via socket connection



Batch processing via the interface

Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.

This section describes the parameters which must be transferred within the data set (Record) for executing of payments / credits for PayU LatAm in Latin America and which information can be found within the response file about the payment status.

Following table gives an overview of all batch versions that are possible for a specific action and their specialities:

Action

Version

Description

Capture

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

Credit

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2x.

with RefNr (valid for all versions other than 1.0)

Description of the possible batch versions


The structure for a PayU LatAm payment within a Batch file to be submitted is the following:

HEAD,<MerchantID>,<Date>,<Version>

CC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

CC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

FOOT,<CountRecords>,<SumAmount>


Example for Master MID Funktion:

HEAD,[Master]MerchantID,Date,2.x
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount


The following table describes the individual fields and values used within the data set (record) in the batch file:

Parameter

Format

CND

Description

Type

a..11

M

HEAD for Header, FOOT for Footer, CC for Credit card payment with PayU

Action

a..20

M

The parameter Action defines the type of transaction:

Capture
Credit

Amount

n..10

M

Amount in the smallest currency unit (e.g. USD Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three character DIN / ISO 4217; only ARS, BRL, CLO, COP, MXN, PEN and USD permitted

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

PayID

an32

M

ID for this transaction given by Paygate

Description of fields within the record for Batch files

 

 

The record area within the response file for Batch transactions looks the following way:

HEAD,<MerchantID>,<Date>,<Version>

CC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

CC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

FOOT,<CountRecords>,<SumAmount>

 

The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):

Parameter

Format

CND

Description

Action

a..20

M

The parameter Action defines the type of transaction:

Capture
Credit

PayID

an32

M

ID for this transaction given by Paygate

Status

a..50

M

OK or FAILED

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

Description of result parameters within the record for Batch files


About PayU LatAm

General information about payment methods via PayU LatAm


Logo

Info

Within the extremely heterogeneous e-commerce market of Latin America success depends on offering the requested payment methods. The integration of PayU gives the merchant access to 74 payment methods from Mexico to Argentina. Besides all major online transfers as well as credit and debit cards PayU also offers payments with modern e-wallets and popular cash-in-payments.

TypeMixed payment methods EN

Card Scheme

MasterCard

VISA

AMEX

DINERS

Hipercard

Elo

NARANJA

SHOPPING

CABAL

ARGENCARD

CENCOSUD


Process flow charts


PayU LatAm process flow



Process flow PayU LatAm via form interface payssl.aspx



Process flow PayU LatAm via server-to-server interface direct.aspx


Paygate interface

Definitions

Data formats

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

ISODateTime (YYYY-MM-DDThh:mm:ss)


Abbreviations

Abbreviation

Description

Comment

CND

condition


M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional


Notice: Please note that the names of parameters can be returned in upper or lower case.


Payment with PayU LatAm via Paygate form interface

To make a payment with PayU LatAm in Latin America, go to the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

Merchant transaction number, which must be unique

RefNr

ans..30

M

Unique reference number. Format must be mutually agreed beforehand with Computop!

Amount

n..10

M

Amount in the smallest currency unit (e.g. USD Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three character DIN / ISO 4217. Presently only ARS, BRL, CLP, COP, MXN, PEN and USD permitted.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

URLSuccess

ans..256

M

Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

URLFailure

ans..256

M

Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

Response

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

URLNotify

ans..256

M

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop

ReqID

ans..32

O

To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

Discount

n..10

O

Discount in the smallest currency unit

Language

a2

O

Language:

EN – English (default)
ES – Spanish
PT – Portuguese

CountryCode

a2

M

Country code of that country where the transaction should be executed - 2 characters according to ISO 3166: AR, BR, CO, CL, MX, PA, PE

TaxCode

n..4

O

VAT rate, e.g. 1900 for 19%

Default is 0 (no VAT)

NetAmount

n..10

OC

Total amount of the order without VAT and delivery costs in the smallest currency unit. NetAmount may only be used if also TaxCode is submitted.

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Contact data

Name

ans..128

O

Name of the customer

CreditCardHolder

ans..50

O

Name of the credit card holder

AddrStreet

ans..255

O

Street name in the invoicing address

AddrCity

ans..50

O

Name of town/city in the billing address

AddrZip

ans..20

O

Postcode in the invoicing address

AddrCountryCode

a2

O

Country code for the invoicing address, 2 characters according to ISO 3166

eMail

ans..128

M

Email address of the purchaser. Only characters a-zA-Z0-9.-_@ are allowed.

Phone

ans..40

O

Purchaser’s telephone number

WorkPhone

ans..40

O

Phone number of the customer at working place

MobileNo

ans..20

O

Mobile phone number of the customer

TaxNumber

ans..20

O

Identification number of the customer. This value will be used in the credit card form.

bdeMail

ans..128

O

Email address of the purchaser

bdPhone

ans..40

O

Phone number of the payor

bdWorkPhone

ans..40

O

Phone number of the payor at working place

bdMobileNo

ans..20

O

Mobile phone number of the payor

sdStreet

ans..255

O

Street in the delivery address

sdCity

ans..50

O

Town/city in the delivery address

sdCountryCode

a2

O

Country code for the delivery address, 2 characters according to ISO 3166

Parameters for payments with PayU LatAm in Latin America


The following table describes the result parameters that the Paygate transmits to your URLSuccess or URLFailure. If you have specified the Response=encrypt parameter, the following parameters are forwarded Blowfish encrypted to your system:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK, AUTHORIZE_REQUEST or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

CodeExt

n..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Return parameters for URLSuccess and URLFailure with PayU LatAm in Latin America


The following table gives the results parameters which the Paygate transfers to URLNotify:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

CodeExt

n..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop

AmountAuth

n..10

M

Actually authorized amount in the smallest currency unit.

For installment payments the charges are added automatically to the initial amount.

Currency

a3

M

Currency, three digits DIN / ISO 4217

TransactionID

ans..25

O

RefNr from PayU system

PayType

ans..25

O

Name of used payment method

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Return parameters for URLNotify with PayU LatAm in Latin America



Credit card payment with PayU LatAm via Paygate form interface

In order to execute an SSL credit card payment in Latin America with PayU LatAm via a Paygate form, visit the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..30

M

Unique reference number which appears on your printed card account or in the EPA-file (Electronic Payment Advice). Format must be mutually agreed beforehand with Computop!

Amount

n..10

M

Amount in the smallest currency unit (e.g. USD Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three character DIN / ISO 4217; only ARS, BRL, CLP, COP, MXN, PEN and USD permitted

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

URLSuccess

ans..256

M

Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

URLFailure

ans..256

M

Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443 This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

Response

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

URLNotify

ans..256

M

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop

Capture

ans..6

O

Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696).

ReqID

ans..32

O

To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

InstallmentNumber

n..2

O

Number of months of the payment by instalments (1-12), default=1

Language

a2

O

Language:

EN – English (default)
ES – Spanish
PT – Portuguese

CountryCode

a2

O

Country code of that country where the transaction should be executed - 2 characters according to ISO 3166: AR, BR, CO, CL, MX, PA, PE

TermsAndConditions

a..3

OC

yes or no.

Terms and Conditions from PayU, which the customer has to accept.

It is only mandatory if a PayU-account which is registered in Brazil is connected with a bank within another country.

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Contact data

Name

ans..128

OC

Name of the customer. If not specified, the CreditCardHolder must be submitted

CreditCardHolder

ans..128

OC

Name of the credit card holder. If not specified, the Name must be submitted.

Mail

ans..128

O

Email address of the customer

AddrStreet

ans..255

O

Customer’s street name

AddrCity

ans..50

O

Town/city of the customer

AddrState

ans..40

O

Federal State of the customer

AddrCountryCode

a2

O

Country code of the customer, 2 characters according to ISO 3166.

eMail

ans..128

O

Email address of the purchaser

AddrZIP

ans..20

O

Postcode of the customer

Phone

ans..40

O

Customer’s phone number

CustomerID

ans..16

O

Customer ID or customer number

CustomerClassification

a..8

O

Customer classification (business/private) default=private

TaxNumber

an11/an14

O

Identification number of the customer

In Brazil there are two kinds of tax numbers:

CPF for persons and CNPJ for companies. The discrimination is made by the parameter CustomerClassification.

CPF: 11 characters without separators, e.g. 12312312312

CNPJ: 14 characters without separators, e.g. 12345678000123

bdeMail

ans..128

O

Email address in the billing address

bdCustomerID

ans..16

O

Customer number in the billing address

bdDateOfBirth

ans10

O

Date of birth in the format YYYY-MM-DD

bdPhone

ans..40

O

Phone number in the billing address

bdTaxNumber

n11

O

Identification number of the payor. This value is used in the credit card form.

CPF: 11 characters without separators, e.g. 12312312312

bdStreet

ans..255

O

Street name in the invoicing address

bdAddrAddition

ans..50

O

Address addition in the billing address

bdCity

ans..50

O

Name of town/city in the billing address

bdZip

ans..20

O

Postcode in the invoicing address

bdState

ans..40

O

Federal State in the billing address

bdCountryCode

a2

O

Country code for the invoicing address, 2 characters according to ISO 3166

sdStreet

ans..255

O

Street in the delivery address

sdAddrAddition

ans..50

O

Address addition in the delivery address

sdCity

ans..50

O

Town/city in the delivery address

sdState

ans..40

O

Federal State in the delivery address

sdCountryCode

a2

O

Country code for the delivery address, 2 characters according to ISO 3166

sdZip

ans..20

O

Postcode in the delivery address

sdPhone

ans..40

O

Phone number in the delivery address

Parameters for credit card payments with PayU LatAm in Latin America


To adapt the layout of the SSL-page to your shop you can use the following unencrypted parameters to configure colours, fonts and images.

Parameter

Format

CND

Description

Template

ans..20

M

Name of XSLT-file with your own layout for the pay form. If you want to use the redesigned and downwards compatible Computop template, please transfer the template name “ct_compatible”. If you want to use the responsive Computop template for mobile devices, please transfer the template name “ct_responsive”.

Background

ans..256

M

Background ambiance of form:

URL for a background image

- HTML-colour value for background colour as HEX value or

- HTML-colour name

BGColor

ans..7

M

Form background colour:

- HTML-colour value for background colour as HEX value or

- HTML-colour name

BGImage

ans..256

M

Form background image:

URL for a background image

Please note that this value supersedes “BGColor”.

FColor

ans..6

M

Text colour:

- HTML-colour value as HEX value or

- HTML-colour name

FFace

a..10

M

HTML-name for the font

FSize

n2

M

Number for font size

Language

a2

(enum)

M

Language code: <de> German, <al> Albanian, <at> Austrian, <cz/cs> Czech, <dk> Danish, <en> English, <fi> Finish, <fr> French, <gr> Greek, <hu> Hungarian, <it> Italian, <jp> Japanese,  <nl> Dutch, <no> Norwegian, <pl> Polish,
<pt> Portuguese, <ro> Romanian, <ru> Russian, <sp> Spanish, <se> Swedish, <sk> Slovakian, <sl> Slovenian, <tr> Turkey, <zh> Simplified Chinese.

No details means the language is German.

CCSelect

a..10

M

Determines preselected card type in the form: VISA, MasterCard, AMEX, DINERS, Elo, Hipercard, NARANJA, SHOPPING, CABAL, ARGENCARD, CENCOSUD

URLBack

ans..256

M

URL for "Cancel" button

Center

n1

M

By default the form is centered vertically and horizontally. The value <1> centres the form at the top.

tWidth

ans..4

M

Width of table for input of the credit card data as percent- (50%) or pixel values (320).

tHeight

ans..4

M

Height of table for input of the credit card data as percent- (70%) or pixel values (480).

Layout parameters for Paygate forms for credit card payments with PayU LatAm


The following table describes the result parameters that the Paygate transmits to your URLSuccess, URLFailure or URLNotify. If you have specified the Response=encrypt parameter, the following parameters are forwarded Blowfish encrypted to your system:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Additionally only for URLNotify: AUTHORIZE_REQUEST

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

CodeExt

ans..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

RefNr

ans..30

O

Merchant’s unique reference number

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

PCNr

n..16

O

Pseudo Card Number: Random number generated by Paygate which represents a genuine credit card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. You can use the PCN like a genuine card number for authorisation, capture and credits.

CCBrand

a..22

O

In combination with PCNr: Description of the credit card brand like VISA, MasterCard, AMEX, DINERS, Elo, Hipercard, NARANJA, SHOPPING, CABAL, ARGENCARD, CENCOSUD

CCExpiry

n6

O

In combination with PCNr: Expiry date of the credit card in the format YYYYMM.

Plain

ans..50

O

A value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

The merchant can submit several values separated by | which are returned unencrypted and separated by &.

Custom=session=123|id=456 will change in the answer to Session=123&id=456

Return parameters for URLSuccess, URLFailure and URLNotify with PayU LatAm



Credit card payment via Server-to-Server connection

In order to execute an SSL credit card payment with PayU LatAm in Latin America via a server-to-server connection, call the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

M

Merchant’s unique reference number

Amount

n..10

M

Amount in the smallest currency unit (e.g. USD Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three character DIN / ISO 4217; only ARS, BRL, CLO, COP, MXN, PEN and USD permitted

Capture

ans..6

OC

Determines the type and time of capture. AUTO: capturing immediately after authorisation (default value). MANUAL: capturing made by the merchant. <Number>: Delay in hours until the capture (whole number; 1 to 696).

Only in Brazil but not with brand Hipercard.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop

URLNotify

ans..256

O

Complete URL, which calls up Paygate in order to notify the shop about a status change of a credit. The URL can also be stored permanently at Computop. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

CCNr

n..19

M

Credit card number at least 12-digit, numerical without spaces. You can optionally transmit also a pseudo card number (PCN)

CCCVC

n..4

O

Card verification number: The last 3 digits on the signature strip of the credit card. 4 characters in the case of AMEX.

CCExpiry

n6

M

Credit card expiry date (YYYYMM), e.g. 201607

CCBrand

a..22

M

Card type: VISA, MasterCard, AMEX, DINERS, Elo, Hipercard, NARANJA, SHOPPING, CABAL, ARGENCARD, CENCOSUD

Please note the spelling!

CreditCardHolder

ans..60

O

Name of the card holder

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

ReqID

ans..32

O

To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

InstallmentNumber

n..2

O

Number of months of the payment by instalments (1-12), default=1

Language

a2

O

Language:

EN – English (default)
ES – Spanish
PT – Portuguese

CountryCode

a2

M

Country code of that country where the transaction should be executed - 2 characters according to ISO 3166: AR, BR, CO, CL, MX, PA, PE

TermsAndCoditions

a..3

O

yes or no.

Terms and Conditions from PayU, which the customer has to accept.

It is only mandatory if a PayU-account which is registered in Brazil is connected with a bank within another country.

Contact data

Name

ans..128

OC

Name of the customer. If not specified, the CreditCardHolder must be submitted

CreditCardHolder

ans..128

OC

Name of the credit card holder. If not specified, the Name must be submitted.

Mail

ans..128

O

Email address of the customer

AddrStreet

ans..255

O

Customer’s street name

AddrCity

ans..50

O

Town/city of the customer

AddrState

ans..40

O

Federal State of the customer

AddrCountryCode

a2

O

Country code of the customer, 2 characters according to ISO 3166.

AddrZIP

ans..20

O

Postcode of the customer

Phone

ans..40

O

Customer’s phone number

eMail

ans..128

O

Email address of the customer

CustomerID

ans..16

O

Customer ID or customer number

CustomerClassification

a..8

O

Customer classification (business/private) default=private

TaxNumber

an11/an14

O

Identification number of the customer

In Brazil there are two kinds of tax numbers:

CPF for persons and CNPJ for companies. The discrimination is made by the parameter CustomerClassification.

CPF: 11 characters without separators, e.g. 12312312312

CNPJ: 14 characters without separators, e.g. 12345678000123

bdeMail

ans..128

O

Email address in the billing address

bdCustomerID

ans..16

O

Customer number in the billing address

bdDateOfBirth

ans10

O

Date of birth in the format YYYY-MM-DD

bdPhone

ans..40

O

Phone number in the billing address

bdTaxNumber

n11

O

Identification number of the payor. This value is used in the credit card form.

CPF: 11 characters without separators, e.g. 12312312312

bdStreet

ans..255

O

Street name in the invoicing address

bdAddrAddition

ans..50

O

Address addition in the billing address

bdCity

ans..50

O

Name of town/city in the billing address

bdZip

ans..20

O

Postcode in the invoicing address

bdState

ans..40

O

Federal State in the billing address

bdCountryCode

a2

O

Country code for the invoicing address, 2 characters according to ISO 3166

sdStreet

ans..255

O

Street in the delivery address

sdAddrAddition

ans..50

O

Address addition in the delivery address

sdCity

ans..50

O

Town/city in the delivery address

sdState

ans..40

O

Federal State in the delivery address

sdCountryCode

a2

O

Country code for the delivery address, 2 characters according to ISO 3166

sdZip

ans..20

O

Postcode in the delivery address

sdPhone

ans..40

O

Phone number in the delivery address

Parameters for credit card payments with PayU LatAm via socket connection


The following table gives the parameters with which the Paygate responds:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment Important for future reference

XID

an32

M

ID assigned by Paygate for the payment transaction

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK, AUTHORIZE-REQUEST or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

CodeExt

ans..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

RefNr

ans..30

O

Merchant’s unique reference number

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

PCNr

n..16

O

Pseudo Card Number; random number generated by Paygate which represents a genuine credit card number. The pseudo card number (PCN) starts with 0 and the last 3 digits correspond to those of the real card number. You can use the PCN like a genuine card number for authorisation, capture and credits.

CCBrand

a..22

O

In combination with PCNr: Name of credit card brand, e.g. Visa, MasterCard, Amex, DINERS etc.

CCExpiry

n6

O

In combination with PCNr: Expiry date of the credit card in the format YYYYMM.

Results parameters for socket connection with PayU LatAm



Cash payment with PayU in Latin America

In order to execute a CashPayment payment with PayU LatAm in Latin America via a server-to-server connection, call the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

M

Merchant’s unique reference number

Amount

n..10

M

Amount in the smallest currency unit (e.g. USD Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three character DIN / ISO 4217; only ARS, BRL, CLO, COP, MXN, PEN and USD permitted

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop

ReqID

ans..32

O

To avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

URLNotify

ans..256

O

Complete URL, which calls up Paygate in order to notify the shop about a status change of a credit. The URL can also be stored permanently at Computop. The URL may be called up only via port 443 It may not contain parameters: Use the UserData parameter instead.

IPAddr

ans..15

O

IP address. If you transfer the IP address, Paygate can determine in which country and in which town your customer has connected with the Internet (see also IPZone). Format: 123.456.789.012

Language

a2

O

Language:

EN – English (default)
ES – Spanish
PT – Portuguese

CountryCode

a2

M

Country code of that country where the transaction should be executed - 2 characters according to ISO 3166: AR, BR, CO, CL, MX, PA, PE

TermsAndCoditions

a..3

OC

yes or no.

Terms and Conditions from PayU, which the customer has to accept.

It is mandatory if a PayU-account which is registered in Brazil is connected with a bank within another country.

PayType

a..25

O

Name of used payment method

Argentina:

PAGOFACIL, RAPIPAGO, COBRO_EXPRESS, BAPRO, RIPSA

Brazil:

BOLETO_BANCARIO

Colombia:

BALOTO, EFECTY, PSE

Mexico:

OXXO, BANCOMER, IXE, SCOTIABANK, SANTANDER, SEVEN_ELEVEN

Peru:

BCP

Contact data

Name

ans..128

OC

Mandatory In Brazil: Name of the customer

Mail

ans..128

OC

Mandatory In Brazil: Email address of the customer

AddrStreet

ans..255

OC

Mandatory In Brazil: Customer’s street name

AddrCity

ans..50

OC

Mandatory In Brazil: Town/city of the customer

AddrState

ans..40

OC

Mandatory In Brazil: Federal State of the customer

AddrZIP

ans..20

OC

Mandatory In Brazil: Postcode of the customer

AddrCountryCode

a2

O

Country code of the customer, 2 characters according to ISO 3166.

Phone

ans..40

O

Customer’s phone number

CustomerID

ans..16

O

Customer ID or customer number

CustomerClassification

a..8

O

Customer classification (business/private) default=private

TaxNumber

ans..20

OC

Mandatory In Brazil: Identification number of the customer

In Brazil there are two kinds of tax numbers:

CPF for persons and CNPJ for companies. The discrimination is made by the parameter CustomerClassification.

CPF: 11 characters without separators, e.g. 12312312312

CNPJ: 14 characters without separators, e.g. 12345678000123

bdeMail

ans..128

O

Email address in the billing address

bdCustomer­­ID

ans..16

O

Customer number in the billing address

bdDateOfBirth

ans10

O

Date of birth in the format YYYY-MM-DD

bdPhone

ans..40

O

Phone number in the billing address

bdTaxNumber

n11

O

Identification number of the payor. This value is used in the credit card form.

CPF: 11 characters without separators, e.g. 12312312312

bdStreet

ans..255

O

Street name in the invoicing address

bdAddrAddition

ans..50

O

Address addition in the billing address

bdCity

ans..50

O

Name of town/city in the billing address

bdZip

ans..20

O

Postcode in the invoicing address

bdState

ans..40

O

Federal State in the billing address

bdCountryCode

a2

O

Country code for the invoicing address, 2 characters according to ISO 3166

sdStreet

ans..255

O

Street in the delivery address

sdAddrAddition

ans..50

O

Address addition in the delivery address

sdCity

ans..50

O

Town/city in the delivery address

sdState

ans..40

O

Federal State in the delivery address

sdCountryCode

a2

O

Country code for the delivery address, 2 characters according to ISO 3166

sdZip

ans..20

O

Postcode in the delivery address

sdPhone

ans..40

O

Phone number in the delivery address

Parameters for payments with PayU CashPayment via socket connection


The following table gives the parameters with which the Paygate responds:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

ID assigned by Paygate for the payment transaction

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK, AUTHORIZE-REQUEST or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

CodeExt

ans..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

RefNr

ans..30

O

Reference number is returned, if it was previously submitted

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

PaymentSlipLink

ans..256

M

Complete URL (URL-encoded) for the page which presents the payment form

Results parameters for socket connection with PayU CashPayment


The following table describes the parameters which the Paygate returns to URLNotify:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files.

XID

an32

M

ID assigned by Paygate for the payment transaction

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

CodeExt

ans..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

RefNr

ans..30

O

Reference number is returned, if it was previously submitted

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

Amount

n..10

M

Amount in the smallest currency unit (e.g. USD Cent)

Currency

a3

M

Currency, three character DIN / ISO 4217; only ARS, BRL, CLO, COP, MXN, PEN and USD permitted

Response parameters to URLNotify for payments with PayU CashPayment



Capture of a credit card payment with PayU LatAm

Captures are possible via a Server-to-Server connection. To carry out a Capture for a credit card payment with PayU LatAm via a Server-to-Server connection please use the following URL:


Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment to be captured

TransID

ans..64

M

ID assigned by Merchant for the payment process to be captured

Amount

n..10

M

Amount in the smallest currency unit (e.g. USD Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a..3

M

Currency, three character DIN / ISO 4217; only ARS, BRL, CLO, COP, MXN, PEN and USD permitted

RefNr

ans..30

O

Unique reference number which appears on your printed card account or in the EPA-file (Electronic Payment Advice). Format must be mutually agreed beforehand with Computop!

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Parameters for captures of PayU LatAm via socket connections


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment to be captured, e.g. for referencing in batch files

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

RefNr

ans..30

O

Merchant’s unique reference number

CodeExt

n..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

Response parameters for captures of PayU LatAm via socket connections



Credit with reference

Credits (refunds) are possible via a Server-to-Server connection. For a Credit with reference to a capture the amount of the Credit is limited to the amount of the previous capture.

To carry out a credit, please use the following URL:


The following tables describe the transfer parameters and return values which are exchanged via the socket connection.

Notice: For security reasons, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment to be credited

TransID

ans..64

M

ID assigned by Merchant for the payment process to be credited

Amount

n..10

M

Amount in the smallest currency unit (e.g. USD Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a..3

M

Currency, three character DIN / ISO 4217; only ARS, BRL, CLO, COP, MXN, PEN and USD permitted

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm

OrderDesc

ans..768

O

Description of refunded goods, unit prices, merchant’s comment etc.

ReqIDans..32OTo avoid double payments, enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction is submitted again with the same ReqID, Paygate will not carry out the payment, but will just return the status of the original transaction. Please note that the Paygate must have a finalized transaction status for the first initial action. Submissions with identical ReqID for an open status will be processed regularly.

Parameters for credit payments with PayU LatAm via socket connection


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

CodeExt

n..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

Response parameters for credit payments with PayU LatAm via socket connection



Batch processing via the interface

Basic information about using Batch files and about their structure can be found in the Batch Manager manual. Within batch processing not alle functions are available which are usually available for the online interface.

This section describes the parameters which must be transferred within the data set (Record) for executing of payments / credits for PayU LatAm in Latin America and which information can be found within the response file about the payment status.

Following table gives an overview of all batch versions that are possible for a specific action and their specialities:

Action

Version

Description

Capture

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2.x

with RefNr (valid for all versions other than 1.0)

Credit

1.0 / 2.0

Standard version without return of parameter Code

 

1.x / 2x.

with RefNr (valid for all versions other than 1.0)

Description of the possible batch versions


The structure for a PayU LatAm payment within a Batch file to be submitted is the following:

HEAD,<MerchantID>,<Date>,<Version>

CC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

CC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>

FOOT,<CountRecords>,<SumAmount>


Example for Master MID Funktion:

HEAD,[Master]MerchantID,Date,2.x
Type,Action,[Slave]MID,Amount,Currency,TransID,Data (depends on Action)
FOOT,CountRecords,SumAmount


The following table describes the individual fields and values used within the data set (record) in the batch file:

Parameter

Format

CND

Description

Type

a..11

M

HEAD for Header, FOOT for Footer, CC for Credit card payment with PayU

Action

a..20

M

The parameter Action defines the type of transaction:

Capture
Credit

Amount

n..10

M

Amount in the smallest currency unit (e.g. USD Cent)

Please contact the helpdesk, if you want to capture amounts < 100 (smallest currency unit).

Currency

a3

M

Currency, three character DIN / ISO 4217; only ARS, BRL, CLO, COP, MXN, PEN and USD permitted

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

PayID

an32

M

ID for this transaction given by Paygate

Description of fields within the record for Batch files

 

 

The record area within the response file for Batch transactions looks the following way:

HEAD,<MerchantID>,<Date>,<Version>

CC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

CC,Credit,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

FOOT,<CountRecords>,<SumAmount>

 

The following table describes the response parameters which the Batch Manager saves in the Record area for each transaction (standard parameters not explained here, such as <TransID> or <RefNR> and request parameters are returned unchanged and correspond to the call as specified before):

Parameter

Format

CND

Description

Action

a..20

M

The parameter Action defines the type of transaction:

Capture
Credit

PayID

an32

M

ID for this transaction given by Paygate

Status

a..50

M

OK or FAILED

Code

n8

M

Error code according to Paygate Response Codes (A4 Error codes)

Description of result parameters within the record for Batch files