INIT / Authorize

PAYMENT_INIT

(PAYMENT_QUERY)

Computop executes automatically the request
PAYMENT_INIT. If a merchant uses Integrated Payment Control (IBS) the PAYMENT_QUERY request is carried out.

EventToken = A

Create payment

(Authorize step 1)

PAYMENT_REQUEST

Initialises a purchase by instalment or purchase on account

EventToken = R

Verify

(Authorize Schritt 2)

PAYMENT_CONFIRM

Confirms the initialisation again.

Computop can also automate this request. Please leave this request out in that case (contact our support for this).

EventToken = V

Order change

(before capture)

PAYMENT_CHANGE

Optional: Here the payment can be modified. Possible are:

-          Full cancellation / EventToken = FC

-          Partial cancellation / EventToken = PC

-          Order change / EventToken = CO

Capture

CONFIRMATION_DELIVERY

Activates and/or carries out payment.

This request must be given when the goods are shipped for reasons of liability and falling due!

EventToken = C

Order change

(after capture)

PAYMENT_CHANGE

Optional: Here the payment can be modified. Possible are:

-          Full return / EventToken = FC

-          Partial return / EventToken = PR

-          Credit / EventToken = CR

https://paymentpage.axepta.bnpparibas/ratepay.aspx

MerchantID

ans..30

M

MerchantID, assigned by Axepta. 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

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

MAC

an64

M

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

OrderDesc

ans..768

M

Description of the goods purchased

Email

ans..255

M

Email address of the card holder

CustomerID

an..30

M

Unique customer ID in merchant system or the customer’s email address.

CustomerClassification

ans..8

M

Instruction to risk management about type of customer: negative, neutral, positive, vip

Title

ans..45

O

Title

Salutation

ans..45

O

Salutation

Gender

a1

M

Gender: Sex (M=male / F=female / U=unknown)

DateOfBirth

dttm8

C

Date of birth in the format YYYYMMDD
Optional for B2B (CompanyName transmitted), otherwise mandatory.

PhoneAreaCode

ans..30

C

Telephone code. Mandotory if MobileAreaCode is not transmitted.

Phone

ans..30

C

Phone number. Mandotory if Mobile is not transmitted.

FaxAreaCode

ans..30

O

Fax area code

Fax

ans..30

O

Fax number

MobileAreaCode

ans..30

C

Mobile area code. Mandotory if PhoneAreaCode is not transmitted.

Mobile

ans..30

C

Mobile telephone number. Mandotory if Phone is not transmitted.

AccOwner

ans..55

C

Name of account holder. Mandatory for direct debit.

AccIBAN

ans..34

C

International Bank Account Number. Mandatory for direct debit.

BIC

ans11

C

Bank Identifier Code. Mandatory for direct debit.

AccBank

ans..27

O

Name of the financial institution

Nationality

a2

M

Country code of customer's country of origin according to ISO-3166 alpha 2

AllowMarketing

a..3

M

Customer agrees to the passing on of his details for marketing purposes (yes / no):

AllowCredInq

a..3

M

Customer agrees to the passing on of his details for credit offers (yes/no):

ShopSystem

ans..127

M

Name of the shop system

ShopSystemVersion

ans..127

M

Version name of the shop system

ShoppingBasket

ans..1024

M

Current shopping basket (for structure see table Shopping-Basket)

ShoppingBasketAmount

n..10

M

Total value of shopping basket in smallest currency unit (less discount, incl. shipment etc.)

Discount

ans..100

O

Trans-shopping cart discount

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Discount;1000;1900

ShippingProfile

ans..100

O

Shipping costs

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Shipment;500;1900

TrackingId

ans..100

O

List of shipment service providers with associated parcel number

Format: SERVICE PROVIDER; PACKAGE NUMBER

Example: DHL;Paket1

Other service providers/dispatch numbers are respectively delimited with a “+”.

Example: DHL;Paket1+DHL;Paket2+GLS;Paket9

Caution: The shortcodes for providers are to coordinate with RatePAY!

Account

ans..10

O

Account identification to use separate logins (SubShops).

EventToken

a..2

