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

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, please use the following URL:

 

Notice: For security reasons, Computop 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:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Key

Format

CND

Description

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR. Presently only ARS, BRL, CLP, COP, MXN, PEN and USD allowed. Please find an overview here: A1 Currency table

KeyFormatCNDDescription

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

KeyFormatCNDDescription
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.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

KeyFormatCNDDescription
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.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

KeyFormatCNDDescription
Response

a7

O

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

KeyFormatCNDDescription
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.

(info) Common notes:

  • Before follow-up actions (capture / credit / reversal) are carried out on an existing transaction, the first Notify must have been answered by the shop.
  • Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Key

Format

CND

Description

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

Discountn..10ODiscount in the smallest currency unit
Languagea2O

Language:

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

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

VAT rate, e.g. 1900 for 19%

Default is 0 (no VAT)

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

KeyFormatCNDDescription
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

KeyFormatCND

Description

Custom
ans..1024


O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose.

Key

Format

CND

Description




Contact data
Nameans..128OName 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 gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Status

a..50

M

OK or AUTHORIZE_REQUEST (URLSuccess) as well as FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

Key

Format

CND

Description

CodeExtn..10O

Error code from PayU, if agreed with Computop Helpdesk

ErrorTextans..256O

Error text from PayU, if agreed with Computop Helpdesk

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

KeyFormatCND

Description

Custom
ans..1024


O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose.

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:

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

Key

Format

CND

Description

CodeExtn..10O

Error code from PayU, if agreed with Computop Helpdesk

ErrorTextans..256O

Error text from PayU, if agreed with Computop Helpdesk

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
Currency

a3

M

Currency, three letters DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Key

Format

CND

Description

AmountAuthn..10M

Actually authorized amount in the smallest currency unit.

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

TransactionIDans..25ORefNr from PayU system
PayTypeans..25OName of used payment method

KeyFormatCNDDescription
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

KeyFormatCND

Description

Custom
ans..1024


O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose.

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, please use the following URL:

 

Notice: For security reasons, Computop 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:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

Key

Format

CND

Description

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 Helpdesk!

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Key

Format

CND

Description

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR. Presently only ARS, BRL, CLP, COP, MXN, PEN and USD allowed. Please find an overview here: A1 Currency table

KeyFormatCNDDescription

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

KeyFormatCNDDescription
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.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

KeyFormatCNDDescription
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.

(info) Common notes:

  • We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate
  • However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

KeyFormatCNDDescription
Response

a7

O

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

KeyFormatCNDDescription
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.

(info) Common notes:

  • Before follow-up actions (capture / credit / reversal) are carried out on an existing transaction, the first Notify must have been answered by the shop.
  • Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

KeyFormatCNDDescription
Capturean..6OM

Determines the type and time of capture.

Capture ModeDescription
AUTOCapturing immediately after authorisation (default value).
MANUALCapturing made by the merchant. Capture is normally initiated at time of delivery.
<Number>Delay in hours until the capture (whole number; 1 to 696).

Key

Format

CND

Description

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

InstallmentNumbern..2ONumber of months of the payment by instalments (1-12), default=1
Languagea2O

Language:

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

CountryCodea2OCountry code of that country where the transaction should be executed ‒ 2 characters according to ISO 3166: AR, BR, CO, CL, MX, PA, PE
TermsAndConditionsa..3OC

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.

KeyFormatCNDDescription
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

KeyFormatCND

Description

Custom
ans..1024


O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose.

Key

Format

CND

Description




Contact data
Nameans..128OCName of the customer. If not specified, the CreditCardHolder must be submitted.

CreditCardHolder

ans..50

OC

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

Mailans..128OEmail 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:

KeyFormatCNDDescription
Template

ans..20

O

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”.

KeyFormatCNDDescription
Backgroundans..256O

Background ambiance of form:

URL for a background image

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

- HTML-colour name

KeyFormatCNDDescription
BGColorans..7O

Form background colour:

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

- HTML-colour name

KeyFormatCNDDescription
BGImage
ans..256
O

Form background image:

URL for a background image

Please note that this value supersedes “BGColor”.

KeyFormatCNDDescription
FColor
ans..7
O

Text colour:

- HTML-colour value as HEX value or

- HTML-colour name

KeyFormatCNDDescription
FFace
a..10
O
HTML-name for the font

KeyFormatCNDDescriptionBeschreibung
FSize
n2
O
Number for font size

Zahl für die Schriftgröße

Key

Format

CND

