Page tree

Search

Skip to end of metadata
Go to start of metadata

About Afterpay

General information about Afterpay

Logo

Info

AfterPay offers purchase on account after delivery. Buyers can pay for articles in four simple instalments, without having to provide any additional information during the ordering process. There is no risk of fraud or payment default for the merchant. After a credit check, AfterPay assumes the entire end customer payment default risk for each transaction.

TypePayments by eWallet EN

Further information can be found on the website of AfterPay (https://www.afterpay.de/).

Process Flow Chart

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.


Query about available payment types (two-stage authorisation)

AfterPay differentiates between one-stage and two-stage authorisation.  One-stage authorisation is designed for merchants who only use the normal method of payment by invoice in their checkout. Two-stage authorisation permits, for a specific shopping basket, a query of the available payment types and a request for further information.

In order To process two-stage authorisation with AfterPay via server-to-server communication, please 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..18

M

TransactionID which should be unique for each payment

RefNr

ns..30

O

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

EventToken

a..19

M

The two-stage process is triggered by the transfer of "PAYMENTMETHODS".

bdCompanyOrPerson

a..7

O

Customer category

„Company“

„Person“ (default value)

SocialSecurityNumber

ans..16

C

Required: FI, NO, SE. Optional: AT, BE, CH, DE, DK, NL.

Social security number for a person in Sweden. Registration number in case of a company. This parameter is linked to the parameter bdCompanyOrPerson.

AddrCountryCode

a2

M

Country code

„NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”

AddrZip

ans..10

C

Postcode
When requesting available payment methods the following conditions apply:

Required: DE, DK, NL, NO

Optional: AT, BE, CH, FI, SE

AddrStreet

ans..80

C

Street name or packstation

When requesting available payment methods the following conditions apply:

Required: DE, DK, NL

Optional: AT, BE, CH, FI, NO, SE

AddrStreetNr

a..50

C

Street number or packstation number

When requesting available payment methods the following conditions apply:

Required: DK, NL

Optional: AT, BE, CH, DE, FI, NO, SE

AddrStreetNr2

ans..10

C

Street number addition

When requesting available payment methods the following conditions apply:

Required: DK, NL

Optional: AT, BE, CH, DE, FI, NO, SE

AddrCity

ans..100

C

City

When requesting available payment methods the following conditions apply:

Required: DE, DK, NL

Optional: AT, BE, CH, FI, NO, SE

FirstName

ans..50

O

First name

LastName

ans..50

O

Last name

CustomerID

ans..20

O

Unique customer number

Salutation

a..4

C

Salutation:

„Mr“

„Mrs“

„Miss“

Required: NL, BE

Optional: AT, BE, CH, DE, DK, FI, NO, SE

bdEmail

ans..100

C

E-mail address is optional for regular authorisation requests.

When requesting available payment methods the following conditions apply:

Required: AT, BE, CH, DE, FI, NL, SE

Optional: DK, NO

bdPhone

ns..20

O

Telephone number

bdMobileNo

ns..20

O

Mobile number

DateOfBirth

an10

O

Date of birth in the format YYYY-MM-DD. Not applicable to companies.

Required: AT, BE, CH, DK, NL

Optional: DE, FI, NO, SE

CustomerRisk

ans..1024

O

Risk-relevant data as JSON string in Base64 format (see JSON objects / CustomerRisk)

Merchants can conduct external risk checks and send this information to AfterPay.

Valid for AddrCountryCode = "DE"

Language

a2

O

Language: "NO", "SE", "FI", "DK”, "EN”, "DE”, "NL”, "FR” permitted

CompanyOrPerson

a..7

O

Customer category for delivery address:

„Company“

„Person“ (default value)

sdCountryCode

a2

O

Country code of the delivery address: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”

sdZip

ans..10

O

Postcode in the delivery address

sdStreet

ans..80

O

Street name or packstation of the delivery address

sdStreetNr

a..50

O

Street number or packstation number of the delivery address

sdStreetNr2

ans..10

O

Street number addition of the delivery address

sdCity

ans..100

O

Town/city of the delivery address

sdFirstName

ans..50

O

First name in the delivery address

sdLastName

ans..50

O

Last name in the delivery address

sdSalutation

a..4

O

Salutation in the delivery address

„Mr“

„Mrs“

„Miss“

Valid for AddrCountryCode = „DE“, „DK“,“NL“, „BE“, „AT“ or „CH“

Email

ans..100

O

E-mail address of the delivery address

Phone

ns..50

O

Phone number in the delivery address

MobileNo

ns..50

O

Mobile number of the delivery address

Order

ans..1024

M

Order information as JSON string in Base64 format.

See JSON object / Order

Parameters for payments with AfterPay


The following table describes the result parameters with which the Paygate responds 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..18

M

Merchant’s transaction number

RefNr

ns..30

O

Unique reference number

Status

a..50

M

AUTHORIZE_REQUEST 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 AfterPay, if agreed with Computop Support

ErrorText

ans..1024

O

Error text from AfterPay, if agreed with Computop Support

UserData

ans..1024

O

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

AllowedPayMethods

ans..1024

O

Permissible payment methods as JSON string in the Base64 format

(see JSON objects / AllowedPayMethods)

BillingAddress

ans..1024

O

If necessary corrected billing address as JSON string in the Base64 format

(see JSON objects / Address)

ShippingAddress

ans..1024

O

If necessary corrected shipping address as JSON string in the Base64 format

(see JSON objects / Address)

Result parameters for AfterPay


The second stage involves the transfer of the payment type and, if relevant, further information relating to the payment type.  The transfer of the customer and order data is no longer necessary as it has already been transferred in the first stage. 

The second stage is triggered by using 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, e.g. for referencing in batch files.

TransID

ans..18

M

TransactionID which should be unique for each payment

RefNr

ns..30

O

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

PayType

a..19

M

Payment method:

"Invoice" for Invoice
"Account" for flexible payment plan
"Installment" for payment by instalment
"ConsolidatedInvoice" for consolidated invoice

BIC

ans..11

O

Bank Identifier Code (valid for AddrCountryCode = “DE”)

IBAN

ans..34

O

International Bank Account Number (valid for AddrCountryCode = “DE”)

ProductNr

n..8

C

Profile number

Obligatory for PayType = "Account" or "Installment"

InvoiceDate

an10

O

Date of invoice in the format YYYY-MM-DD.

Only for PayType = "ConsolidatedInvoice"

Parameters for AfterPay


The following table describes the result parameters with which the Paygate responds 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..18

M

Merchant’s transaction number

RefNr

ns..30

O

Unique reference number

Status

a..50

M

AUTHORIZE_REQUEST 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 AfterPay, if agreed with Computop Support

ErrorText

ans..1024

O

Error text from AfterPay, if agreed with Computop Support

UserData

ans..1024

O

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

AllowedPayMethods

ans..1024

O

Permissible payment methods as JSON string in the Base64 format

(see JSON objects / AllowedPayMethods)

Result parameters for AfterPay



Calling the interface for one-stage authorisation

To process one-stage authorisation with AfterPay, 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..18

M

TransactionID which should be unique for each payment

RefNr

ns..30

O

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

PayType

a..19

M

Payment method:

"Invoice" for Invoice
"Account" for flexible payment plan
"Installment" for payment by instalment
"ConsolidatedInvoice" for consolidated invoice

BIC

ans..11

O

Bank Identifier Code (valid for AddrCountryCode = “DE”)

IBAN

ans..34

O

International Bank Account Number (valid for AddrCountryCode = “DE”)

ProductNr

n..8

C

Profile number

Obligatory for PayType = "Account" or "Installment"

InvoiceDate

an10

O

Date of invoice in the format YYYY-MM-DD.

Only for PayType = "ConsolidatedInvoice"

bdCompanyOrPerson

a..7

O

Customer category

„Company“

„Person“ (default value)

SocialSecurityNumber

ans..16

C

Required: FI, NO, SE. Optional: AT, BE, CH, DE, DK, NL.

Social security number for a person in Sweden. Registration number in case of a company. This parameter is linked to the parameter bdCompanyOrPerson.

AddrCountryCode

a2

M

Country code

„NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”

AddrZip

ans..10

C

Postcode

When requesting available payment methods the following conditions apply:

Required: DE, DK, NL, NO

Optional: AT, BE, CH, FI, SE

AddrStreet

ans..80

C

Street name or packstation

When requesting available payment methods the following conditions apply:

Required: DE, DK, NL

Optional: AT, BE, CH, FI, NO, SE

AddrStreetNr

a..50

C

Street number or packstation number

When requesting available payment methods the following conditions apply:

Required: DK, NL

Optional: AT, BE, CH, DE, FI, NO, SE

AddrStreetNr2

ans..10

C

Street number addition

When requesting available payment methods the following conditions apply:

Required: DK, NL

Optional: AT, BE, CH, DE, FI, NO, SE

AddrCity

ans..100

C

City

When requesting available payment methods the following conditions apply:

Required: DE, DK, NL

Optional: AT, BE, CH, FI, NO, SE

FirstName

ans..50

O

First name

LastName

ans..50

O

Last name

CustomerID

ans..20

O

Unique customer number

Salutation

a..4

O

Salutation:

„Mr“

„Mrs“

„Miss“

Required: NL, BE

Optional: AT, BE, CH, DE, DK, FI, NO, SE

bdEmail

ans..100

O

E-mail address is optional for regular authorisation requests.

When requesting available payment methods the following conditions apply:

Required: AT, BE, CH, DE, FI, NL, SE

Optional: DK, NO

bdPhone

ns..20

O

Telephone number

bdMobileNo

ns..20

O

Mobile number

DateOfBirth

an10

O

Date of birth in the format YYYY-MM-DD. Not applicable to companies.

Required: AT, BE, CH, DK, NL

Optional: DE, FI, NO, SE

CustomerRisk

ans..1024

O

Risk-relevant data as JSON string in Base64 format (see JSON objects / CustomerRisk)

Merchants can conduct external risk checks and send this information to AfterPay.

Valid for AddrCountryCode = "DE"

Language

a2

O

Language: "NO", "SE", "FI", "DK”, "EN”, "DE”, "NL”, "FR” permitted

CompanyOrPerson

a..7

O

Customer category for delivery address:

„Company“

„Person“ (default value)

sdCountryCode

a2

O

Country code of the delivery address: „NO“, „SE“, „FI“, „DK“, „DE“, „AT“, “CH”, “NL”, “BE”

sdZip

ans..10

O

Postcode in the delivery address

sdStreet

ans..80

O

Street name or packstation of the delivery address

sdStreetNr

a..50

O

Street number or packstation number of the delivery address

sdStreetNr2

ans..10

O

Street number addition of the delivery address

sdCity

ans..100

O

Town/city of the delivery address

sdFirstName

ans..50

O

First name in the delivery address

sdLastName

ans..50

O

Last name in the delivery address

sdSalutation

a..4

O

Salutation in the delivery address

„Mr“

„Mrs“

„Miss“

Valid for AddrCountryCode = „DE“, „DK“,“NL“, „BE“, „AT“ or „CH“

Email

ans..100

O

E-mail address of the delivery address

Phone

ns..50

O

Phone number in the delivery address

MobileNo

ns..50

O

Mobile number of the delivery address

Order

ans..1024

M

Order information as JSON string in Base64 format.

See JSON object / Order

Parameters for payments with AfterPay


The following table describes the result parameters with which the Paygate responds 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..18

M

Merchant’s transaction number

RefNr

ns..30

O

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

n..10

O

Error code from AfterPay, if agreed with Computop Support

ErrorText

ans..1024

O

Error text from AfterPay, if agreed with Computop Support

UserData

ans..1024

O

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

BillingAddress

ans..1024

O

If necessary corrected billing address as JSON string in the Base64 format

(see JSON objects / Address)

ShippingAddress

ans..1024

O

If necessary corrected shipping address as JSON string in the Base64 format

(see JSON objects / Address)

Result parameters for AfterPay



Capture

Captures are possible via a Server-to-Server connection. To carry out a Capture for AfterPay 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..18

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

RefNr

ns..30

O

Merchant’s unique reference number

MAC

an64

M

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

OrderDesc

ans..768

O

Description of purchased 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

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.

Order

ans..1024

C

Mandatory for partial capture or if order information have changed with the same total amount.

Order information as JSON string in Base64 format.

(see JSON objects / OrderSummary)

InvoiceNr

ans..30

O

In considered only if Order is also transferred.

Invoice number that is displayed within AfterPay portal. An order can contain more than one invoice.

ShippingData

ans..1024

O

In considered only if Order is also transferred.

Shipping information as JSON string in Base64 format.

(see JSON objects / ShippingData)

Parameters for AfterPay 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..18

M

Merchant’s transaction number

Status

a..50

M

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

M

Merchant’s unique reference number

UserData

ans..1024

O

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

InvoiceNumber

ans..30

O

Booking number: generated by merchant or, if not available, by AfterPay. Is necessary for partial credits.

CodeExt

n..10

O

Error code from AfterPay, if agreed with Computop Support

ErrorText

ans..128

O

Error message  from AfterPay, if agreed with Computop Support

Result parameters for AfterPay 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:


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

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.

RefNr

ns..30

O

Reference number (e.g. invoice number) which must be unique for each return shipment

UserData

ans..1024

O

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

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.

Order

ans..1024

C

Mandatory for partial credits

Order information as JSON string in Base64 format.

(see JSON objects / RefundOrder)

InvoiceNr

ans..30

C

Is considered only if Order is also transferred, but then it is mandatory.

Invoice number that should be credited. That is the invoice number which is contained in the capture response.

RefundType

enum

O

Type or credit: Possible values are "Refund“ and "Return"

Is necessary only for a full credit.

Parameters for credits of AfterPay 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..18

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

Code

n8

M

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

RefNr

ns..30

M

Merchant’s unique reference number

UserData

ans..1024

O

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

CodeExt

n..10

O

Error code from AfterPay, if agreed with Computop Support

ErrorText

ans..128

O

Error message  from AfterPay, if agreed with Computop Support

Result parameters for credits of AfterPay payments



Call of Paygate interface for reversals

Reversals are possible via a Server-to-Server connection. In order to reverse an AfterPay transaction, 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 reverted

TransID

ans..18

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

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

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.

Order

ans..1024

C

Mandatory for partial reversals

Order information as JSON string in Base64 format.

(see JSON objects / OrderSummary)

Parameters for reversals of AfterPay 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..18

M

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

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)