M

„A“ for authorization

CompanyName

ans..100

C

Company name, obligatory for B2B

VatID

ans..25

C

VAT-ID, obligatory for B2B

CompanyID

ans..50

O

Register of Companies number

LegalForm

ans..100

O

Legal form. The value to be transmitted must be coordinated with RatePAY!

RegistryLocation

ans..255

O

Company's principal office

Homepage

ans..255

O

Homepage of the company

sdFirstName

ans..100

O

First name of the custumer

sdLastName

ans..100

O

Last name of the customer

sdStreet

ans..100

O

Street name and house number

sdStreetHouseNumber

ans..10

O

Street number

sdStreetAddition

ans..50

O

Addition in the delivery address

sdZIP

ans..10

O

Postcode

sdCity

ans..255

O

City

sdCountryCode

a2

O

Two characters country code according to ISO 3166

sdPhone

ns..32

O

Customer’s phone number

bdFirstName

ans..100

M

First name of the custumer

bdLastName

ans..100

M

Last name of the customer

bdCompanyName

ans..100

O

Name of company

bdStreet

ans..50

M

Street name in the invoicing address

bdStreetNr

ans..10

M

Street number of the invoicing address

bdStreetAddition

ans..50

O

Address addition in the billing address

bdZIP

ans..10

M

Postcode in the invoicing address

bdCity

ans..255

M

Town/city of the invoicing address

bdCountryCode

a2

M

Country code for the invoicing address, 2 characters according to ISO 3166

bdPhone

ns..32

M

Customer’s phone number

FirstName

ans..100

O

First name

LastName

ans..100

O

Last name

AddrStreet

ans..50

C

Street. Mandatory if B2B (CompanyName is given)

AddrStreetNr

ans..10

C

Street number. Mandatory if B2B (CompanyName is given)

AddressAddition

ans..50

O

Address c/o

AddrZip

ans..10

C

Postcode. Mandatory if B2B (CompanyName is given)

AddrCity

ans..32

C

City. Mandatory if B2B (CompanyName is given)

AddrCountryCode

a2

C

Two characters country code according to ISO 3166. Mandatory if B2B (CompanyName is given)

IPAddr

ans..15

M

With the transferred IP address Paygate can determine in which country and in which town your customer has connected with the Internet (see also IPZone). Format: 123,456,789,012

DeviceToken

ans..100

O

Device token, see external documentation from RatePAY

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

INIT 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

ans..30

O

Merchant’s unique reference number

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

ExternalMessage

ans..256

O

Error text from RatePAY, if agreed with Computop support

ExternalCode

ans..64

O

Error code from RatePAY, if agreed with Computop support

Installment

a..5

O

For IBS: True / False, if installment is allowed

Prepayment

a..5

O

For IBS: True / False, if prepayment is allowed

Invoice

a..5

O

For IBS: True / False, if invoice is allowed

ELV

a..5

O

For IBS: True / False, if ELV is allowed

RPTransID

ans..50

M

Unique reference number from RatePAY

https://paymentpage.axepta.bnpparibas/ratepay.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, e.g. for referencing in batch files.

TransID

ans..64

M

TransactionID which should be unique for each payment

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

MAC

an64

M

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

Month

ans..255

C

Duration in months. Obligatory for EventToken RT

Rate

n..8

C

Monthly instalment in the smallest currency unit. Obligatory for EventToken RR

FirstDay

n..2

O

Calendar day of first payment.

Possible values are 1,15,28. Default value = 28.

StartDate

dttm8

O

Start date of instalment payment in the format YYYYMMDD

DueDate

dttm8

O

Due date in the format YYYYMMDD

InterestRate

n..5

O

Debit interest rate, e.g. 1370 for 13,70%

EventToken

a..2

M

A for authorization

Account

ans..10

O

Account identification to use separate logins (SubShops).

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

INIT 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

ans..30

O

Merchant’s unique reference number

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

ExternalMessage

ans..256

O

Error text from RatePAY, if agreed with Computop support

ExternalCode

ans..64

O

Error code from RatePAY, if agreed with Computop support

TotalAmount

