Maintenance Work Notice!

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

Page tree

Search

Skip to end of metadata
Go to start of metadata


About PayU Africa

General information about payment methods via PayU Africa


Logo

Info

PayU Africa is leading PSP covering South African and Nigeria 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 India solution.

TypeMixed payment methods EN



Process flow charts


Process flow for PayU Africa WebCheckout



Process flow PayU Africa via form interface payssl.aspx



Process flow PayU Africa 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 Africa via Paygate form interface

To make a payment with PayU in South Africa or Nigeria, go to the following URL:


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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

ans..64

M

Merchant transaction number, which must be unique

RefNr

ns..30

M

Unique reference number

Amount

n..10

M

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

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

Currency

a3

M

Currency, three digits DIN / ISO 4217. Presently only ZAR allowed.

MAC

an64

M

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

URLSuccess

ans..256

M

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

URLFailure

ans..256

M

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

Response

a7

O

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

URLNotify

ans..256

M

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

UserData

ans..1024

O

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

ReqID

ans..32

O

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

OrderDesc

ans..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 ZAF and NGA allowed. The default is ZAF.

Plain

ans..50

O

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

Custom

ans..1024

O

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

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

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.

Parameters for payments with PayU Africa WebCheckout


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

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

n8

M

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

RefNr

ns..30

O

Merchant’s unique reference number

MAC

an64

M

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

CodeExt

n..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

UserData

ans..1024

O

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

TransactionID

ans..64

O

Transaction ID from PayU

Plain

ans..50

O

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

Custom

ans..1024

O

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

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

Return parameters for URLSuccess, URLFailure and URLNotify with PayU Africa WebCheckout



Credit card payment with PayU Africa via Paygate form interface

In order to execute a credit card payment in South Africa or Nigeria with PayU Africa via a Paygate form, visit the following URL:


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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

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!

Amount

n..10

M

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

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

Currency

a3

M

Currency, three digits DIN / ISO 4217. Presently only ZAR allowed.

MAC

an64

M

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

OrderDesc

ans..100

M

Description of purchased goods, unit prices etc.

URLSuccess

ans..256

M

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

URLFailure

ans..256

M

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

Response

a7

O

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

URLNotify

ans..256

M

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

UserData

ans..1024

O

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

ReqID

ans..32

O

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

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 ZAF and NGA allowed. The default is ZAF.

Plain

ans..50

O

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

Custom

ans..1024

O

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

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

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.

Parameters for credit card payments with PayU Africa


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

Parameter

Format

CND

Description

Template

ans..20

M

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

Background

ans..256

M

Background ambiance of form:

URL for a background image

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

- HTML-colour name

BGColor

ans..7

M

Form background colour:

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

- HTML-colour name

BGImage

ans..256

M

Form background image:

URL for a background image

Please note that this value supersedes “BGColor”.

FColor

ans..6

M

Text colour:

- HTML-colour value as HEX value or

- HTML-colour name

FFace

a..10

M

HTML-name for the font

FSize

n2

M

Number for font size

Language

a2

(enum)

M

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

No details means the language is German.

CCSelect

a..10

M

Determines preselected card type in the form: VISA, MasterCard, AMEX, Diners, RuPay

URLBack

ans..256

M

URL for "Cancel" button

Center

n1

M

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

tWidth

ans..4

M

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

tHeight

ans..4

M

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

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


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or 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

n8

M

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

CodeExt

ans..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

MAC

an64

M

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

UserData

ans..1024

O

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

RefNr

ans..30

O

Merchant’s unique reference number

PCNr

n..16

O

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

CCBrand

a..22

O

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

CCExpiry

n6

O

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

MaskedPan

an..19

OC

Masked card number 6x4

TransactionID

ans..64

C

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 value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

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

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

Return parameters for URLSuccess, URLFailure and URLNotify with PayU Africa



Credit card payment via Server-to-Server connection

