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)

CND

condition

M

mandatory

O

optional

C

conditional

https://www.computop-paygate.com/payssl.aspx

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

O

Merchant’s unique reference number

Amount

n..10

M

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

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

Currency

a3

M

Currency, three digits DIN / ISO 4217. For merchants in China (inland) only CNY is permitted; CNY is not permitted for cross-border merchants. 

MAC

an64

M

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

a2

(enum)

Accepted language code at MasaPay: "CN" Chinese, "EN" English, "FR" French, "DE" German, "ES" Spanish, "IT" Italian, "JA" Japanese, "RU" Russian, "KO" Korean, "TH" Thai, "SV" Swedish.

No detail means the language is EN. If the submitted Language is not supported by MasaPay, EN will be forwarded.

OrderDesc

ans..768

M

Description of purchased goods. The special characters “#”, ”&”, ”%” and “+” are not permitted here.

Article list, describes the individual items of the purchase goods.

Structure: <Product name>;<Article number>;<Gross individual price>;<Quantity>>;<Web link of article>

(<Web link of article> is optional)

<;> separates the fields of an article data set
<+> separates the article data sets

Data type (size):

Product name = ans..10
Article number = ans..30
Gross unit price = n..12 in the smallest currency unit (e.g. EUR Cent)
Quantity = n..5
Web link of article = ans..100

Example: Product1;11111;100;11; https://www.books.com/book1.bok+Product2;22222;150;12; https://www.books.com/book2.bok

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.

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

bdFirstName

ans..50

M

First name in the invoicing address

bdLastName

ans..50

M

Last name in the invoicing address

bdStreet

ans..128

M

Street name in the invoicing address

bdStreetNr

ans..10

M

Street number of the invoicing address

bdStreet2

ans..50

O

Address c/o of the invoicing address

bdZip

ans..20

M

Postcode in the invoicing address

bdCompany

ans..200

O

Company name in the invoicing address

bdCountryCode

a2

M

Country code in the invoicing address (e.g. ‘de’)

bdState

ans..20

M

State/country in the invoicing address

bdCity

ans..20

M

Town/city in the invoicing address

bdEmail

ans..100

M

Email address in the invoicing address

bdPhone

ans..20

M

Phone number in the invoicing address

bdMobileNr

ans..20

O

Mobile phone number in the invoicing address

sdFirstName

ans..50

OC

First name in the delivery address

sdLastName

ans..50

OC

Surname in the delivery address

sdStreet

ans..128

OC

Street in the delivery address

sdStreetNr

ans..10

OC

Street number of the delivery address

sdStreet2

ans..50

O

Address addition in the delivery address

sdZIP

ans..20

OC

Postcode in the delivery address

sdCompany

ans..200

O

Company name in the delivery address

sdCountryCode

a2

OC

Country code in the delivery address.

sdState

ans..20

OC

Federal state in the delivery address

sdCity

ans..20

OC

Town/city in the delivery address

sdEmail

ans..100

OC

E-mail address in the delivery address

sdPhone

ans..20

OC

Phone number in the delivery address

Email

ans..60

O

E-mail address of the customer on registration at the merchant

CustomerID

ans..20

O

Customer ID or customer number

Channel

a4

O

Used terminal by the time of ordering (MOTO: Mobile phone, ECOM: PC), it supersedes the configured default value.

IPAddr

ns..15

O

Fraud prevention: IP address when ordering

RegistrationDate

ans19

O

Date and time when the customer has created the account

RegistrationIP

ns..15

O

Customer registered IP address

RegistrationDevice

a4

O

Used terminal when the customer was registered (MOTO: Mobile phone, ECOM: PC), if not given the value of Channel will be taken.

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 for one payment assigned by Paygate

TransID

ans..64

M

Merchant’s transaction number

RefNr

ns..30

O

Merchant’s unique reference 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)

MAC

an64

M

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

UserData

ans..256

O

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

In combination with PCNr: Name of credit card brand. Please note the spelling according to table of credit card brands! 

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

https://www.computop-paygate.com/direct.aspx

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

O

Merchant’s unique reference number

Amount

n..12

M

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

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

Currency

a3

M

Currency, three digits DIN / ISO 4217. For merchants in China (inland) only CNY is permitted; CNY is not permitted for cross-border merchants.

CCNr

n..19

M

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

CCCVC

n..4

M

Card verification number: The last 3 digits 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

CCBrand

a..22

M

Credit card brand. Please note the spelling according to table of credit card brands!

Only VISA, MasterCard, JCB, AMEX, Diners and DISCOVER are supported by MasaPay.

MAC

an64

M

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

Language

a2 (enum)

O

Accepted language code at MasaPay: "CN" Chinese, "EN" English, "FR" French, "DE" German, "ES" Spanish, "IT" Italian, "JA" Japanese, "RU" Russian, "KO" Korean, "TH" Thai, "SV" Swedish.

No details means the language is EN. If the submitted Language is not supported by MasaPay, EN will be forwarded.

OrderDesc

ans..768

M

Description of purchased goods. The special characters “#”, ”&”, ”%” and “+” are not permitted here.

ArticleList

ans..2000

M

Article list, describes the individual items of the purchase goods.

Structure: <Product name>;<Article number>;<Gross individual price>;<Quantity>>;<Web link of article>

(<Web link of article> is optional)

<;> separates the fields of an article data set
<+> separates the article data sets

Data type (size):

Product name = ans..10
Article number = ans..30
Gross unit price = n..12 in the smallest currency unit (e.g. EUR Cent)
Quantity = n..5
Web link of article = ans..100