n..10

M

Total amount to be finances amount in the smallest currency unit

InterestAmount

n..10

M

Sum of all monthly instalments in the smallest currency unit

ServiceCharge

n..10

M

Additional financing costs in the smallest currency unit

InterestRate

n..5

M

Debit interest rate, e.g. 1370 for 13,70%

AnnualPercentageRate

n..5

M

Annual interest based on ServiceCharge and InterestRate

MonthlyDebitInterest

n..5

M

Monthly debit interest based on AnnualPercentageRate

InstallmentNumber

n..2

M

Number of monthly instalments

InstallmentAmount

n..10

M

Monthly amount payable in the smallest currency unit

InstallmentLastAmount

n..10

M

Amount of the last rate in the smallest currency unit

FirstDay

n..2

O

Calendar day of first payment.

Possible values are 1,15,28. Default value = 28.

https://paymentpage.axepta.bnpparibas/ratepay.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, e.g. for referencing of batch files.

TransID

ans..64

M

TransactionID which should be unique for each payment

MAC

an64

M

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

Account

ans..10

O

Account identification to use separate logins (SubShops).

EventToken

a..2

M

RC for Rateconfiguration

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

TransactionID which should be unique for each payment

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)

MinRate

n..2

O

Minimum number of instalments

DefaultRate

n..12

O

Default rate in the smallest currency unit

MaxInterestRate

n..5

O

Maximum interest rate

MinMonth

n..2

O

Minimum running time in months

MaxMonth

n..2

O

Maximum running time in months

MonthLongrun

n..2

O

Minimum running time for a long time financing

MonthAllowed

ans..50

O

Comma-separated list of permissible running times in months

FirstDay

ans..20

O

Comma-separated list of permissible start days (1,15,28)

LastRate

n..10

O

Minimum amount for the final instalment in the smallest currency unit

MinRateNormal

n..10

O

Minimum rate in the smallest currency unit

MinRateLongrun

n..10

O

Minimum rate for a long term financing in the smallest currency unit

ServiceCharge

n..10

O

Additional financing costs in the smallest currency unit

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

ExternalMessage

ans..256

O

Error text from RatePAY, if agreed with Computop support

ExternalCode

ans..64

O

Error code from RatePAY, if agreed with Computop support

https://paymentpage.axepta.bnpparibas/ratepay.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, e.g. for referencing in batch files.

TransID

ans..64

M

TransactionID which should be unique for each payment

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

MAC

an64

O

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

RPMethod

ans..10

M

Type of payment: INVOICE, INSTALLMENT or ELV

ShoppingBasketAmount

n..10

M

Total value of shopping basket in smallest currency unit (less discount, incl. shipment etc.)

TrackingID

ans..100

O

List of shipment service providers with associated parcel number

Format: SERVICE PROVIDER; PACKAGE NUMBER

Example: DHL;Paket1

Other service providers/dispatch numbers are respectively delimited with a “+”.

Example: DHL;Paket1+DHL;Paket2+GLS;Paket9

Caution: The shortcodes for providers are to coordinate with RatePAY!

MaxRisk

n..2

O

Maximum permitted risk class (1-10)

Account

ans..10

O

Account identification to use separate logins (SubShops).

DeviceToken

ans..100

O

Device token, see external documentation from RatePAY

DeliveryDate

dttm8

O

Delivery date in the format YYYYMMDD

ShopSystem

ans..127

O

Name of the shop system

ShopSystemVersion

ans..127

O

Version name of the shop system

EventToken

a..2

M

R for RateInit

AccOwner

ans..55

C

Name of account holder. Mandatory for direct debit.

AccIBAN

ans..34

C

International Bank Account Number. Mandatory for direct debit.

BIC

ans11

C

Bank Identifier Code. Mandatory for direct debit.

AccBank

ans..27

O

Name of the financial institution

DebitPayType

a2

C

Type of payment. Mandatory for direct debit.

BT = BankTransfer ; DD = DirectDebit

InvoiceID

ans..50

C

Invoice number. Mandatory for invocie.

InvoiceDate

dttm8

C