UserData

ans..1024

O

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

CodeExt

n..10

O

Error code from AfterPay, if agreed with Computop Support

ErrorText

ans..128

O

Error message  from AfterPay, if agreed with Computop Support

Result parameters for reversals of AfterPay payments



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 an AfterPay payment and information can be found within the response file about the payment status.

Notice: Please note that partial captures, partial credits and partial reversals for AfterPay are not possible with batch.

Following table gives an overview of all batch versions that are possible for a specific action and their specialities:

Action

Version

Description

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 an AfterPay payment in a Batch file to be submitted is as follows:

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

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

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

AFTERPAY,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, AFTERPAY for AfterPay

Action

a..20

M

The parameter Action defines the type of transaction:

Capture

Credit

Reverse (cancellation)

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

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

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>

AFTERPAY,Capture,<Amount>,<Currency>,<TransID>,(<RefNr>,)<PayID>,<Status>,<Code>

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

AFTERPAY,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:

Capture

Credit

Reverse (cancellation)

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



JSON Objects

The JavaScript Object Notation, JSON for short, is a compact data format in an easy-to-read text format for the purpose of exchanging data between applications.  JSON does not depend on the programming language.  Parsers exist in practically all widely used languages. You can find more information about JSON via this link:

 

The next section describes JSON objects which are required for requests or returned in the response.