In order to execute a TLS credit card payment without 3D Secure with PayU Africa in South Africa or Nigeria via a server-to-server connection, call the following URL:


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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

ans..64

M

Merchant’s transaction number

RefNr

ns..30

C

Merchant’s unique reference number

Amount

n..10

M

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

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

Currency

a3

M

Currency, three digits DIN / ISO 4217. Presently only ZAR allowed.

Capture

an..6

OC

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

MAC

an64

M

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

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

UserData

ans..1024

O

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

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

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

ReqID

ans..32

O

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

CountryCode

a..3

O

Country code 2 or 3 digits according to ISO 3166 for selecting the credentials. Presently only 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

C

Customer number.

If customer number is not submitted instead the email address is transferred to PayU.

For recurring payments the CustomerID is mandatory.

Parameters for credit card payments with PayU Africa via socket connection


The following table gives the parameters with which Paygate responds:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

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

Code

n8

M

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

CodeExt

ans..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

RefNr

ns..30

O

Merchant’s unique reference number

UserData

ans..1024

O

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

PCNr

n..16

O

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

CCBrand

a..22

O

In combination with PCNr: Name of credit card brand 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

C

Transaction ID from PayU

TokenExt

an..64

C

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

Result parameters for socket connection with PayU Africa



Recurring credit card payment via Server-to-Server connection

In order to execute a recurring credit card payment with PayU Africa in South Africa or Nigeria via a server-to-server connection, call the following URL:


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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

ans..64

M

Merchant’s transaction number

RefNr

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

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

Currency

a3

M

Currency, three digits DIN / ISO 4217. Presently only ZAR allowed.

Capture

an..6

OC

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

MAC

an64

M

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

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

UserData

ans..1024

O

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

CCNr

n..19

M

Pseudo card number

CCExpiry

n6

M

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

CCBrand

a..22

M

Card brand: only VISA, MasterCard, AMEX, Diners.

Please note the spelling!

CreditCardHolder

ans..60

O

Name of the card holder

RTF

a1

O

„R“ for recurrent payments

ReqID

ans..32

O

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

TokenExt

a1

O

TokenExt of initial payment for referencing the credit card data at PayU

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

C

Customer number.

If customer number is not submitted instead the email address is transferred to PayU.

For recurring payments the CustomerID is mandatory.

Parameters for recurring credit card payments with PayU Africa via socket connection


The following table gives the parameters with which Paygate responds:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK, AUTHORIZED or FAILED

Description

ans..1024

M

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

Code

n8

M

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

CodeExt

ans..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

RefNr

ns..30

O

Merchant’s unique reference number

UserData

ans..1024

O

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

Result parameters for socket connection with PayU Africa



Capture of a payment with PayU Africa

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


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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID assigned by Paygate for the payment to be credited

TransID

ans..64

M

ID assigned by Merchant for the payment process to be captured

Amount

n..10

M

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

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

Currency

a..3

M

Currency, three digits DIN / ISO 4217. Presently only ZAR allowed.

MAC

an64

M

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

RefNr

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

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

Parameters for captures of PayU Africa via socket connections


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

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

Code

n8

M

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

RefNr

ns..30

O

Merchant’s unique reference number

CodeExt

n..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

Response parameters for captures of PayU Africa via socket connections



Credit with reference

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

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


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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID assigned by Paygate for the payment to be credited

TransID

ans..64

M

ID assigned by Merchant for the payment process to be credited

Amount

n..10

M

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

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

Currency

a..3

M

Currency, three digits DIN / ISO 4217. Presently only ZAR allowed.

MAC

an64

M

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

OrderDesc

ans..100

O

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

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

Parameters for credit of credit card payments with PayU Africa via socket connection


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

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

Code

n8

M

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

CodeExt

n..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

Response parameters for credit of credit card payments with PayU Africa 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 payments / credits with PayU India 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

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)

Description of the possible batch versions


The structure for a PayU Africa transaction within a Batch file to be submitted is the following:

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