Description


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.


CCSelecta..10MDetermines preselected card type in the form: VISA, MasterCard, AMEX, DINERS, Elo, Hipercard, NARANJA, SHOPPING, CABAL, ARGENCARD, CENCOSUD

KeyFormatCNDDescription
URLBack

ans..256

O

Complete URL which Paygate calls in case that Cancel is clicked by the customer.

The parameter "URLBack" can be sent

  • either as plain parameter (unencrypted) (compatibility mode)
  • or be part of encrypted payment request parameters (preferred mode)

In order to exchange values between Paygate and shop you may use something like this:

URLBack=https://your.shop.com/back.php?param1%3Dvalue1%26param2%3Dvalue3%26status%3Dcancelled 

When user cancels payment this URL is called exactly like this and you may use URL Decode to extract parameter and values.

KeyFormatCNDDescription
Center

n1

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

KeyFormatCNDDescription
tWidth

ans..4

O
Width of table for input in the form as percent- (50%) or pixel values (320).

KeyFormatCNDDescription
tHeight

ans..4

O
Height of table for input of the payment data in the form as percent- (70%) or pixel values (480).

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


The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

Key

Format

CND

Description

Statusa..50M

OK or FAILED

Additionally only for URLNotify: AUTHORIZE_REQUEST

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

Key

Format

CND

Description

CodeExtn..10O

Error code from PayU, if agreed with Computop Helpdesk

ErrorTextans..256O

Error text from PayU, if agreed with Computop Helpdesk

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

CCBrand

a..22

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

n6

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

KeyFormatCNDDescription
Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID. 

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation. 

KeyFormatCND

Description

Custom
ans..1024


O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer. 

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose.

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, please use the following URL:

 

Notice: For security reasons, Computop 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:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Key

Format

CND

Description

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR. Presently only ARS, BRL, CLP, COP, MXN, PEN and USD allowed. Please find an overview here: A1 Currency table

KeyFormatCNDDescription

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Key

Format

CND

Description

Capture

an..6

OC

Determines the type and time of capture.

Capture ModeDescription
AUTOCapturing immediately after authorisation (default value).
MANUALCapturing made by the merchant. Capture is normally initiated at time of delivery.
<Number>Delay in hours until the capture (whole number; 1 to 696).

Only in Brazil but not with brand Hipercard.

KeyFormatCNDDescription
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.

(info) Common notes:

  • Before follow-up actions (capture / credit / reversal) are carried out on an existing transaction, the first Notify must have been answered by the shop.
  • Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

KeyFormatCNDDescription
CCNr

n..19

M

Credit card number for credit card payments. 

It can be filled:

  • either with the real credit card number (PAN)
  • or with the pseudo card number that you have received previously in a Paygate response in parameter PCNr.

(info) With 3-D Secure 2.x the CCNr (PAN or PCNr) is sent as card.JSON.

(info) We recommend to use "Hosted Payment Page" or Credit Card Form (paySSL) for simplified PCI DSS certification and usage of PCNr.

Key

Format

CND

Description

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. 202607

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.

InstallmentNumbern..2ONumber of months of the payment by instalments (1-12), default=1
Languagea2O

Language:

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

CountryCodea2MCountry code of that country where the transaction should be executed ‒ 2 characters according to ISO 3166: AR, BR, CO, CL, MX, PA, PE
TermsAndConditionsa..3OC

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.

Key

Format

CND

Description




Contact data
Nameans..128OCName of the customer. If not specified, the CreditCardHolder must be submitted.

CreditCardHolder

ans..50

OC

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

Mailans..128OEmail 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 via socket connection


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Status

a..50

M

OK or AUTHORIZED (URLSuccess) as well as FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

Key

Format

CND

Description

CodeExtn..10O

Error code from PayU, if agreed with Computop Helpdesk

ErrorTextans..256O

Error text from PayU, if agreed with Computop Helpdesk

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
PCNr

n16

O

Pseudo Card Number: Random number generated by Computop 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. The PCN can be used like a genuine card number for authorisation, capture and credits.

PCNr is a response value from Computop Paygate and is sent as CCNr in Request or part of card-JSON.

KeyFormatCNDDescription
PCNr

n16

O

Pseudo Card Number: Random number generated by Computop 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. The PCN can be used like a genuine card number for authorisation, capture and credits.

PCNr is a response value from Computop Paygate and is sent as CCNr in Request or part of card-JSON.

Key

Format

CND

Description

CCBrand

a..22

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

n6

