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 MasterPass

General information about MasterPass

Logo

Info

MasterPass is a wallet provided by MasterCard that makes credit card payments quicker, easier and more secure. MasterPass allows payments in online shops but also in actual shops with your Smartphone and the MasterPass app or NFC. Settlement is via all standard credit and debit cards.

TypePayments by eWallet EN

Further information you can be found on the website of MasterPass (http://www.mastercard.com/de/privatkunden/innovationen_masterpass.html).

Process flow charts


Process flow MasterPass V2

Process flow MasterPass V6, Pairing


Process flow MasterPass V6, Checkout with optional Pre-Checkout

On this page


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.


Call of MasterPass interface for V2

A credit card payment by MasterPass Checkout always consists of two steps. Firstly, the required credit card data is detected in the MasterPass transaction via the MasterPass.aspx interface. Subsequently, the actual credit card transaction must be executed via the separate directmp.aspx interface. This takes place via a server-to-server connection and supports all usual credit card transaction options. Unlike those, however, you do not transmit the credit card data which are unknown to you, but instead the IDs that you received from MasterPass beforehand in the first step.

In order to make a credit card payment with MasterPass, 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

TransactionID which should be unique for each payment

RefNr

ans..30

M

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

Amount

n..10

M

Total amount of all articles within the shopping basket without delivery costs.

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

MAC

ans..64

M

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

OrderDesc

ans..200

M

Description of purchased goods, unit prices etc.

ArticleList

ans..768

M

Article list with description of items and prices:

<Article description>;<quantity>;<price>;<ImageURL>

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

Article description: max. 50 characters

quantity: Quantity without comma

Price: Quantity * Unit price

Image-Url: optional; Picture 40x40 pixel from the shop

AcceptableCards

ans..100

M

Card labels which are displayed to the buyer on the MasterPass page for selection. Comma-separated values without spaces.

Allowed: master,amex,diners,discover,maestro,visa

ShippingProfile

ans..5

O

Shipping Location Profile ID: US, CS, FR, MEX, NA, UK

SuppressShippingAddress

ans..5

O

if true the delivery address is not displayed on the MasterPass page, e.g. in the case of digital goods

RewardProgram

ans..5

O

true if reward data are to be returned

AuthLevelBasic

ans..5

O

true if 3D-authentication is to be reset from Advanced to Basic

URLSuccess

ans..256

M

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

URLFailure

asns..256

M

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

Response

a7

M

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 in the request, Paygate submits the parameters to the shop with the payment status.

Name

ans..100

O

Name of Customer (delivery address)

Only if Name is specified the other parts of delivery address are used.

AddrStreet

ans..40

O

Street name (delivery address)

AddrStreet2

ans..40

O

Apartment or room number (delivery address)

AddrStreet3

ans..255

O

Address addition (delivery address)

AddrCity

ans..25

O

Town or city (delivery address)

AddrZip

ans..20

O

Post code (delivery address)

AddrCountryCode

an2

O

Country code in the delivery address, 2 characters according to ISO 3166-1

AddrState

an5

O

Abbreviation of the customer’s Federal State according to ISO 3166-2, e.g.: DE-BW (delivery address)

Phone

ans..20

O

Customer's telephone number (delivery address)

Parameters for credit card payments with MasterPass-Checkout V2


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

MasterPassID

ans..32

M

ID assigned by Paygate for the MasterPass transaction Important for the subsequent payment.

TransactionID

ans..255

M

Transaction number from MasterPass. Important for the subsequent payment.

Status

a..30

M

OK (URLSuccess-page) or FAILED (URLFailure-page)

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 status analysis!

Code

n8

M

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

MAC

ans..64

M

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

RefNr

ans..30

O

Merchant’s unique reference number

UserData

ans..1024

O

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

Name

ans..100

M

Name of Customer (delivery address)

AddrStreet

ans..40

M

Street name (delivery address)

AddrStreet2

ans..40

M

Apartment or room number (delivery address)

AddrStreet3

ans..255

M

Address addition (delivery address)

AddrCity

ans..25

M

Town or city (delivery address)

AddrZip

ans..20

M

Post code (delivery address)

AddrState

an5

M

Abbreviation of the customer’s Federal State according to ISO 3166-2, e.g.: DE-BW (delivery address)

Phone

ans..20

M

Customer's telephone number (delivery address)

AddrCountryCode

an2

M

Country code in the delivery address, 2 characters according to ISO 3166-1

BillingName

ans..100

O

Name of Customer (billing address)

BillingAddrStreet

ans..40

O

Street name (billing address)

BillingAddrStreet2

ans..40

O

Apartment or room number (billing address)

BillingAddrStreet3

ans..255

O

Addition (billing address)

BillingAddrCity

ans..25

O

Town or city (billing address)

BillingAddrZip

ans..20

O

Post code (billing address)

BillingAddrState

an5

O

Abbreviation of the customer’s Federal State according to ISO 3166-2, e.g.: DE-BW (billing address)

BillingAddrCountryCode

an2

O

Country code in the billing address, 2 characters according to ISO 3166-1

ConFirstName

ans..20

M

First name of contact person (AP)

ConLastName

ans..20

M

Last name. (AP)

ConGender

a1

M

Gender (AP): M, F

ConCountry

a2

M

Country code (AP)

ConEMail

ans..512

M

E-mail address (AP)

ConPhone

ans..20

M

Telephone number (AP)

ConDateOfBirth

n8

M

Date of birth (AP) in the format YYYYMMDD

RewNumber

ans..

M

Reward customer number

RewID

ans..

M

ID of reward programme

RewName

ans..

M

Name of reward programme

RewExpiry

ans..

M

Reward valid until

Response parameters for URLSuccess and URLFailure with MasterPass V2


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

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

MasterPassID

ans..32

M

ID assigned by Paygate for the MasterPass transaction Important for the subsequent payment.

TransactionID

ans..255

M

Transaction number from MasterPass. Important for the subsequent payment.

Status

a..30

M

OK (URLSuccess-page) or FAILED (URLFailure-page)

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 status analysis!

Code

n8

M

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

MAC

ans..64

M

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

RefNr

ans..30

O

Merchant’s unique reference number

UserData

ans..1024

O

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

Response parameters for URLNotify with MasterPass V2


After completion of the MasterPass transaction, merchants are able to execute the credit card payment. To do this, visit the following URL for the server-to-server connection:


The transfer parameters and return values correspond, with the following exceptions, to those of a standard credit card payment, as described as general parameters in the credit card payment manual. The necessary credit card details CCNr, CCCVC, CCExpiry and CCBrand originate from the MasterPass transaction and do not have to be transferred here. Instead, transfer the following two transfer parameters as reference.

Parameter

Format

CND

Description

MasterPassID

ans..32

M

ID assigned by Paygate for the MasterPass transaction Important for the subsequent payment.

TransactionID

ans..255

M

Transaction number from MasterPass. Important for the subsequent payment.

Additional transfer parameters for credit card payment with MasterPass



Call of MasterPass interface for V6

A credit card payment via MasterPass V6 requires at least two requests to the Paygate as well as invoking the MasterPass lightbox. The first request to the Paygate is directed to interface MPServices.aspx. The response gives you parameters which are needed for invoking the MasterPass lightbox. Script details for invoking the lightbox gets the merchant directly from MasterPass. The lightbox shows the MasterPass wallet. There the customer logs in and chooses his credit card and delivery address. The lightbox then transfers the parameters needed for finalizing the payment from the wallet to Paygate. In the last step also the credit card payment is authorized via interface MPCheckout.aspx.

There are four Masterpass-Services: Pairing, LongAccessToken, PreCheckout as well as Checkout & Checkout_Pairing. For the simple process call the service Checkout directly. But if you want to use PreCheckout and the data from customer’s wallet you must call all services subsequently.

Pairing one-time connects the merchant’s shop with customer’s MasterPass wallet. After successful pairing the merchant can proceed with the checkout.

After the customer has confirmed the pairing within his wallet, you call the service LongAccessToken. You must store the LongAccessToken for that customer. Only if you have a valid LongAccessToken, you can use the service PreCheckout. After each PreCeheckout you will get e new LongAccessToken. This also is valid onl for one PreCheckout.

With the service PreCheckout you can read data from customer’s wallet. This occurs without active customer participation. It is sufficient that the customer grants the merchant a one-time access vi pairing. Which data are available is defined during pairing. With the parameter RequestedDataTypes you define which data to get for the present request. For the credit card numbers only the last four digits are transferred. Within your shop you show the customer the data from the wallet. The custumer selects his credit card, delivery address etc. already within the shop.

With the service Checkout- or Checkout_Pairing you prepare the call of the customer wallet for finalizing the purchase. Here you transfer the shopping basket. If you select Checkout_Pairing the customer sees the pairing page within his wallet. In the response you will get the RequestToken or rather the PairingToken for displaing the MasterPass lightbox.

After the checkout service you transfer the data from the customer to the MasterPass lieghtbox. The customer only has to confirm the purchase with his password without displaying the content of his wallet.

In order to execute a MasterPass service in the first step, 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.

Following tables describes the transfer parameters to be encrypted and the response parameters of the services.


MasterPass-Service: Pairing

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..30

O

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

EventToken

ans..40

M

MasterPass service to be executed: Pairing

URLOrigin

ans..255

M

Url of the page, from where the lightbox is called

MAC

ans..64

M

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

Parameters for MasterPass service Pairing


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

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

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

Code

n8

M

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

PairingRequestToken

ans..80

M

Will be transferred as parameter pairingRequestToken at call of lightbox

Result parameters for MasterPass service Pairing



MasterPass-Service: LongAccessToken

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

PayID form the pairing process

TransID

ans..64

O

TransactionID which should be unique for each payment

RefNr

ans..30

O

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

EventToken

ans..40

M

MasterPass service to be executed: LongAccessToken

PairingToken

ans..80

M

Is delievered from MasterPass as response parameter from lightbox

PairingVerifier

ans..80

M

Is delievered from MasterPass as response parameter from lightbox

MAC

ans..64

M

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

Parameters for MasterPass service LongAccessToken


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

O

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

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

Code

n8

M

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

LongAccessToken

ans..80

M

This LongAccessToken is needed for calling the Pre-Checkout.

Result parameters for MasterPass service LongAccessToken



MasterPass-Service: PreChekout

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..30

O

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

EventToken

ans..40

M

MasterPass service to be executed: PreChekout

URLOrigin

ans..255

M

Url of the page, from where the lightbox is called

RequestedDataTypes

ans..80

M

List of data areas to be retrieved. Possible values (comma separated): CARD,PROFILE,ADDRESS,REWARD_PROGRAM

LongAccessToken

ans..80

M

Token of the LongAccessToken service or from previous PreCheckout

MAC

ans..64

M

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

Parameters for MasterPass service PreCheckout


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

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

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

Code

n8

M

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

PreCheckoutXML

ans..80

M

Data from Customer’s wallet within XML format

LongAccessToken

ans..80

M

This LongAccessToken is needed for calling the next PreCheckout

Result parameters for MasterPass service PreCheckout



MasterPass-Service: Checkout & Checkout Pairing

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

O

PayID from the PreCheckout service

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..30

O

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

EventToken

ans..40

M

MasterPass service to be executed: Checkout & Checkout_Pairing

URLOrigin

ans..255

M

Url of the page, from where the lightbox is called

Amount

n..10

M

Total amount of all shopping basket articles without delivery costs.

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

ArticleList

ans..768

M

Article list with description of items and prices:

<Article description>;<quantity>;<price>;<ImageURL>

<;> separates the fields of an article data set
<+> separates the article data sets
Article description: max. 50 characters
Quantity: Quantity without comma
Price: Quantity * Unit price
Image-Url: optional; Picture 40x40 pixel from the shop

MAC

ans..64

M

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

Parameters for MasterPass service Checkout & Checkout_Pairing


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

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

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

Code

n8

M

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

RequestToken

ans..80

M

Is needed as parameter for calling the lightbox

PairingRequestToken

ans..80

MC

Only with Checkout_Pairing: Is needed as parameter for calling the lightbox

Result parameters for MasterPass service Checkout & Checkout_Pairing



MasterPass-Checkout

In order to finalize a MasterPass process and to initiate the credit card payment, 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.

Notice: With parameter skipAuth=yes the execution of a credit card payment can be prevented. Later the credit card payment can be triggered via interface directmp.aspx using the same parameters like for MasterPass V2, as can be seen above.

Notice: Here you can also transfer parameters which are used especially for the credit card payment. These are simply forwarded for the authorization. Which parameters are possible you will find within the documentation of the respective payment method.

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

PayID from the previous Checkout service

TransID

ans..64

O

TransactionID which should be unique for each payment. This will be used for credit card payment. If TransID is not specified, the TransID from the previous service will be used.

RefNr

ans..30

O

Unique reference number. Format must be mutually agreed beforehand with Computop! This will be used for credit card payment. If RefNr is not specified, the RefNr from the previous service will be used.

Amount

n..10

M

Total amount of all shopping basket articles without delivery costs.

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

MAC

ans..64

M

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

OrderDesc

ans..200

M

Description of purchased goods, unit prices etc.

UserData

ans..1024

O

If specified in the request, Paygate submits the parameters to the shop with the payment status.

SkipAuth

a..5

O

yes: No credit card payment is executed. Within the response additional contact data, delivery and billing address are returned like with MasterPass.aspx V2 (see above). The credit card payment has to be triggered via the directmp.aspx (see above).

CheckoutToken

ans..80

M

Lightbox return parameter oauthToken

CheckoutVerifier

ans..80

M

Lightbox return parameter oauthVerifier

CheckoutUrl

ans..255

M

Lightbox return parameter checkoutUrl

PairingToken

ans..80

O

pairing_token: is needed for checkout with pairing

PairingVerifier

ans..80

O

pairing_verifier: is needed for checkout with pairing

Name

ans..100

O

Name of Customer (delivery address)

Only if Name is specified the other parts of delivery address are used.

AddrStreet

ans..40

O

Street name (delivery address)

AddrStreet2

ans..40

O

Apartment or room number (delivery address)

AddrStreet3

ans..255

O

Address addition (delivery address)

AddrCity

ans..25

O

Town or city (delivery address)

AddrZip

ans..20

O

Post code (delivery address)

AddrCountryCode

an2

O

Country code in the delivery address, 2 characters according to ISO 3166-1

AddrState

an5

O

Abbreviation of the customer’s Federal State according to ISO 3166-2, e.g.: DE-BW (delivery address)

Phone

ans..20

O

Customer's telephone number (delivery address)

Parameters for credit card payments with MasterPass-Checkout V6


The following table describes the Paygate response parameters: The parameters correspond to the credit card payment. Further response parameters you can find within the documentation of your credit card payment method.

Parameter

Format

CND

Description

MID

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

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

XID

an32

M

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

TransID

ans..64

M

Merchant’s transaction number

RefNr

ans..30

O

Merchant’s unique reference number

Status

a..30

M

OK or FAILED

Description

ans..1024

M

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

Code

n8

M

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

Response parameters for credit card payments with MasterPass-Checkout V6



Calling the interface for a capture

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


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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID assigned by Paygate for the payment to be captured

TransID

ans..64

M

ID assigned by Merchant for the payment process to be captured

RefNr

ns..30

O

Merchant reference number: here a separate reference number, e.g. an invoice number, can be transferred

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 code, three digits DIN / ISO 4217

MAC

an64

M

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

FinishAuth

a1

O

Transmit value <Y> in order to stop the prolongation of guaranteed authorizations and rest amounts after partial captures.

Note

ans..37

O

Text that will we displayed as reason for payment to the customer

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 MasterPass captures


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..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 status analysis!

Code

n8

M

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

RefNr

ns..30

O

Merchant’s unique reference number

Result parameters for MasterPass captures



Credit with reference

Credits (refunds) are possible via a Server-to-Server connection. For a Credit with reference to a capture the amount of the Credit is limited to the amount of the previous capture. To carry out a credit with a reference transaction, please use the following URL:


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

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

The following table describes the encrypted payment request parameters:

Parameter

Format

CND

Description

MerchantID

ans..30

M

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

PayID

an32

M

ID assigned by Paygate for the payment to be credited

TransID

ans..64

M

ID assigned by Merchant for the payment process to be credited

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR 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

MAC

an64

M

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

OrderDesc

ans..768

O

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

UserData

ans..1024

O

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

CredNo

ans..

O

Credit number. Will be set to “0” if not transmitted.

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 credits of MasterPass payments


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..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 status analysis!

Code

n8

M

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

Result parameters for credits of MasterPass payments