PayU Africa

Logo

Info

PayU Africa is leading PSP covering South African, Nigeria and Kenya markets, offering all relevant payment methods: local card acquiring, online bank transfers, loyalty cards and eWallets. The advantage of using PayU Africa is reach into all local payment methods, which is crucial for high conversion.

Merchants looking to sell cross-border into Africa can fully capitalise on the market and meet customer payment expectations by using PayU Africa solution.

Type

Mixed payment methods

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)

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

MerchantID

ans..30

M

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

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Amount

n..10

M

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

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR. Presently only KES, NGN and ZAR allowed. Please find an overview here: A1 Currency table

MAC

an64

M

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

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

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.

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.

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.

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.

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 UserDataparameter instead.

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.

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

OrderDesc

ans..100

M

Description of purchased goods, unit prices etc.

CountryCode

a..3

O

Country code 2 or 3 digits according to ISO 3166 for selecting the credentials. Presently only KEN, ZAF and NGA allowed. The default is ZAF.

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.

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.

Please find a sample here: Custom

Customer data

FirstName

ans..64

M

First name of the customer

LastName

ans..64

M

Last name of the customer

eMail

ans..64

O

Email address of the customer

MobileNr

ans..40

O

Customer’s mobile telephone number

SocialSecurityNumber

ans..50

O

Customer's Social security number

CustomerID

ans..64

O

Customer number.

If customer number is not submitted instead the email address is transferred to PayU, provided that this is submitted.

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 as well as for capture or credit request.

XID

an32

M

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

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Status

a..50

M

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

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

an8

M

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

MAC

an64

M

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

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

CodeExt

n..10

O

Error code from PayU, if agreed with Computop Helpdesk

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop Helpdesk

UserData

ans..1024

O

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

TransactionID

ans..64

O

Transaction ID from PayU

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.

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.

Please find a sample here: Custom

MerchantID

ans..30

M

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

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

RefNr

ns..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!

Amount

n..10

M

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

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR. Presently only KES, NGN and ZAR allowed. Please find an overview here: A1 Currency table

MAC

an64

M

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

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

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.

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.

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.

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.

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 UserDataparameter instead.

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.

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

OrderDesc

ans..100

M

Description of purchased goods, unit prices etc.

RTF

a1

O

„I“ for initializing recurrent payments

CountryCode

a..3

O

Country code 2 or 3 digits according to ISO 3166 for selecting the credentials. Presently only KEN, ZAF and NGA allowed. The default is ZAF.

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.

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.

Please find a sample here: Custom

Customer data

FirstName

ans..64

M

First name of the customer

LastName

ans..64

M

Last name of the customer

eMail

ans..64

O

Email address of the customer

MobileNr

ans..40

O

Customer’s mobile telephone number

SocialSecurityNumber

ans..50

O

Customer's Social security number

CustomerID

ans..64

O

Customer number.

If customer number is not submitted instead the email address is transferred to PayU, provided that this is submitted.

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

Background

ans..256

O

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

O

Form background colour:

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

- HTML-colour name

BGImage

ans..256

O

Form background image:

URL for a background image

Please note that this value supersedes “BGColor”.

FColor

ans..7

O

Text colour:

- HTML-colour value as HEX value or

- HTML-colour name

FFace

a..10

O

HTML-name for the font

FSize

n2

O

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, RuPay

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.

Center

n1

O

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

tWidth

ans..4

O

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

tHeight

ans..4

O

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

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 as well as for capture or credit request.

XID

an32

M

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

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Status

a..50

M

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

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

an8

M

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

CodeExt

n..10

O

Error code from PayU, if agreed with Computop Helpdesk

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop Helpdesk

MAC

an64

M

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

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

UserData

ans..1024

O

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

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

CCBrand

a..22

O

In combination with PCNr: Name of credit card brand like Visa, MasterCard etc.

CCExpiry

n6

O

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

MaskedPan

an..19

O

Masked card number 6x4

TransactionID

ans..64

O

Transaction ID from PayU

TokenExt

an..64

C

For recurring payments (RTF=I) the Token is transmitted for referencing the credit card data

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.

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.

Please find a sample here: Custom

MerchantID

ans..30

M

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

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Amount

n..10

M

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

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR. Presently only KES, NGN and ZAR allowed. Please find an overview here: A1 Currency table

MAC

an64

M

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

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

Capture

an..6

OM

Determines the type and time of capture.

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

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

CCNr

n..19

M

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

CCExpiry

n6

M

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

CCBrand

a..22

M

Card type: VISA, MasterCard, AMEX, Diners.

Please note the spelling!

CreditCardHolder

ans..60

O

Name of the card holder

RTF

a1

O

„I“ for initializing recurrent payments

CountryCode

a..3

O

Country code 2 or 3 digits according to ISO 3166 for selecting the credentials. Presently only KEN, ZAF and NGA allowed. The default is ZAF.

Customer data

FirstName

ans..64

M

First name of the customer

LastName

ans..64

M

Last name of the customer

eMail

ans..64

O

Email address of the customer