CC,Authorize,<Amount>,<Currency>,<TransID>,(<RefNr>,)<CCBrand>,<CCNr|PCNr>, [<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<Zone>]

CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>,)<CCBrand>,<CCNr|PCNr>, [<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<Zone>]

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

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

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

FOOT,<CountRecords>,<SumAmount>


Example for Master MID Funktion:

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


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

Parameter

Format

CND

Description

Type

a..11

M

HEAD for Header, FOOT for Footer, CC for Credit card 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. ZAR Cent)

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

Currency

a3

M

Currency code, three digits DIN / ISO 4217. Presently only ZAR allowed.

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

PayID

an32

M

ID for this transaction given by Paygate

OrderDesc

ans..127

O

Description of purchased goods, unit prices etc.

CCBrand

a..2

M

Credit card brand like VISA, MasterCard, AMEX etc.

Please note the spelling!

CCNr

n..16

M

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

PCNr

n..16

M

You can optionally transmit also a pseudo card number (PCN) instead of the real credit card number

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.

CCExpiry

n6

M

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

Description of fields within the record for Batch files

 

The record area within the response file for Batch transactions looks as follows:

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

CC,Authorize,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<CCBrand>,<CCNr|PCNr>,[<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<Zone>],<Status>,<Code>

CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<CCBrand>,<CCNr|PCNr>,[<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<Zone>],<Status>,<Code>

CC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>[<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>],<Status>,<Code>

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

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

FOOT,<CountRecords>,<SumAmount>

 

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

Parameter

Format

CND

Description

Action

a..20

M

The parameter Action defines the type of transaction:

Credit
Reverse

PayID

an32

M

ID for this transaction given by Paygate

Status

a..50

M

OK or FAILED

Code

n8

M

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

Description of result parameters within the record for Batch files


About PayU Africa

General information about payment methods via PayU Africa


Logo

Info

PayU Africa is leading PSP covering South African and Nigeria 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 India solution.

TypeMixed payment methods EN



Process flow charts


Process flow for PayU Africa WebCheckout



Process flow PayU Africa via form interface payssl.aspx



Process flow PayU Africa 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 Africa via Paygate form interface

To make a payment with PayU in South Africa or Nigeria, go to the following URL:


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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

ans..64

M

Merchant transaction number, which must be unique

RefNr

ns..30

M

Unique reference number

Amount

n..10

M

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

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

Currency

a3

M

Currency, three digits DIN / ISO 4217. Presently only ZAR allowed.

MAC

an64

M

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

URLSuccess

ans..256

M

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

URLFailure

ans..256

M

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

Response

a7

O

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

URLNotify

ans..256

M

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

UserData

ans..1024

O

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

ReqID

ans..32

O

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

OrderDesc

ans..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 ZAF and NGA allowed. The default is ZAF.

Plain

ans..50

O

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

Custom

ans..1024

O

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

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

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.

Parameters for payments with PayU Africa WebCheckout


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

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

n8

M

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

RefNr

ns..30

O

Merchant’s unique reference number

MAC

an64

M

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

CodeExt

n..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

UserData

ans..1024

O

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

TransactionID

ans..64

O

Transaction ID from PayU

Plain

ans..50

O

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

Custom

ans..1024

O

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

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

Return parameters for URLSuccess, URLFailure and URLNotify with PayU Africa WebCheckout



Credit card payment with PayU Africa via Paygate form interface

In order to execute a credit card payment in South Africa or Nigeria with PayU Africa via a Paygate form, visit the following URL:


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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

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!

Amount

n..10

M

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

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

Currency

a3

M

Currency, three digits DIN / ISO 4217. Presently only ZAR allowed.

MAC

an64

M

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

OrderDesc

ans..100

M

Description of purchased goods, unit prices etc.

URLSuccess

ans..256

M

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

URLFailure

ans..256

M

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

Response

a7

O

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

URLNotify

ans..256

M

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

UserData

ans..1024

O

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

ReqID

ans..32