Notice: The JSON string can include special characters and so must also be Base64 encoded. Transfer problems may otherwise occur.

CustomerRisk

Risk-relevant data about the customer. Merchants can conduct external risk checks and send this information to AfterPay.

Parameter

Format

CND

Description

existingCustomer

bool

O

Indicates whether the customer is an existing customer of the merchant

verifiedCustomerIdentification

bool

O

Indicates whether the customer has been verified

marketingOptIn

bool

O

Indicates whether marketing material is requested

customerSince

dttm

O

Date in format YYYY-MM-DD since which the customer has existed

customerClassification

ans..32

O

Customer classification

acquisitionChannel

enum

O

Indicates the channel via which the merchant is reached. Possible values: „NotSet“, „Advertisment“, „SocialNetwork“, „Direct“, „SearchEngine“, “Other”

hasCustomerCard

bool

O

Indicates whether the customer has a loyalty card

customerCardSince

dttm

O

Date in format YYYY-MM-DD since which the loyalty card has existed

customerCardClassification

ans..32

O

Indicates the loyalty card level, e.g. "Gold Member"

profileTrackingId

ans..64

O

Unique TrackingID

ipAddress

ans..15

O

Customer´s IP address

numberOfTransactions

n..5

O

Number of successful transactions already completed by the customer