Invoice date. Mandatory for invocie.

DueDate

dttm8

C

Due date. Mandatory for invocie.

InterestRate

n..5

C

Reference interest rate (value is taken from the instalment calculator). Mandatory for installment.

InstallmentNumber

n..12

C

Number of monthly instalments (value is taken from the instalment calculator). Mandatory for installment.

InstallmentAmount

n..10

C

Amount payable monthly (value is taken from the instalment calculator). Mandatory for installment.

InstallmentLastAmount

n..10

C

Amount of final instalment (value is taken from the instalment calculator). Mandatory for installment.

FirstDay

n..2

O

Calendar day of first payment.

Possible values are 1,15,28. Default value = 28.

TotalAmount

n..10

C

Total amount to be financed. Mandatory for installment.

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

TransactionID which should be unique for each payment

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)

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

ExternalMessage

ans..256

O

Error text from RatePAY, if agreed with Computop support

ExternalCode

ans..64

O

Error code from RatePAY, if agreed with Computop support

https://paymentpage.axepta.bnpparibas/ratepay.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, e.g. for referencing in batch files.

TransID

ans..64

M

TransactionID which should be unique for each payment

MAC

an64

O

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

Account

ans..10

O

Account identification to use separate logins (SubShops).

EventToken

a..2

M

V for verify

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

TransactionID which should be unique for each payment

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)

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

ExternalMessage

ans..256

O

Error text from RatePAY, if agreed with Computop support

ExternalCode

ans..64

O

Error code from RatePAY, if agreed with Computop support

https://paymentpage.axepta.bnpparibas/ratepay.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, e.g. for referencing in batch files

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

an64

O

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

ShoppingBasket

ans..1024

M

Shopping cart with items to be posted (structure - see ShoppingBasket table)

ShoppingBasketAmount

n..10

M

Total value of the present shopping basket in smallest currency unit (less discount, incl. shipment etc.)

Discount

ans..100

O

Trans-shopping cart discount

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Discount;1000;1900

ShippingProfile

ans..100

O

Shipping costs

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Shipment;500;1900

Account

ans..10

O

Account identification to use separate logins (SubShops).

InvoiceID

ans..50

=

Invoice number

TrackingID

ans..100

O

List of shipment service providers with associated parcel number

Format: SERVICE PROVIDER; PACKAGE NUMBER

Example: DHL;Paket1

Other service providers/dispatch numbers are respectively delimited with a “+”.

Example: DHL;Paket1+DHL;Paket2+GLS;Paket9

Caution: The shortcodes for providers are to coordinate with RatePAY!

ShopSystem

ans..127

O

Name of the shop system

ShopSystemVersion

ans..127

O

Version name of the shop system

EventToken

a..2

M

C for capture

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

TransactionID which should be unique for each payment

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)

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

ExternalMessage

ans..256

O

Error text from RatePAY, if agreed with Computop support

ExternalCode

ans..64

O

Error code from RatePAY, if agreed with Computop support

https://paymentpage.axepta.bnpparibas/ratepay.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, e.g. for referencing in batch files

TransID

ans..64

M

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

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

MAC

an64

O

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

ShoppingBasket

ans..1024

M

Shopping cart with items to be cancelled (structure - see ShoppingBasket table)

ShoppingBasketAmount

n..10

M

Total value of the present shopping basket in smallest currency unit (less discount, incl. shipment etc.)

Discount

ans..100

O

Trans-shopping cart discount

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Discount;1000;1900

ShippingProfile

ans..100

O

Shipping costs

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Shipment;500;1900

Account

ans..10

O

Account identification to use separate logins (SubShops).

ShopSystem

ans..127

O

Name of the shop system

ShopSystemVersion

ans..127

O

Version name of the shop system

EventToken

a..2

M

FC for full-cancellation

PC for partial-cancellation

CO for change-order

FR for full-return

PR for partial-return

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

TransactionID which should be unique for each payment

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)

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

ExternalMessage

ans..256

O

Error text from RatePAY, if agreed with Computop support

ExternalCode

ans..64

O

Error code from RatePAY, if agreed with Computop support