O

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

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 ZAF and NGA allowed. The default is ZAF.

Plain

ans..50

O

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

Custom

ans..1024

O

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

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

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.

Parameters for credit card payments with PayU Africa


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

Parameter

Format

CND

Description

Template

ans..20

M

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

Background

ans..256

M

Background ambiance of form:

URL for a background image

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

- HTML-colour name

BGColor

ans..7

M

Form background colour:

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

- HTML-colour name

BGImage

ans..256

M

Form background image:

URL for a background image

Please note that this value supersedes “BGColor”.

FColor

ans..6

M

Text colour:

- HTML-colour value as HEX value or

- HTML-colour name

FFace

a..10

M

HTML-name for the font

FSize

n2

M

Number for font size

Language

a2

(enum)

M

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

No details means the language is German.

CCSelect

a..10

M

Determines preselected card type in the form: VISA, MasterCard, AMEX, Diners, RuPay

URLBack

ans..256

M

URL for "Cancel" button

Center

n1

M

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

tWidth

ans..4

M

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

tHeight

ans..4

M

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

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


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or 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

n8

M

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

CodeExt

ans..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

MAC

an64

M

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

UserData

ans..1024

O

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

RefNr

ans..30

O

Merchant’s unique reference number

PCNr

n..16

O

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

CCBrand

a..22

O

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

CCExpiry

n6

O

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

MaskedPan

an..19

OC

Masked card number 6x4

TransactionID

ans..64

C

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 value to be set by the merchant to return some information unencrypted, e.g. the MID

Custom

ans..1024

O

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

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

Return parameters for URLSuccess, URLFailure and URLNotify with PayU Africa



Credit card payment via Server-to-Server connection

In order to execute a TLS credit card payment without 3D Secure with PayU Africa in South Africa or Nigeria via a server-to-server connection, call the following URL:


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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

ans..64

M

Merchant’s transaction number

RefNr

ns..30

C

Merchant’s unique reference number

Amount

n..10

M

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

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

Currency

a3

M

Currency, three digits DIN / ISO 4217. Presently only ZAR allowed.

Capture

an..6

OC

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

MAC

an64

M

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

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

UserData

ans..1024

O

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

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

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

ReqID

ans..32

O

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

CountryCode

a..3

O

Country code 2 or 3 digits according to ISO 3166 for selecting the credentials. Presently only 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

C

Customer number.

If customer number is not submitted instead the email address is transferred to PayU.

For recurring payments the CustomerID is mandatory.

Parameters for credit card payments with PayU Africa via socket connection


The following table gives the parameters with which Paygate responds:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

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

Code

n8

M

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

CodeExt

ans..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

RefNr

ns..30

O

Merchant’s unique reference number

UserData

ans..1024

O

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

PCNr

n..16

O

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

CCBrand

a..22

O

In combination with PCNr: Name of credit card brand 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

C

Transaction ID from PayU

TokenExt

an..64

C

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

Result parameters for socket connection with PayU Africa



Recurring credit card payment via Server-to-Server connection

In order to execute a recurring credit card payment with PayU Africa in South Africa or Nigeria via a server-to-server connection, call the following URL:


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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

ans..64

M

Merchant’s transaction number

RefNr

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

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

Currency

a3

M

Currency, three digits DIN / ISO 4217. Presently only ZAR allowed.

Capture

an..6

OC

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

MAC

an64

M

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

OrderDesc

ans..768

M

Description of purchased goods, unit prices etc.

UserData

ans..1024

O

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

CCNr

n..19

M

Pseudo card number

CCExpiry

n6

M

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

CCBrand

a..22

M

Card brand: only VISA, MasterCard, AMEX, Diners.

Please note the spelling!

CreditCardHolder

ans..60

O

Name of the card holder

RTF

a1

O

„R“ for recurrent payments

ReqID

ans..32

O

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

TokenExt

a1

O

TokenExt of initial payment for referencing the credit card data at PayU

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

C

Customer number.