customerIndividualScore

n..5

O

Individual score for the customer supplied by the merchant

 

Example CustomerRisk as JSON string

{

      "existingCustomer" : true,

      "verifiedCustomerIdentification" : "true",

      "marketingOptIn" : "false",

      "customerSince" : "2015-11-20",

      "customerClassification" : "Classification",

      "acquisitionChannel" : “SearchEngine”,

      "hasCustomerCard" : true,

      "customerCardSince" : "2016-01-23",

      "customerCardClassification" : "Gold Member",

      "profileTrackingId" : "TrackingID123456",

      "ipAddress" : "201.18.14.2",

      "numberOfTransactions" : 27,

      "customerIndividualScore" : 98

}

 

Order

The order information is defined here.

Parameter

Format

CND

Description

totalGrossAmount

ans..16

M

Gross order amount. Must equal the value of all items (grossUnitPrice * quantity).

Please note, that values has to be specified with “.” as decimal separator.

currency

enum

O

Currency: Possible values are „EUR“, „NOK“, „SEK“, „DKK“, „CHF“

items

Array

O

Array of OrderItems (see JSON objects / OrderItem)

totalNetAmount

ans..16

M

Net order amount

Please note, that values has to be specified with “.” as decimal separator.

imageUrl

ans..256

O

URL for order image. This image can be viewed on the invoice or next to the instal-ment payment in the AfterPay portal. Limited to 100-1280px.