MobileNr

ans..40

O

Customer’s mobile telephone number

SocialSecurityNumber

ans..50

O

Customer's Social security number

CustomerID

ans..64

O

Customer number.

If customer number is not submitted instead the email address is transferred to PayU, provided that this is submitted.

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 as well as for capture or credit request.

XID

an32

M

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

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

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

an8

M

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

CodeExt

n..10

O

Error code from PayU, if agreed with Computop Helpdesk

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop Helpdesk

UserData

ans..1024

O

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

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

CCBrand

a..22

O

In combination with PCNr: Name of credit card brand like Visa, MasterCard etc.

CCExpiry

n6

O

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

MaskedPan

an..19

O

Masked card number 6x4

TransactionID

ans..64

O

Transaction ID from PayU

TokenExt

an..64

C

For recurring payments (RTF=I) the Token is transmitted for referencing the credit card data

MerchantID

ans..30

M

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

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

RefNr

ns..30

C

Merchant's reference number, mandatory for the initial payment of a new abo (RTF=I)

Amount

n..10

M

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

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR. Presently only KES, NGN and ZAR allowed. Please find an overview here: A1 Currency table

MAC

an64

M

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

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

Capture

an..6

OM

Determines the type and time of capture.

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

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

CCNr

n..19

M

Pseudo card number

CCExpiry

n6

M

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

CCBrand

a..22

M

Card type: VISA, MasterCard, AMEX, Diners.

Please note the spelling!

CreditCardHolder

ans..60

O

Name of the card holder

RTF

a1

O

„R“ for recurrent payments

RTF

a1

O

„R“ for recurrent payments

Customer data

FirstName

ans..64

M

First name of the customer

LastName

ans..64

M

Last name of the customer

eMail

ans..64

O

Email address of the customer

MobileNr

ans..40

O

Customer’s mobile telephone number

SocialSecurityNumber

ans..50

O

Customer's Social security number

CustomerID

ans..64

O

Customer number.

If customer number is not submitted instead the email address is transferred to PayU, provided that this is submitted.

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 as well as for capture or credit request.

XID

an32

M

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

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Status

a..50

M

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

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

an8

M

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

CodeExt

n..10

O

Error code from PayU, if agreed with Computop Helpdesk

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop Helpdesk

UserData

ans..1024

O

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

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

TransactionID provided by you which should be unique for each payment

Amount

n..10

M

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

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR. Presently only KES, NGN and ZAR allowed. Please find an overview here: A1 Currency table

MAC

an64

M

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

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

refnr

ans..30

O

Merchant’s unique reference number

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.

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 as well as for capture or credit request.

XID

an32

M

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

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

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

an8

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 Helpdesk

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop Helpdesk

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

TransactionID provided by you which should be unique for each payment

Amount

n..10

M

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

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR. Presently only KES, NGN and ZAR allowed. Please find an overview here: A1 Currency table

MAC

an64

M

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

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

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.

OrderDesc

ans..100

O

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

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 as well as for capture or credit request.

XID

an32

M

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

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

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

an8

M

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

CodeExt

n..10

O

Error code from PayU, if agreed with Computop Helpdesk

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop Helpdesk

Action

Version

Description

Authorize (CC only)

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)

1.2 / 2.2

with textfeld1, textfeld2, RTF, cardholder

1.21 / 2.21

with textfeld1, textfeld2, RTF, approvalcode, cardholder

1.3 / 2.3

with CVC

1.5 / 2.5

with Zone

Sale (CC only)

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)

1.2 / 2.2

with textfeld1, textfeld2, RTF, cardholder

1.21 / 2.21

with textfeld1, textfeld2, RTF, approvalcode, cardholder

1.3 / 2.3

with CVC

1.5 / 2.5

with Zone

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)

Reverse

1.0 / 2.0

Standard version without return of parameter Code

1.x / 2x.

with RefNr (valid for all versions other than 1.0)

Type

a..11

M

HEAD for Header, FOOT for Footer, CC for Credit card and PayUAfrWC for WebCheckout Subsequent transactions

Action

a..20

M

The parameter Action defines the type of transaction:

Authorize

Sale

Capture

Credit

Reverse

Amount

n..10

M

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

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR. Presently only KES, NGN and ZAR allowed. Please find an overview here: A1 Currency table

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

PayID

an32

M

ID assigned by Paygate for this transaction

OrderDesc

ans..127

O

Description of purchased goods, unit prices etc.

CCBrand

a..22

M

Card type: VISA, MasterCard, AMEX, Diners.

Please note the spelling!

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.

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

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

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

CCCVC

n..4

O

Card verification number in Version 1.3: In the case of Visa and MasterCard the last 3 numbers on the signature strip of the credit card. 4 numbers in the case of American Express.

n6

M

Expiry date of the credit card in the format YYYYMM, e.g. 202207

Action

a..20

M

The parameter Action defines the type of transaction:

Authorize

Sale

Capture

Credit

Reverse

PayID

an32

M

ID assigned by Paygate for this transaction

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

Code

an8

M

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