• DeutschEnglish

CB2A - Payment upon Shipment

Scenario – Payment upon Shipment

  • You offer your customers payment by credit card based on payment upon shipment

  • Customers agrees (authenticates) a total amount, but the amount is not reserved at the time of order

  • With each shipment you will create a new authorization based on the initial authentication referring to the initial payment. By this card data and 3DS data are automatically taken from the initial payment.

Request / Response - initial payment via PaySSL / PayNow

Request Elements

Notice: For security reasons, Computop 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:

PayID in request always refers to initial Payment created with PaySSL or PayNow

PayID in response is the new payment process created for the subsequent installent payment created

KeyFormatCNDDescription

MerchantID

ans..30

M

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

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

delayedshipment

an

M

Set "delayedshipment=initial" to indicate initial payment

AccVerify

an

M

Set "AccVerify=yes" to indicate initial payment:

  • amount is authenticated

  • amount is automatically set to 0 Euro for authorization, i.e. card is verified, but not debited

RefNr

an12

O

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data.

Notes:

  • CB2A requires

    • fixed length of 12 characters, Paygate automatically align value to the right and add "0" (zero) to the left

    • only characters (A..Z, a..z) and digits (0..9) are allowed, no characters like underscore, minus, ...

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Capture

an..6

OM

Determines the type and time of capture.

Capture Mode

Description

AUTO

Capturing immediately after authorisation (default value).

MANUAL

Capturing made by the merchant. Capture is normally initiated at time of delivery.

<Number>

Delay in hours until the capture (whole number; 1 to 696).

UserData

ans..1024

O

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

MAC

an64

M

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

Response Elements

The following table describes the result parameters with which the Computop Paygate responds to your system

pls. be prepared to receive additional parameters at any time and do not check the order of parameters

the key (e.g. MerchantId, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

XID

an32

M

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

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

RefNr

O

Reference number as given in request

Status

a..20

M

Status of the transaction.

Values accepted:

  • AUTHORIZED

  • 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

an8

M

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

UserData

ans..1024

O

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

Request / Response - subsequent payment via direct.aspx

Request Elements

Notice: For security reasons, Computop 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:

subsequent payments are initiated on time of shipment

Provide PayID in request from initial Payment

PayID in response is the new payment process created for the subsequent payment created

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the initial payment. This PayID needs to be used for subsequent payments.

ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

industrySpecificTxType

an

M

Set "industrySpecificTxType=Reauthorization" to indicate subsequent payment

RefNr

an12

O

Merchant’s unique reference number, which serves as payout reference in the acquirer EPA file. Please note, without the own shop reference delivery you cannot read out the EPA transaction and regarding the additional Computop settlement file (CTSF) we cannot add the additional payment data.

Notes:

  • CB2A requires

    • fixed length of 12 characters, Paygate automatically align value to the right and add "0" (zero) to the left

    • only characters (A..Z, a..z) and digits (0..9) are allowed, no characters like underscore, minus, ...

    • RefNr is mandatory in case of "pre-authorization" by CB2A ( a MerchantID can be setup on Paygate either to handle "authorization" or "pre-authorization")

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

Capture

an..6

OM

Determines the type and time of capture.

Capture Mode

Description

AUTO

Capturing immediately after authorisation (default value).

MANUAL

Capturing made by the merchant. Capture is normally initiated at time of delivery.

<Number>

Delay in hours until the capture (whole number; 1 to 696).

UserData

ans..1024

O

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

MAC

an64

M

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

Response Elements

The following table describes the result parameters with which the Computop Paygate responds to your system

pls. be prepared to receive additional parameters at any time and do not check the order of parameters

the key (e.g. MerchantId, RefNr) should not be checked case-sentive

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

XID

an32

M

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

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

RefNr

O

Reference number as given in request

Status

a..20

M

Status of the transaction.

Values accepted:

  • AUTHORIZED

  • 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

an8

M

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

UserData

ans..1024

O

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

Paygate

Documentation (EN)

Dokumentation (DE)

Paygate Status