googleAnalyticsUserId

ans..64

O

Google Analytics UserID

googleAnalyticsClientId

ans..64

O

Google Analytics ClientID

discountAmount

ans..16

O

Discount amount (only for statistical purposes)

Please note, that values has to be specified with “.” as decimal separator.

 

OrderItem

The order information is defined here.

Parameter

Format

CND

Description

productId

ans..64

M

Article number

description

ans..128

M

Article description

quantity

n..8

M

Article quantity

Decimal values, if agreed with Computop and AfterPay.

grossUnitPrice

ans..16

M

Gross price per article

Please note, that values has to be specified with “.” as decimal separator.

groupId

ans..64

O

GroupID

netUnitPrice

ans..16

M

Net price per article

Please note, that values has to be specified with “.” as decimal separator.

unitCode

ans..16

O

Unit (e.g. pieces, litres, kilograms, etc.)

vatCategory

enum

O

VAT category

Possible values: "HighCategory", "LowCategory", "NullCategory", "NoCategory", "MiddleCategory", "OtherCategory"

vatPercent

n..2

M

VAT in percent

vatAmount

ans..16

M

VAT as amount per item

Please note, that values has to be specified with “.” as decimal separator.

imageUrl

ans..256

O

URL for order image. This image can be viewed on the invoice or next to the instal-ment payment in the AfterPay portal. Limited to 100-1280px.

googleProductCategoryId

n..16

O

Google Product Category ID

googleProductCategory

ans..64

O

Google Product Category

merchantProductType

ans..64

O

Merchant category in addition to Google classification

lineNumber

n.3

O

The merchant can specify a line number for each article for sorting purposes

discountAmount

ans..16

O

Discount amount (only for statistical purposes)

Please note, that values has to be specified with “.” as decimal separator.

productUrl

ans..256

O

Article URL

marketPlaceSellerId

ans..64

O

ID of a specific market place

Example of Order as JSON string

{

       "totalGrossAmount" : 12.40,

       "totalNetAmount" : 10.43,

       "currency" : "EUR",

       "items" : [{

                    "productId" : "1",

                    "description" : "Tablet Black",

                    "grossUnitPrice" : 4.10,

                    "netUnitPrice" : 3.45,

                    "quantity" : 2.0,

                    "vatAmount" : 0.65,

                    "vatPercent" : 19.0                             

             }, {

                    "productId" : "2",

                    "description" : "MusicPlayer Black",

                    "grossUnitPrice" : 4.20,

                    "netUnitPrice" : 3.53,

                    "quantity" : 1.0,

                    "vatAmount" : 0.67,

                    "vatPercent" : 19.0

             }

       ]

}

