Authorization
Name | Description |
AfterPayOrder | Order Object |
AfterPayB2Corder | B2C order details, extends an AfterPayOrder |
AfterPayB2Border | B2B order details, extends an AfterPayOrder |
B2CAddress | Address object B2C, used in AfterPayB2Corder |
ReferencePerson | Reference person, used in B2CAddress |
Orderlines | Order line array, used in AfterPayOrder |
ExtraFields | Can contain additional values, used in AfterPayOrder |
Shopdetails | Shop details, used in AfterPayOrder |
Shopper | Consumer details, used in AfterPayOrder |
B2BAddress | Address object B2B, used in AfterPayB2Border |
Company | Company details used in AfterPayOrder |
Person | Person details, used in AfterPayOrder |
AfterPayOrder
Field name | Data type | Description | Mandatory | Validation |
Ordernumber | String | Order ID of the webshop. Must be unique per portfolio | YES | Unique per ‘Portfolio’. Max. 36 characters, min. 2 characters. Only A-Z,a-z 0-9 and _- are allowed. For Germany max 20 chars long. |
parentTransactionreference | String | Transaction reference of the PSP/Intermediate party. Can be used as a key for future changes on the order. | NO | Min 3 chars. Max 25 chars. A-Z,a-z 0-9Transaction reference (of the Payment Servive Provider)
Should be unique in portfolio. |
bankID | String | ID of the bank | NO | ID or name of the bank (NOT USED YET) |
Bankaccountnumber | String | NO (only mandatory for direct debit) | Numbers are allowed. May contain 9 or 10 digits. Are validated on format (Dutch 11-proef of banks) | |
currency | String | ISO 4217 Currency Codes | YES | Currently available
|
exchangeDate | Date | Date of exchange rate | NO | |
exchangeRate | Double | Exchange rate at given exchangeDate | NO | F.e. 1 CHF = 0,91383 EUROMust be formatted as: 0,91333 |
ipAddress | String | IP Address of consumer | YES | valid ipv4 or ipv6 address |
totalOrderAmount | Integer | Total order amount including vat | YES | Amount in euro cents |
totalOrderNetAmount | Double | Amount excluding vat. Only use when billing should be done excluding vat. Only use in collaboration with AfterPay business solutions | NO | Amount in euro cents with 2 decimals. Example 10010,20 for: 100,1020) |
orderlines | OrderLine{} | Orderline array | YES | If a webshop has no order lines deliver 1 standard order line with the description “Uw bestelling bij: (followed by the webshop name)” |
extrafields | ExtraFields{} | Extra fields for additional data | NO | |
Shopdetails | Shopdetails | Shop details object | NO | |
shopper | Shopper | Shopper object | NO |
B2Corder
Field name | Data type | Description |
b2cbilltoAddress | B2CAddress | b2cbilltoadress extends the standard address object |
b2cshiptoAddress | B2CAddress | b2cshiptoadress extends the standard address object |
B2Border
Field name | Datatype | Description |
b2bbilltoAddress | B2BAddress | b2bbilltoadress extends the standard address object |
b2bshiptoAddress | B2BAddress | b2bshiptoadress extends the standard address object |
company | Company | Object company contains company details |
costcenter | String | (Optional) contains order costcenter |
B2Caddress
Field name | Data type | Description | Mandatory | Validation |
city | String | City | YES | Max 150 characters |
Housenumber | String | House number | YES | May include house number addition, will be separated automatically. (unless Housenumberaddition field is used) |
Housenumberaddition | String | House number addition | NO | Max 6 characters |
isoCountryCode | String | Country code ISO 3166-1 (2 letterig) | YES | ISO format 2 characters (NL,DE,BE) |
Postalcode | String | Postalcode | YES | NL: ‘CCCCLL’ BE: ‘CCCC’ |
Region | String | Region | NO | – |
referencePerson | referencePerson | Consumer information | YES | |
Streetname | String | Streetname | YES | Max 45 characters |
ReferencePerson
Field name | Data type | Description | Mandatory | Validation |
dateofbirth | DateTime | Date of birth customer | YES | Date time format ( 1980-12-12T00:00:00). For B2B prefill with: (1970-01-01T00:00:00) |
emailaddress | String | Email address | YES | Max 45 characters |
gender | String | Gender | B2C:YES B2B:NO |
B2C: M (Male) / V (Female) B2B: send empty field |
initials | String | Initials | YES | |
isoLanguage | String | Consumer Language | YES | ISO language code.(supported at this moment: NL, DE, NL-BE, FR-BE) |
lastname | String | Consumer Last name | YES | [a-z,0-9], no control characters |
phonenumber1 | String | Consumer phone number can be mobile or landline | YES | Prefix allowed:( ) allowed
NL: +31/0031/31 BE: +32/0032/32 |
phonenumber2 | String | Consumer phone number can be mobile or landline | NO | Prefix allowed:( ) allowed
NL: +31/0031/31 BE: +32/0032/32 |
prefix | String | In to | NO | String max 10 characters. |
title | String | Consumer title | NO | String max 20 characters. |
Orderlines
Field name | Data type | Description | Mandatory | Validation |
articleDescription | String | Description | YES | Numbers are allowed.Max 45 characters. Special characters like ^, ` etc are automatically filtered out. |
articleID | String | Article number | YES | Max 25 characters. |
netunitprice | Double | Price excluding vat | NO | Amount is in euro cents with 2 decimals. Example 10010,20 for: 100,1020) Only use this setting if AfterPay agrees with it! |
quantity | Integer | Article Quanty | YES | Integer values > 0 Maximum value is 2147483647 |
unitprice | Integer | Unit price including vat | YES | Amount is in euro cents. No decimals allowed. |
vatcategory | Integer | Vat category | YES | 1:High, 2:Low, 3:Zero, 4:None, 5:Middle |
ExtraFields
Field name | Data type | Description | Mandatory | Validation |
nameField | String | Name variable | YES | Name variable |
valueField | String | Value variable | YES | Value variable |
Shopdetails
Field name | Data type | Description | Mandatory | Validation |
afterpaypluginsupplier | String | Name is given by AfterPay | NO | |
afterpayPluginVersion | String | Plug-in versio ID | NO | |
intermediarID | Integer | ID is given by AfterPay | NO | |
shopURL | String | URL of the webshop | NO | |
webshoplanguage | String | Programming language of the webshop | NO | |
webshopplatform | String | F.e. Magento, OScommerce | NO | |
webshopplatformversion | String | Webshop platform version | NO |
Shopper
Field name | Data type | Description | Mandatory | Validation |
afterPayId | String | Unique AfterPay ID | NO | [a-z,0-9], no control characters |
afterPayToken | String | Token | NO | [a-z,0-9], no control characters |
customerNumber | Integer | Customer number | NO | Customer ID from webshop. Min 4 integers |
finbox | Boolean | Does the customer use Finbox? | NO | Not used |
hasCustcard | Boolean | Has customer card? | NO | |
HasPayments | Boolean | Has positive payment history | NO | |
profileCreated | DateTime | Date time of account creation | YES | Date time formaat ( 1980-12-12T00:00:00) |
referString | String | Reference of shopper entry. Used to recognize affiliate networks | NO | |
Fingerprint | String | Fingerprint on the basis of useragent + resolution For more information please contac AfterPay business solutions | NO | MD5 String |
B2BAddress
Field name | Data type | Description | Mandatory | Validation |
city | String | City | YES | Max 150 characters |
Housenumber | String | House number | YES | May include house number addition, will be separated automatically. (unless Housenumberaddition field is used) |
Housenumberaddition | String | House number addition | NO | Max 6 characters |
isoCountryCode | String | Country code ISO 3166-1 (2 letterig) | YES | ISO format 2 characters (NL,DE,BE) |
Postalcode | String | Postalcode | YES | NL: ‘CCCCLL’ BE: ‘CCCC’ |
Region | String | Region | NO | – |
Streetname | String | Streetname | YES | Max 45 characters |
careof | String | Person that accepts the package | NO | [a-z,0-9], no control characters |
phone | String | Phone number | NO | [a-z,0-9], no control characters |
Company
Field name | Data type | Description | Mandatory | Validation |
cocnumber | String | Chamber of commerce number | YES | [a-z,0-9], no control characters |
companyname | String | Company name | YES | [a-z,0-9], no control characters |
department | String | Company department | NO | [a-z,0-9], no control characters |
establishmentnumber | String | Establishment number | NO | Always 12 digits |
vatnumber | String | VAT number | NO | [a-z,0-9], max. 14 characters |
Person
Field name | Data type | Description | Mandatory | Validation |
dateofbirth | DateTime | Date of birth customer | B2C:YES B2B:NO |
Date time format ( 1980-12-12T00:00:00). For B2B prefill with: (1970-01-01T00:00:00) |
emailaddress | String | Email address | YES | Max 45 characters |
gender | String | Gender | B2C:YES B2B:NO |
B2C: M (Male) / V (Female) B2B: send empty field |
initials | String | Initials | YES | |
isoLanguage | String | Consumer Language | YES | ISO language code.(supported at this moment: NL, DE, NL-BE, FR-BE) |
lastname | String | Consumer Last name | YES | [a-z,0-9], no control characters |
phonenumber1 | String | Consumer phone number can be mobile or landline | YES | Prefix allowed:( ) allowed
NL: +31/0031/31 BE: +32/0032/32 |
phonenumber2 | String | Consumer phone number can be mobile or landline | Prefix allowed:( ) allowed
NL: +31/0031/31 BE: +32/0032/32 |
|
prefix | String | In to | NO | String max 10 characters. |
title | String | Consumer title | NO | String max 20 characters. |