https://paymentpage.axepta.bnpparibas/ratepay.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, e.g. for referencing in batch files

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

MAC

an64

O

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

ShoppingBasket

ans..1024

M

Shopping cart with a “CREDIT” item (structure - see ShoppingBasket table)

ShoppingBasketAmount

n..10

M

Total value of the present shopping basket in smallest currency unit (less discount, incl. shipment etc.)

Discount

ans..100

O

Trans-shopping cart discount

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Discount;1000;1900

ShippingProfile

ans..100

O

Shipping costs

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Shipment;500;1900

Account

ans..10

O

Account identification to use separate logins (SubShops).

ShopSystem

ans..127

O

Name of the shop system

ShopSystemVersion

ans..127

O

Version name of the shop system

EventToken

a..2

M

CR for Credit

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

TransactionID which should be unique for each payment

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)

InfoText

ans..1024

O

Contains an infotext which can be forwarded to the customer (e.g. at refusal)

ExternalMessage

ans..256

O

Error text from RatePAY, if agreed with Computop support

ExternalCode

ans..64

O

Error code from RatePAY, if agreed with Computop support

ArtNr

ans..255

C

Unique article number. Each item in the shopping cart must be clearly identifiable. Either via ArtNr or a combination of ArtNr and UniqueArticleNumber.

Quantity

n..12

M

Quantity

Category

n..2

O

Article category (as agreed with RatePAY)

Item

ans..255

M

Article description

UnitPriceGross

n..12

M

Unit price gross in smallest currency unit

TaxRate

n..5

M

VAT rate with 2 decimal places, e.g. 1900 for 19%

UniqueArticleNumber

ans..50

C

Unique article number. Each item in the shopping cart must be clearly identifiable. Either via ArtNr or a combination of ArtNr and UniqueArticleNumber.

Discount

n..12

O

Article-specific discount in smallest currency unit

DescriptionAddition

ans..511

O

Additional text for further description. Can be used in communication between RatePAY and the end customer.

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)

1.1.2 / 2.1.2

with discount and shipping

Change

1.0 / 2.0

Standard version without return of parameter Code

1.x / 2x.

with RefNr (valid for all versions other than 1.0)

1.1.2 / 2.1.2

with discount and shipping

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

RatePay,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ShoppingBasket>,<ShoppingBasketAmount>,<EventToken>,<RPMethod>(,<Discount>,<Shipping>)

RatePay,Change,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ShoppingBasket>,<ShoppingBasketAmount>,<EventToken>,<RPMethod>(,<Discount>,<Shipping>)

FOOT,<CountRecords>,<SumAmount>

Type

a..11

M

HEAD for Header, FOOT for Footer, RatePay for the transactions

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Change (credit / change)

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

TransID

ans..64

M

TransactionID which should be unique for each payment

RefNr

ans..30

O

Unique reference number

PayID

an32

M

ID for this transaction given by Paygate

ShoppingBasket

ans..1024

M

Shopping basket (for structure see table ShoppingBasket)

ShoppingBasketAmount

n..12

M

Total value of the present shopping basket in smallest currency unit (less discount, incl. shipment etc.)

EventToken

a..2

M

R for RateInit

CR for Credit

FC for full-cancellation

PC for partial-cancellation

CO for change-order

FR for full-return

PR for partial-return

RPMethod

ans..10

C

Type of payment: INVOICE, INSTALLMENT or ELV. Is not needed for capture!

Discount

ans..100

O

Trans-shopping cart discount

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Discount;1000;1900

ShippingProfile

ans..100

O

Shipping costs

Format: DESCRIPTION; GROSS AMOUNT; VAT

Example: Shipment;500;1900

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

RatePay,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ShoppingBasket>,<ShoppingBasketAmount>,<EventToken>,<RPMethod>(,<Discount>,<Shipping>),<Status>,<Code>

RatePay,Change,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<ShoppingBasket>,<ShoppingBasketAmount>,<EventToken>,<RPMethod>(,<Discount>,<Shipping>),<Status>,<Code>

FOOT,<CountRecords>,<SumAmount>

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Change (credit / change)

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)