AllowedPayMethods

The information about the allowed payment types is defined here in an array.

PaymentMethod

The article information is defined here.

Parameter

Format

CND

Description

type

enum

O

Available payment method

Possible values: "Invoice", "Account", "Installment", "Consolidatedinvoice"

account

AccountProduct

O

Account information (see JSON objects / AccountProduct)

directDebit

DirectDebitInfo

O

Direct-Debit information (see JSON objects / DirectDebitInfo)

campaigns

Array

O

Array of campaign information (see JSON objects / CampaignInfo)

Installment

InstallmentInfo

O

Instalment payment information (see JSON objects / InstallmentInfo)

AccountProduct

The AccountProduct information is defined here.

Parameter

Format

CND

Description

profileNo

n..32

M

Account profile number

DirectDebitInfo

The DirectDeBitInfo information is defined here.

Parameter

Format

CND

Description

Available

bool

O

Indicates whether DirectDebit is available.

CampaignInfo

The CampaignInfo information is defined here.

Parameter

Format

CND

Description

campaignNo

n..32

O

Campaign number

description

ans..128

O

Campaign description

InstallmentInfo

The InstallmentInfo information is defined here.

Parameter

Format

CND

Description

basketAmount

enum

O

Available payment method

Possible values: "Invoice", "Account", "Installment", "Consolidatedinvoice"

Please note, that values has to be specified with “.” as decimal separator.

numberOfInstallments

n..2

O

Number of instalments

installmentAmount

ans..16

O

Instalment amount for each month

Please note, that values has to be specified with “.” as decimal separator.

firstInstallmentAmount

ans..16

O

First instalment amount

Please note, that values has to be specified with “.” as decimal separator.

lastInstallmentAmount

ans..16

O

Final instalment amount

Please note, that values has to be specified with “.” as decimal separator.

interestRate

ans..16

O

Interest rate

effectiveInterestRate

ans..16

O

Effective interest rate

effectiveAnnualPercentageRate

ans..16

O

Effective annual percentage

totalInterestAmount

ans..16

O

Total interest rate

Please note, that values has to be specified with “.” as decimal separator.

startupFee

ans..16

O

Starting fee

monthlyFee

ans..16

O

Monthly fee

totalAmount

ans..16

O

Total amount

installmentProfileNumber

ans..16

O

Instalment profile number

readMore

ans..128

O

Further information about the instalment process

Example of AllowedPaymentMethods as JSON string

{

      "paymentMethods" : [{

                  "type" : "Invoice"

            }, {

                  "type" : "Invoice",

                  "directDebit" : {

                        "available" : true

                  }

            }

      ]

}

Address

The information about corrected billing address data is defined here in an array if necessary.

Parameter

Format

CND

Description

countryCode

enum

O

Country code

Possible values: "NO“, „SE“, „FI“, „DK“, „DE“, „AT“, „CH“, „NL“, „BE“

postalCode

ans..10

O

Postal code

postalPlace

ans..100

O

City

Street

ans..100

O

Street or packstation

streetNumber

ans..10

O

Street number or packstation  number

streetNumberAdditional

ans..10

O

Street number addition

careOf

ans..50

O

Responsible person for dispatch of shipment

Example of Address as JSON string

{

       [{

             "countryCode" : "DE",

             "postalCode" : "10405",

             "street" : "Prenzlauer Allee",

             "streetNumber" : 20

             "streetNumberAdditional" : "3. Stock",

             "postalPlace" : "Berlin",

             "addressType" : null,

             "careOf" : null

       }

      ]

}

OrderSummary

The OrderSummary information is defined here.

Parameter

Format

CND

Description

totalGrossAmount

ans..16

O

Gross order amount. Must equal the value of all items (grossUnitPrice * quantity).

Please note, that values has to be specified with “.” as decimal separator.

currency

enum

O

Currency. Possible values are „EUR“, „NOK“, „SEK“, „DKK“, „CHF“

items

Array

O

Array of OrderItems (see JSON objects / OrderItem)

totalNetAmount

ans..16

O

Net order amount

Please note, that values has to be specified with “.” as decimal separator.

imageUrl