OIn 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, please use the following URL:

 

Notice: For security reasons, Computop 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:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Key

Format

CND

Description

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR. Presently only ARS, BRL, CLP, COP, MXN, PEN and USD allowed. Please find an overview here: A1 Currency table

KeyFormatCNDDescription

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

Key

Format

CND

Description

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

KeyFormatCNDDescription
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.

(info) Common notes:

  • Before follow-up actions (capture / credit / reversal) are carried out on an existing transaction, the first Notify must have been answered by the shop.
  • Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Key

Format

CND

Description

IPAddrans..39O

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

Languagea2O

Language:

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

CountryCodea2MCountry code of that country where the transaction should be executed ‒ 2 characters according to ISO 3166: AR, BR, CO, CL, MX, PA, PE
TermsAndConditionsa..3OC

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.

PayTypea..25O

Name of used payment method

Argentina:

PAGOFACIL, RAPIPAGO, COBRO_EXPRESS, BAPRO, RIPSA

Brazil:

BOLETO_BANCARIO

Colombia:

EFECTY, PSE

Mexico:

OXXO, BANCOMER, IXE, SCOTIABANK, SANTANDER, SEVEN_ELEVEN

Peru:

BCP

Key

Format

CND

Description




Contact data
Nameans..128OCMandatory 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

AddrZIPans..20OCMandatory In Brazil: Postcode 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

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

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 payments with PayU CashPayment via socket connection


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

Key

Format

CND

Description

RefNr

ns..30

O

Reference number is returned, if it was previously submitted

KeyFormatCNDDescription
Status

a..50

M

OK or AUTHORIZED (URLSuccess) as well as FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

Key

Format

CND

Description

CodeExtn..10O

Error code from PayU, if agreed with Computop Helpdesk

ErrorTextans..256O

Error text from PayU, if agreed with Computop Helpdesk

KeyFormatCNDDescription
UserData

ans..1024

O

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

Key

Format

CND

Description

PaymentSlipLinkans..256MComplete 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:

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

Key

Format

CND

Description

RefNr

ns..30

O

Reference number is returned, if it was previously submitted

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

Key

Format

CND

Description

CodeExtn..10O

Error code from PayU, if agreed with Computop Helpdesk

ErrorTextans..256O

Error text from PayU, if agreed with Computop Helpdesk

KeyFormatCNDDescription
UserData

ans..1024

O

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

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Key

Format

CND

Description

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR. Presently only ARS, BRL, CLP, COP, MXN, PEN and USD allowed. Please find an overview here: A1 Currency table

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, Computop 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:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment to be captured

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Key

Format

CND

Description

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR. Presently only ARS, BRL, CLO, COP, MXN, PEN and USD permitted. Please find an overview here: A1 Currency table

KeyFormatCNDDescription

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

Key

Format

CND

Description

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!

KeyFormatCNDDescription
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Parameters for captures of PayU LatAm via socket connections


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

Key

Format

CND

Description

CodeExtn..10O

Error code from PayU, if agreed with Computop Helpdesk

ErrorTextans..256O

Error text from PayU, if agreed with Computop Helpdesk

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 with a reference transaction, please use the following URL:


Notice: For security reasons, Computop 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:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment to be credited

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Key

Format

CND

Description

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR. Presently only ARS, BRL, CLO, COP, MXN, PEN and USD permitted. Please find an overview here: A1 Currency table

KeyFormatCNDDescription

MAC

an64

M
Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

KeyFormatCNDDescription
ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Key

Format

CND

Description

OrderDescans..768ODescription of refunded goods, unit prices, merchant’s comment etc.
Parameters for credit payments with PayU LatAm via socket connection


The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

Key

Format

CND

Description

CodeExtn..10O

Error code from PayU, if agreed with Computop Helpdesk

ErrorTextans..256O

Error text from PayU, if agreed with Computop Helpdesk

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 / 2.x

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 function:

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:

Key

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

KeyFormatCNDDescription
Amountn..10M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Key

Format

CND

Description

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR. Presently only ARS, BRL, CLO, COP, MXN, PEN and USD allowed. Please find an overview here: A1 Currency table

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
refnr

ans..30

O

Merchant’s unique reference number

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for this transaction

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):

Key

Format

CND

Description

Action

a..20

M

The parameter Action defines the type of transaction:

Capture
Credit

KeyFormatCNDDescription
PayID

an32

M

ID assigned by Paygate for this transaction

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
Code

an8

M

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

Description of result parameters within the record for Batch files