If customer number is not submitted instead the email address is transferred to PayU.

For recurring payments the CustomerID is mandatory.

Parameters for recurring credit card payments with PayU Africa via socket connection


The following table gives the parameters with which Paygate responds:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK, AUTHORIZED or FAILED

Description

ans..1024

M

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

Code

n8

M

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

CodeExt

ans..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

RefNr

ns..30

O

Merchant’s unique reference number

UserData

ans..1024

O

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

Result parameters for socket connection with PayU Africa



Capture of a payment with PayU Africa

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


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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID assigned by Paygate for the payment to be credited

TransID

ans..64

M

ID assigned by Merchant for the payment process to be captured

Amount

n..10

M

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

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

Currency

a..3

M

Currency, three digits DIN / ISO 4217. Presently only ZAR allowed.

MAC

an64

M

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

RefNr

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

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

Parameters for captures of PayU Africa via socket connections


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

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

Code

n8

M

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

RefNr

ns..30

O

Merchant’s unique reference number

CodeExt

n..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

Response parameters for captures of PayU Africa via socket connections



Credit with reference

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

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


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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID assigned by Paygate for the payment to be credited

TransID

ans..64

M

ID assigned by Merchant for the payment process to be credited

Amount

n..10

M

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

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

Currency

a..3

M

Currency, three digits DIN / ISO 4217. Presently only ZAR allowed.

MAC

an64

M

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

OrderDesc

ans..100

O

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

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

Parameters for credit of credit card payments with PayU Africa via socket connection


The following table describes the Paygate response parameters:

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

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

Code

n8

M

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

CodeExt

n..10

O

Error code from PayU, if agreed with Computop support

ErrorText

ans..256

O

Error text from PayU, if agreed with Computop support

Response parameters for credit of credit card payments with PayU Africa 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 payments / credits with PayU India 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

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)

Description of the possible batch versions


The structure for a PayU Africa transaction within a Batch file to be submitted is the following:

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

CC,Authorize,<Amount>,<Currency>,<TransID>,(<RefNr>,)<CCBrand>,<CCNr|PCNr>, [<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<Zone>]

CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>,)<CCBrand>,<CCNr|PCNr>, [<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<Zone>]

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

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

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

FOOT,<CountRecords>,<SumAmount>


Example for Master MID Funktion:

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


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

Parameter

Format

CND

Description

Type

a..11

M

HEAD for Header, FOOT for Footer, CC for Credit card 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. ZAR Cent)

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

Currency

a3

M

Currency code, three digits DIN / ISO 4217. Presently only ZAR allowed.

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ns..30

O

Unique reference number

PayID

an32

M

ID for this transaction given by Paygate

OrderDesc

ans..127

O

Description of purchased goods, unit prices etc.

CCBrand

a..2

M

Credit card brand like VISA, MasterCard, AMEX etc.

Please note the spelling!

CCNr

n..16

M

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

PCNr

n..16

M

You can optionally transmit also a pseudo card number (PCN) instead of the real credit card number

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.

CCExpiry

n6

M

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

Description of fields within the record for Batch files

 

The record area within the response file for Batch transactions looks as follows:

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

CC,Authorize,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<CCBrand>,<CCNr|PCNr>,[<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<Zone>],<Status>,<Code>

CC,Sale,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<CCBrand>,<CCNr|PCNr>,[<CCCVC>,]<CCExpiry>,<OrderDesc>[,<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>,<Zone>],<Status>,<Code>

CC,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>[<textfeld1>,<textfeld2>,<RTF>,<approvalcode>,<cardholder>],<Status>,<Code>

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

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

FOOT,<CountRecords>,<SumAmount>

 

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

Parameter

Format

CND

Description

Action

a..20

M

The parameter Action defines the type of transaction:

Credit
Reverse

PayID

an32

M

ID for this transaction given by Paygate

Status

a..50

M

OK or FAILED

Code

n8

M

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

Description of result parameters within the record for Batch files