ans..256

O

URL for order image. This image can be viewed on the invoice or next to the instal-ment payment in the AfterPay portal. Limited to 100-1280px.

googleAnalyticsUserId

ans..64

O

Google Analytics UserID

googleAnalyticsClientId

ans..64

O

Google Analytics ClientID

discountAmount

ans..16

O

Discount amount (only for statistical purposes)

Please note, that values has to be specified with “.” as decimal separator.

Example of OrderSummary as JSON string

{

      "totalGrossAmount" : 8.30,

      "currency" : "EUR",

      "items" : [{

                  "productId" : "1",

                  "description" : "Tablet Black",

                  "grossUnitPrice" : 4.10,

                  "quantity" : 1.0

            }, {

                  "productId" : "2",

                  "description" : "MusicPlayer Black",

                  "grossUnitPrice" : 4.20,

                  "quantity" : 1.0

            }

      ]

}

ShippingData

The information about dispatch is defined here in an array.

Parameter

Format

CND

Description

shippingDetails

Array

M

Array of shipping information (see JSON objects / Shipping-Details)

ShippingDetails

The ShippingDetails information is defined here.

Parameter

Format

CND

Description

type

enum

M

Dispatch type: Possible values are "Shipment", "Return"

shippingCompany

ans..64

M

Shipping company

trackingId

ans..64

M

Unique TrackingID

Example of ShippingData as JSON string

{

      "shippingDetails" : [{

                  "type" : "Shipment",

                  "shippingCompany" : "DHL",

                  "trackingId" : "234324234"

            }, {

                  "type" : "Shipment",

                  "shippingCompany" : "Hermes",

                  "trackingId" : "687654"

            }

      ]

}

RefundOrder

The information about the articles to be credited is defined here.

Parameter

Format

CND

Description

orderItems

Array

M

Array of articles to be credited (see JSON objects / RefundOrderItem)

RefundOrderItem

The RefundOrderItem information is defined here.

Parameter

Format

CND

Description

refundType

enum

M

Credit type: Possible values are "Refund“, "Return"

productId

ans..64

M

Article number

description

ans..128

M

Article description

quantity

n..8

M

Article quantity

Decimal values, if agreed with Computop and AfterPay.

grossUnitPrice

ans..16

M

Gross price per article

Please note, that values has to be specified with “.” as decimal separator.

groupId

ans..64

O

GroupID

netUnitPrice

ans..16

M

Net price per article

Please note, that values has to be specified with “.” as decimal separator.

unitCode

ans..16

O

Unit (e.g. pieces, litres, kilograms, etc.)

vatCategory

enum

O

VAT category

Possible values: "HighCategory", "LowCategory", "NullCategory", "NoCategory", "MiddleCategory", "OtherCategory"

vatPercent

n..2

M

VAT in percent

vatAmount

ans..16

M

VAT as amount per item

Please note, that values has to be specified with “.” as decimal separator.

imageUrl

ans..256

O

URL for order image. This image can be viewed on the invoice or next to the instal-ment payment in the AfterPay portal. Limited to 100-1280px.

googleProductCategoryId

n..16

O

Google Product Category ID

googleProductCategory

ans..64

O

Google Product Category

merchantProductType

ans..64

O

Merchant category in addition to Google classification

lineNumber

n.3

O

The merchant can specify a line number for each article for sorting purposes

discountAmount

ans..16

O

Discount amount (only for statistical purposes)

Please note, that values has to be specified with “.” as decimal separator.

productUrl

ans..256

O

Article URL

marketPlaceSellerId

ans..64

O

ID of a specific market place

Example of RefundOrder as JSON string

[

           {

                  "refundType" : "Return",

                  "productId" : "1",

                  "description" : "Tablet Black",

                  "quantity" : 1.0,

                  "grossUnitPrice" : 4.10,

                  "netUnitPrice" : 3.45,

                  "vatPercent" : 19.0,

                  "vatAmount" : 0.65

            }

           , {

                  "refundType" : "Return",

                  "productId" : "2",

                  "description" : "MusicPlayer Black",

                  "quantity" : 1.0,

                  "grossUnitPrice" : 4.20,

                  "netUnitPrice" : 3.53,

                  "vatPercent" : 19.0,

                  "vatAmount" : 0.67

            }

]