Example: Product1;11111;100;11; https://www.books.com/book1.bok+Product2;22222;150;12; https://www.books.com/book2.bok

URLNotify

ans..256

M

Complete URL which Paygate calls up in order to notify the shop about the payment result, when MasaPay has asynchronous notification. The URL may be requested only via port 443. It must not contain any parameters. Please use the UserData parameter instead.

UserData

ans..256

O

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

Capture

an..6

O

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

ReqID

ans..32

O

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

expirationTime

ans19

O

Timestamp for the end time of the transaction processing, specified in UTC. Format: YYYY-MM-ddTHH:mm:ss

CreditCardHolder

ans..100

O

Name of the credit card holder

bdFirstName

ans..50

M

First name in the invoicing address

bdLastName

ans..50

M

Last name in the invoicing address

bdStreet

ans..128

M

Street name in the invoicing address

bdStreetNr

ans..10

M

Street number of the invoicing address

bdStreet2

ans..50

O

Address c/o of the invoicing address

bdZip

ans..20

M

Postcode in the invoicing address

bdCompany

ans..200

O

Company name in the invoicing address

bdCountryCode

a2

M

Country code in the invoicing address (e.g. ‘de’)

bdState

ans..20

M

State/country in the invoicing address

bdCity

ans..20

M

Town/city in the invoicing address

bdEmail

ans..100

M

Email address of the customer

bdPhone

ans..20

M

Phone number of the customer

bdMobileNr

ans..20

O

Mobile phone number of the customer

sdFirstName

ans..50

OC

First name in the delivery address

sdLastName

ans..50

OC

Surname in the delivery address

sdStreet

ans..128

OC

Street in the delivery address

sdStreetNr

ans..10

OC

Street number of the delivery address

sdStreet2

ans..50

O

Address addition in the delivery address

sdZIP

ans..20

OC

Postcode in the delivery address

sdCompany

ans..200

O

Company name in the delivery address

sdCountryCode

a2

OC

Country code in the delivery address.

sdState

ans..20

OC

Federal state in the delivery address

sdCity

ans..20

OC

Town/city in the delivery address

sdEmail

ans..100

OC

E-mail address of the delivery address

sdPhone

ans..20

OC

Phone number

Email

ans..60

O

E-mail address of the customer on registration at the merchant

CustomerID

ans..20

O

Customer ID or customer number

Channel

a4

O

Used terminal by the time of ordering (MOTO: Mobile phone, ECOM: PC), it supersedes the configured default value.

IPAddr

ns..15

M

Fraud prevention: IP address when ordering

RegistrationDate

ans19

O

Date and time when the customer has created the account

RegistrationIP

ns..15

O

Customer registered IP address

RegistrationDevice

a4

O

Used terminal when the customer was registered (MOTO: Mobile phone, ECOM: PC), if not given the value of Channel will be taken.

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment. Important for future reference

XID

an32

M

ID of transaction authorization/sale in a payment assigned by Paygate

TransID

ans..64

M

Merchant transaction number

RefNr

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

n8

M

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

UserData

ans..256

O

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

PCNr

n16

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

OC

In combination with PCNr: Name of credit card brand. Please note the spelling according to table of credit card brands!

CCExpiry

n6

OC

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

CodeExt

ans..10

O

MasaPay error Code

ErrorText

ans..128

O

Detailed MasaPay error message

https://www.computop-paygate.com/capture.aspx

MerchantID

ans..30

M

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

PayID

an32

M

ID assigned by Paygate for the payment to be captured

TransID

ans..64

M

ID assigned by Merchant for the payment process to be captured

RefNr

ns..30

O

Merchant’s unique reference number

Amount

n..10

M

Amount has to be equal to original authorized amount (cf. payment parameter Amount above)

Currency

a3

M

Currency code, three digits DIN / ISO 4217

MAC

an64

M

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

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 of transaction capture in a payment assigned by Paygate

TransID

ans..64

M

Merchant transaction number

RefNr

ns..30

O

Merchant’s unique reference number

Amount

n..10

M

Amount has to be equal to original authorized amount (cf. payment parameter Amount above)

Status

a..50

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

MasaPay error Code

ErrorText

ans..128

O

Detailed MasaPay error message

https://www.computop-paygate.com/credit.aspx

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

RefNr

ns..30

O

Merchant’s unique reference number

Amount

n..10

M

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

Currency

a3

M

Currency code, three digits DIN / ISO 4217

MAC

an64

M

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

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 of transaction credit in a payment assigned by Paygate

TransID

ans..64

M

Merchant transaction number

RefNr

ns..30

O

Merchant’s unique reference number

Amount

n..10

M

Amount has to be equal to original authorized amount (cf. payment parameter Amount above)

Status

a..50

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

MasaPay error Code

ErrorText

ans..128

O

Detailed MasaPay error message

https://www.computop-paygate.com/reverse.aspx

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 reversed

TransID

ans..64

M

Merchant ID for the identification of the payment process to be reversed

RefNr

ns..30

O

Merchant’s unique reference number

Amount

n..10

O

Amount has to be equal to original authorized amount (cf. payment parameter Amount above)

Currency

a3

M

Currency code, three digits DIN / ISO 4217

MAC

an64

M

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

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 of transaction reversal in a payment assigned by Paygate

TransID

ans..64

M

Merchant transaction number

RefNr

ns..30

O

Merchant’s unique reference number

Status

a..50

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

MasaPay error Code

ErrorText

ans..128

O

Detailed MasaPay error message