General
New Afterpay Service
This documentation describes Buckaroo's new Afterpay service and will be launched in Q2 2019. It is meant for merchants that have a new AfterPay contract with Buckaroo (and only Buckaroo), not a contract with both Buckaroo and AfterPay. If you are uncertain which situation applies to you or your customer, please contact your (customer's) account manager at Buckaroo for enquiry.
Afterpay
AfterPay provides the option for customers to pay afterwards using a digital invoice or by direct debit. The concept includes a review of the customer before overtaking the financial part of the transaction by AfterPay. This way the merchant does not hold any financial risk when offering the product to the customer. Customers in the following countries can use Afterpay by Buckaroo:
- The Netherlands
- Belgium
- Germany
- Austria
- Finland
A customer needs to accept Afterpay's legal terms in order to proceed with the order proces. These terms differ for each country:
- The Netherlands: https://documents.myafterpay.com/consumer-terms-conditions/nl_nl/
- Belgium: https://documents.myafterpay.com/consumer-terms-conditions/nl_be/ (Dutch) and https://documents.myafterpay.com/consumer-terms-conditions/fr_be/ (French)
- Germany: https://documents.myafterpay.com/consumer-terms-conditions/de_de/
- Austria: https://documents.myafterpay.com/consumer-terms-conditions/de_at/
- Finland: https://documents.myafterpay.com/consumer-terms-conditions/fi_fi/
So depending on the billing country of the customer, the correct link should be included in your checkout.
Minimum order amount
In order to perform a successful Afterpay order, it is required to provide a minimum order amount of 5 euro. Anything below that amount will result in a rejection. This only applies in live mode; in test mode any amount is acceptable.
The Afterpay service uses the service code: afterpay.
It supports the following actions: Pay, Refund, Authorize, Capture, CancelAuthorize
Pay
Performing this action results in a credit check of the customer with Afterpay. If succesful, an order will be created at Afterpay and they will sent an invoice to the customer for payment completion (which will be handled by Afterpay). Buckaroo only registers the transaction to confirm the order.
Request
JSON gateway request
Note: always make sure the AmountDebit equals the sum of the article amounts.
|
ClientIP
string
|
Required
This is a basic parameter. IP address of the customer. |
|
Invoice
string
|
Required
This is a basic parameter. Invoice/order number. May only contain alphanumeric characters, dashes and underscores. Max 19 characters. |
|
Description
string
|
Required
GroupType: Article. Article name/description. |
|
GrossUnitPrice
decimal
|
Required
GroupType: Article. Article price including VAT. |
|
VatPercentage
decimal
|
Required
GroupType: Article. VAT percentage on the article price. |
|
Quantity
string
|
Required
GroupType: Article. Article quantity. |
|
Identifier
string
|
Required
GroupType: Article. Article number/code. |
|
ImageUrl
string
|
GroupType: Article. URL for the image of this article. It will be turned into a thumbnail and displayed to the customer in MyAfterPay, on the invoice line next to the order item. The linked image must be a rectangle or square, width between 100 pixels and 1280 pixels. |
|
Url
string
|
GroupType: Article. URL to the article page. |
|
Type
string
|
GroupType: Article. Article type. Possible values: PhysicalArticle, DigitalArticle, Giftcard, Discount, ShippingFee, Surchargo, Info, ShippingFees. |
|
UnitCode
string
|
GroupType: Article. Unit in which the article is measured, such as pieces, liters, kilograms, etc. |
|
Category
string
|
Required
GroupType: BillingCustomer. Customer category of billing customer. Possible values: Person, Company. However, Company is currently not supported by Afterpay and therefore not usable at the moment. It is likely that it will be added in the (near) future. |
|
Salutation
string
|
GroupType: BillingCustomer. Required if Billing country is NL or BE. Gender of billing customer. Possible values: Mr, Mrs, Miss. |
|
FirstName
string
|
Required
GroupType: BillingCustomer. First name of billing customer. |
|
LastName
string
|
Required
GroupType: BillingCustomer. Last name of billing customer, prefix included. |
|
BirthDate
string
|
GroupType: BillingCustomer. Required if Billing country is NL or BE. Birth date of billing customer. Accepted formats: dd-mm-yyyy and yyyy-mm-dd. |
|
Street
string
|
Required
GroupType: BillingCustomer. Street of billing customer. |
|
StreetNumber
string
|
GroupType: BillingCustomer. Required if Billing country is NL or BE. House number of billing customer. |
|
StreetNumberAdditional
string
|
GroupType: BillingCustomer. House number suffix of billing customer. |
|
PostalCode
string
|
Required
GroupType: BillingCustomer. Postal code of billing customer. |
|
City
string
|
Required
GroupType: BillingCustomer. City of billing customer. |
|
Country
string
|
Required
GroupType: BillingCustomer. Country of billing customer. Possible values: NL, BE, DE, AT, FI. |
|
MobilePhone
string
|
GroupType: BillingCustomer. If Billing country is NL or BE, at least one phone number is required: either MobilePhone or Phone (landline). |
|
Phone
string
|
GroupType: BillingCustomer. If Billing country is NL or BE, at least one phone number is required: either MobilePhone or Phone (landline). |
|
Email
string
|
Required
GroupType: BillingCustomer. Email address of billing customer. |
|
CareOf
string
|
GroupType: BillingCustomer. Name of intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V. |
|
ConversationLanguage
string
|
GroupType: BillingCustomer. Conversation language of billing customer. Possible values: NL, FR, DE, FI. |
|
IdentificationNumber
string
|
GroupType: BillingCustomer. Required if Billing Country is Finland (FI). The customer’s national ID number, or the company’s registration number, depending on Category (Person or Company). Do not confuse with CustomerNumber. |
|
CustomerNumber
string
|
GroupType: BillingCustomer. The number you assign to the billing customer. |
|
Category
string
|
GroupType: ShippingCustomer. Required if ShippingCustomer information is provided. Customer category of shipping customer. Possible values: Person, Company. However, Company is currently not supported by Afterpay and therefore not useable at the moment. It is likely that it will be added in the (near) future. |
|
Salutation
string
|
GroupType: ShippingCustomer. Required if ShippingCustomer information is provided ánd shipping country is NL or BE. Gender of shipping customer. Possible values: Mr, Mrs, Miss. |
|
FirstName
string
|
GroupType: ShippingCustomer. Required if ShippingCustomer information is provided. First name of shipping customer. |
|
LastName
string
|
GroupType: ShippingCustomer. Required if ShippingCustomer information is provided. Street of shipping customer. |
|
BirthDate
string
|
GroupType: ShippingCustomer. Birth date of shipping customer. Accepted formats: dd-mm-yyyy and yyyy-mm-dd. |
|
Street
string
|
GroupType: ShippingCustomer. Required if ShippingCustomer information is provided. Street of shipping customer. |
|
StreetNumber
string
|
GroupType: ShippingCustomer. Required if ShippingCustomer information is provided ánd shipping country is NL or BE. House number of shipping customer. |
|
StreetNumberAdditional
string
|
GroupType: ShippingCustomer. House number suffix of shipping customer. |
|
PostalCode
string
|
GroupType: ShippingCustomer. Required if ShippingCustomer information is provided. Postal code of shipping customer. |
|
City
string
|
GroupType: ShippingCustomer. Required if ShippingCustomer information is provided. City of shipping customer. |
|
Country
string
|
GroupType: ShippingCustomer. Required if ShippingCustomer information is provided. Country of shipping customer. Possible values: Possible values: NL, BE, DE, AT, FI. If the value differs from the billing country, the request will be rejected by Afterpay. |
|
MobilePhone
string
|
GroupType: ShippingCustomer. Mobile phone of shipping customer. |
|
Phone
string
|
GroupType: ShippingCustomer. Phone number (landline) of shipping customer. |
|
Email
string
|
GroupType: ShippingCustomer. Email address of shipping customer. |
|
CareOf
string
|
GroupType: ShippingCustomer. Name of intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V. |
|
ConversationLanguage
string
|
GroupType: ShippingCustomer. Conversation language of shipping customer. Possible values: NL, FR, DE, FI. |
|
IdentificationNumber
string
|
GroupType: ShippingCustomer. The customer’s national ID number, or the company’s registration number, depending on Category (Person or Company). Do not confuse with CustomerNumber. |
|
CustomerNumber
string
|
GroupType: ShippingCustomer. The number you assign to the shipping customer. |
|
MerchantImageUrl
string
|
Image URL for the merchants brand. This image is shown at the top of the customer's order page in MyAfterPay. |
|
SummaryImageUrl
string
|
Currently does not do anything, but in the future, this might be used by AfterPay to show an image to the customer for the entire order. You can decide to send this in so that if/when AfterPay implements this, you will automatically use this feature. |
|
BankAccount
string
|
The customer's IBAN. Only required when the customer has to be invoiced through a SEPA Direct Debit and is only available for Dutch, German and Austrian consumers (BillingCustomerCountry NL, DE and AT). |
|
BankCode
string
|
The customer’s BIC. Can be used in conjunction with BankAccount, but not mandatory. Only available for Dutch, German and Austrian consumers (BillingCustomerCountry NL, DE and AT). |
JSON
{
"Currency": "EUR",
"AmountDebit": 10,
"Invoice": "testinvoice12345cv",
"ClientIP": {
"Type": 0,
"Address": "0.0.0.0"
},
"Services": {
"ServiceList": [
{
"Name": "afterpay",
"Action": "Pay",
"Parameters": [
{
"Name": "Description",
"GroupType": "Article",
"GroupID": "1",
"Value": "Blue Toy Car"
},
{
"Name": "GrossUnitPrice",
"GroupType": "Article",
"GroupID": "1",
"Value": "10.00"
},
{
"Name": "VatPercentage",
"GroupType": "Article",
"GroupID": "1",
"Value": "21"
},
{
"Name": "Quantity",
"GroupType": "Article",
"GroupID": "1",
"Value": "1"
},
{
"Name": "Identifier",
"GroupType": "Article",
"GroupID": "1",
"Value": "Articlenumber12345"
},
{
"Name": "ImageUrl",
"GroupType": "Article",
"GroupID": "1",
"Value": "https://www.buckaroo.nl/img/logo_menu.png"
},
{
"Name": "Url",
"GroupType": "Article",
"GroupID": "1",
"Value": "https://www.buckaroo.nl/"
},
{
"Name": "Type",
"GroupType": "Article",
"GroupID": "1",
"Value": "PhysicalArticle"
},
{
"Name": "UnitCode",
"GroupType": "Article",
"GroupID": "1",
"Value": "Pieces"
},
{
"Name": "Category",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "Person"
},
{
"Name": "Salutation",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "Mr"
},
{
"Name": "FirstName",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "Test"
},
{
"Name": "LastName",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "Acceptatie"
},
{
"Name": "BirthDate",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "01-01-1990"
},
{
"Name": "Street",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "Hoofdstraat"
},
{
"Name": "StreetNumber",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "90"
},
{
"Name": "StreetNumberAdditional",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "A"
},
{
"Name": "PostalCode",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "8441EE"
},
{
"Name": "City",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "Heerenveen"
},
{
"Name": "Country",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "NL"
},
{
"Name": "MobilePhone",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "0698765433"
},
{
"Name": "Phone",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "0109876543"
},
{
"Name": "Email",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "billingcustomer@buckaroo.nl"
},
{
"Name": "CareOf",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "John Smith"
},
{
"Name": "ConversationLanguage",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "NL"
},
{
"Name": "IdentificationNumber",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "IdNumber12345"
},
{
"Name": "CustomerNumber",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "CustomerNumber12345"
},
{
"Name": "Category",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "Person"
},
{
"Name": "Salutation",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "Miss"
},
{
"Name": "FirstName",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "Test"
},
{
"Name": "LastName",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "Aflever"
},
{
"Name": "BirthDate",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "02-02-1980"
},
{
"Name": "Street",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "Afleverstraat"
},
{
"Name": "StreetNumber",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "80"
},
{
"Name": "StreetNumberAdditional",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "B"
},
{
"Name": "PostalCode",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "7881ER"
},
{
"Name": "City",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "Leeuwarden"
},
{
"Name": "Country",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "NL"
},
{
"Name": "MobilePhone",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "0698765432"
},
{
"Name": "Phone",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "0209876543"
},
{
"Name": "Email",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "shippingcustomer@buckaroo.nl"
},
{
"Name": "CareOf",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "Martha Smith"
},
{
"Name": "ConversationLanguage",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "NL"
},
{
"Name": "IdentificationNumber",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "IdNumber12346"
},
{
"Name": "CustomerNumber",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "CustomerNumber12346"
},
{
"Name": "BankAccount",
"GroupType": "",
"GroupID": "",
"Value": "NL13TEST0123456789"
},
{
"Name": "BankCode",
"GroupType": "",
"GroupID": "",
"Value": "TESTNL2A"
},
{
"Name": "MerchantImageUrl",
"GroupType": "",
"GroupID": "",
"Value": "https://www.buckaroo.nl/img/logo_menu.png"
},
{
"Name": "SummaryImageUrl",
"GroupType": "",
"GroupID": "",
"Value": "https://www.buckaroo.nl/img/logo_menu.png"
}
]
}
]
}
}Response 200 Status: Ok 400 Status: Access denied 500 Status: Bad request
JSON Gateway response
Note: If a request is rejected (statuscode 690), then the reason is provided in Status->Subcode->Description and can be used to inform the customer.
JSON
{
"Key": "9A0F6A513A774A64AAC791C184F3XXXX",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S990",
"Description": "The request was successful."
},
"DateTime": "2019-03-13T11:56:35"
},
"RequiredAction": null,
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "testinvoice12345cv",
"ServiceCode": "afterpay",
"IsTest": true,
"Currency": "EUR",
"AmountDebit": 10,
"TransactionType": "C039",
"MutationType": 1,
"RelatedTransactions": null,
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": "Test Acceptatie",
"PayerHash": null,
"PaymentKey": "5931B473CF88479F9D8611231F79XXXX"
}Push
JSON push response
JSON
{
"Transaction": {
"Key": "9A0F6A513A774A64AAC791C184F3XXXX",
"Invoice": "testinvoice12345cv",
"ServiceCode": "afterpay",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S990",
"Description": "The request was successful."
},
"DateTime": "2019-03-13T11:56:35"
},
"IsTest": true,
"Order": null,
"Currency": "EUR",
"AmountDebit": 10,
"TransactionType": "C039",
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 1,
"RelatedTransactions": null,
"IsCancelable": false,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": "Test Acceptatie",
"PayerHash": null,
"PaymentKey": "5931B473CF88479F9D8611231F79XXXX"
}
}Authorize
Performing an Authorize action results in a credit check of the customer with Afterpay. If succesful, an order will be placed, but no invoice will be sent to the customer yet. Perform a Capture request to initiate the latter.
An Authorize request is the same as a Pay request. The only difference is the action name.
Request
JSON gateway request
Note: always make sure the AmountDebit equals the sum of the article amounts.
|
ClientIP
string
|
Required
This is a basic parameter. IP address of the customer. |
|
Invoice
string
|
Required
This is a basic parameter. Invoice/order number. May only contain alphanumeric characters, dashes and underscores. Max 19 characters. |
|
Description
string
|
Required
GroupType: Article. Article name/description. |
|
GrossUnitPrice
decimal
|
Required
GroupType: Article. Article price including VAT. |
|
VatPercentage
decimal
|
Required
GroupType: Article. VAT percentage on the article price. |
|
Quantity
string
|
Required
GroupType: Article. Article quantity. |
|
Identifier
string
|
Required
GroupType: Article. Article number/code. |
|
ImageUrl
string
|
GroupType: Article. URL for the image of this article. It will be turned into a thumbnail and displayed to the customer in MyAfterPay, on the invoice line next to the order item. The linked image must be a rectangle or square, width between 100 pixels and 1280 pixels. |
|
Url
string
|
GroupType: Article. URL to the article page. |
|
Type
string
|
GroupType: Article. Article type. Possible values: PhysicalArticle, DigitalArticle, Giftcard, Discount, ShippingFee, Surchargo, Info, ShippingFees. |
|
UnitCode
string
|
GroupType: Article. Unit in which the article is measured, such as pieces, liters, kilograms, etc. |
|
Category
string
|
Required
GroupType: BillingCustomer. Customer category of billing customer. Possible values: Person, Company. However, Company is currently not supported by Afterpay and therefore not usable at the moment. It is likely that it will be added in the (near) future. |
|
Salutation
string
|
GroupType: BillingCustomer. Required if Billing country is NL or BE. Gender of billing customer. Possible values: Mr, Mrs, Miss. |
|
FirstName
string
|
Required
GroupType: BillingCustomer. First name of billing customer. |
|
LastName
string
|
Required
GroupType: BillingCustomer. Last name of billing customer, prefix included. |
|
BirthDate
string
|
GroupType: BillingCustomer. Required if Billing country is NL or BE. Birth date of billing customer. Accepted formats: dd-mm-yyyy and yyyy-mm-dd. |
|
Street
string
|
Required
GroupType: BillingCustomer. Street of billing customer. |
|
StreetNumber
string
|
GroupType: BillingCustomer. Required if Billing country is NL or BE. House number of billing customer. |
|
StreetNumberAdditional
string
|
GroupType: BillingCustomer. House number suffix of billing customer. |
|
PostalCode
string
|
Required
GroupType: BillingCustomer. Postal code of billing customer. |
|
City
string
|
Required
GroupType: BillingCustomer. City of billing customer. |
|
Country
string
|
Required
GroupType: BillingCustomer. Country of billing customer. Possible values: NL, BE, DE, AT, FI. |
|
MobilePhone
string
|
GroupType: BillingCustomer. If Billing country is NL or BE, at least one phone number is required: either MobilePhone or Phone (landline). |
|
Phone
string
|
GroupType: BillingCustomer. If Billing country is NL or BE, at least one phone number is required: either MobilePhone or Phone (landline). |
|
Email
string
|
Required
GroupType: BillingCustomer. Email address of billing customer. |
|
CareOf
string
|
GroupType: BillingCustomer. Name of intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V. |
|
ConversationLanguage
string
|
GroupType: BillingCustomer. Conversation language of billing customer. Possible values: NL, FR, DE, FI. |
|
IdentificationNumber
string
|
GroupType: BillingCustomer. Required if Billing Country is Finland (FI). The customer’s national ID number, or the company’s registration number, depending on Category (Person or Company). Do not confuse with CustomerNumber. |
|
CustomerNumber
string
|
GroupType: BillingCustomer. The number you assign to the billing customer. |
|
Category
string
|
GroupType: ShippingCustomer. Required if ShippingCustomer information is provided. Customer category of shipping customer. Possible values: Person, Company. However, Company is currently not supported by Afterpay and therefore not useable at the moment. It is likely that it will be added in the (near) future. |
|
Salutation
string
|
GroupType: ShippingCustomer. Required if ShippingCustomer information is provided ánd shipping country is NL or BE. Gender of shipping customer. Possible values: Mr, Mrs, Miss. |
|
FirstName
string
|
GroupType: ShippingCustomer. Required if ShippingCustomer information is provided. First name of shipping customer. |
|
LastName
string
|
GroupType: ShippingCustomer. Required if ShippingCustomer information is provided. Street of shipping customer. |
|
BirthDate
string
|
GroupType: ShippingCustomer. Birth date of shipping customer. Accepted formats: dd-mm-yyyy and yyyy-mm-dd. |
|
Street
string
|
GroupType: ShippingCustomer. Required if ShippingCustomer information is provided. Street of shipping customer. |
|
StreetNumber
string
|
GroupType: ShippingCustomer. Required if ShippingCustomer information is provided ánd shipping country is NL or BE. House number of shipping customer. |
|
StreetNumberAdditional
string
|
GroupType: ShippingCustomer. House number suffix of shipping customer. |
|
PostalCode
string
|
GroupType: ShippingCustomer. Required if ShippingCustomer information is provided. Postal code of shipping customer. |
|
City
string
|
GroupType: ShippingCustomer. Required if ShippingCustomer information is provided. City of shipping customer. |
|
Country
string
|
GroupType: ShippingCustomer. Required if ShippingCustomer information is provided. Country of shipping customer. Possible values: Possible values: NL, BE, DE, AT, FI. If the value differs from the billing country, the request will be rejected by Afterpay. |
|
MobilePhone
string
|
GroupType: ShippingCustomer. Mobile phone of shipping customer. |
|
Phone
string
|
GroupType: ShippingCustomer. Phone number (landline) of shipping customer. |
|
Email
string
|
GroupType: ShippingCustomer. Email address of shipping customer. |
|
CareOf
string
|
GroupType: ShippingCustomer. Name of intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V. |
|
ConversationLanguage
string
|
GroupType: ShippingCustomer. Conversation language of shipping customer. Possible values: NL, FR, DE, FI. |
|
IdentificationNumber
string
|
GroupType: ShippingCustomer. The customer’s national ID number, or the company’s registration number, depending on Category (Person or Company). Do not confuse with CustomerNumber. |
|
CustomerNumber
string
|
GroupType: ShippingCustomer. The number you assign to the shipping customer. |
|
MerchantImageUrl
string
|
Image URL for the merchants brand. This image is shown at the top of the customer's order page in MyAfterPay. |
|
SummaryImageUrl
string
|
Currently does not do anything, but in the future, this might be used by AfterPay to show an image to the customer for the entire order. You can decide to send this in so that if/when AfterPay implements this, you will automatically use this feature. |
|
BankAccount
string
|
The customer's IBAN. Only required when the customer has to be invoiced through a SEPA Direct Debit and is only available for Dutch, German and Austrian consumers (BillingCustomerCountry NL, DE and AT). |
|
BankCode
string
|
The customer’s BIC. Can be used in conjunction with BankAccount, but not mandatory. Only available for Dutch, German and Austrian consumers (BillingCustomerCountry NL, DE and AT). |
JSON
{
"Currency": "EUR",
"AmountDebit": 10,
"Invoice": "testinvoice12345cvc",
"ClientIP": {
"Type": 0,
"Address": "0.0.0.0"
},
"Services": {
"ServiceList": [
{
"Name": "afterpay",
"Action": "Authorize",
"Parameters": [
{
"Name": "Description",
"GroupType": "Article",
"GroupID": "1",
"Value": "Blue Toy Car"
},
{
"Name": "GrossUnitPrice",
"GroupType": "Article",
"GroupID": "1",
"Value": "10.00"
},
{
"Name": "VatPercentage",
"GroupType": "Article",
"GroupID": "1",
"Value": "21"
},
{
"Name": "Quantity",
"GroupType": "Article",
"GroupID": "1",
"Value": "1"
},
{
"Name": "Identifier",
"GroupType": "Article",
"GroupID": "1",
"Value": "Articlenumber12345"
},
{
"Name": "ImageUrl",
"GroupType": "Article",
"GroupID": "1",
"Value": "https://www.buckaroo.nl/img/logo_menu.png"
},
{
"Name": "Url",
"GroupType": "Article",
"GroupID": "1",
"Value": "https://www.buckaroo.nl/"
},
{
"Name": "Type",
"GroupType": "Article",
"GroupID": "1",
"Value": "PhysicalArticle"
},
{
"Name": "UnitCode",
"GroupType": "Article",
"GroupID": "1",
"Value": "Pieces"
},
{
"Name": "Category",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "Person"
},
{
"Name": "Salutation",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "Mr"
},
{
"Name": "FirstName",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "Test"
},
{
"Name": "LastName",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "Acceptatie"
},
{
"Name": "BirthDate",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "01-01-1990"
},
{
"Name": "Street",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "Hoofdstraat"
},
{
"Name": "StreetNumber",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "90"
},
{
"Name": "StreetNumberAdditional",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "A"
},
{
"Name": "PostalCode",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "8441EE"
},
{
"Name": "City",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "Heerenveen"
},
{
"Name": "Country",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "NL"
},
{
"Name": "MobilePhone",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "0698765433"
},
{
"Name": "Phone",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "0109876543"
},
{
"Name": "Email",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "billingcustomer@buckaroo.nl"
},
{
"Name": "CareOf",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "John Smith"
},
{
"Name": "ConversationLanguage",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "NL"
},
{
"Name": "IdentificationNumber",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "IdNumber12345"
},
{
"Name": "CustomerNumber",
"GroupType": "BillingCustomer",
"GroupID": "",
"Value": "CustomerNumber12345"
},
{
"Name": "Category",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "Person"
},
{
"Name": "Salutation",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "Miss"
},
{
"Name": "FirstName",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "Test"
},
{
"Name": "LastName",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "Aflever"
},
{
"Name": "BirthDate",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "02-02-1980"
},
{
"Name": "Street",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "Afleverstraat"
},
{
"Name": "StreetNumber",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "80"
},
{
"Name": "StreetNumberAdditional",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "B"
},
{
"Name": "PostalCode",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "7881ER"
},
{
"Name": "City",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "Leeuwarden"
},
{
"Name": "Country",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "NL"
},
{
"Name": "MobilePhone",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "0698765432"
},
{
"Name": "Phone",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "0209876543"
},
{
"Name": "Email",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "shippingcustomer@buckaroo.nl"
},
{
"Name": "CareOf",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "Martha Smith"
},
{
"Name": "ConversationLanguage",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "NL"
},
{
"Name": "IdentificationNumber",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "IdNumber12346"
},
{
"Name": "CustomerNumber",
"GroupType": "ShippingCustomer",
"GroupID": "",
"Value": "CustomerNumber12346"
},
{
"Name": "BankAccount",
"GroupType": "",
"GroupID": "",
"Value": "NL13TEST0123456789"
},
{
"Name": "BankCode",
"GroupType": "",
"GroupID": "",
"Value": "TESTNL2A"
},
{
"Name": "MerchantImageUrl",
"GroupType": "",
"GroupID": "",
"Value": "https://www.buckaroo.nl/img/logo_menu.png"
},
{
"Name": "SummaryImageUrl",
"GroupType": "",
"GroupID": "",
"Value": "https://www.buckaroo.nl/img/logo_menu.png"
}
]
}
]
}
}Response 200 Status: Ok 400 Status: Access denied 500 Status: Bad request
JSON gateway response
Note: If a request is rejected (statuscode 690), then the reason is provided in Services->Afterpay->ErrorResponseMessage>Value and can be used to inform the customer.
JSON
{
"Key": "D5127080BA1D4644856FECDC560FXXXX",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": null,
"DateTime": "2019-03-14T09:22:49+01:00"
},
"RequiredAction": null,
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "testinvoice12345cvc",
"ServiceCode": "afterpay",
"IsTest": true,
"Currency": "EUR",
"AmountDebit": 10,
"TransactionType": "I038",
"MutationType": 3,
"RelatedTransactions": null,
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": "NL",
"StartRecurrent": false,
"Recurring": false,
"CustomerName": "Test Acceptatie",
"PayerHash": null,
"PaymentKey": null
}Push
JSON push response
JSON
{
"Transaction": {
"Key": "D5127080BA1D4644856FECDC560FXXXX",
"Invoice": "testinvoice12345cvc",
"ServiceCode": "afterpay",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": null,
"DateTime": "2019-03-14T09:22:49"
},
"IsTest": true,
"Order": null,
"Currency": "EUR",
"AmountDebit": 10,
"TransactionType": "I038",
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 3,
"RelatedTransactions": null,
"IsCancelable": false,
"IssuingCountry": "NL",
"StartRecurrent": false,
"Recurring": false,
"CustomerName": "Test Acceptatie",
"PayerHash": null,
"PaymentKey": null
}
}CancelAuthorize
If an Authorize transaction has been partially captured or not at all, and the customer wishes to cancel the (remaining) order, the (remaining) authorized amount can be cancelled by performing a CancelAuthorize call. It is advised to do this, as it also opens up the customer's spending limit at AfterPay.
Request
JSON Gateway request
The CancelAuthorize request cancels the entire authorisation, independent of which AmountCredit is provided in the request.
|
OriginalTransactionKey
string
|
Required
This is a basic parameter. Transaction key of the Authorize transaction. |
|
Invoice
string
|
Required
This is a basic parameter. Invoice number given to the CancelAuthorize transaction. Strongly adviced to use the same invoice number of the Authorize transaction |
JSON
{
"Currency": "EUR",
"AmountCredit": 10,
"OriginalTransactionKey": "F86579ECED1D493887ECAE7C287BXXXX",
"Invoice": "testinvoice12345cvx",
"Services": {
"ServiceList": [
{
"Name": "afterpay",
"Action": "CancelAuthorize"
}
]
}
}Response 200 Status: Ok 400 Status: Access denied 500 Status: Bad request
JSON gateway response
JSON
{
"Key": "AD21305248594E949FA380155402XXXX",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": null,
"DateTime": "2019-03-14T12:24:19+01:00"
},
"RequiredAction": null,
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "testinvoice12345cvx",
"ServiceCode": "afterpay",
"IsTest": true,
"Currency": "EUR",
"AmountCredit": 10,
"TransactionType": "I014",
"MutationType": 3,
"RelatedTransactions": null,
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": "Test Acceptatie",
"PayerHash": null,
"PaymentKey": null
}Push
JSON push responsense
JSON
{
"Transaction": {
"Key": "AD21305248594E949FA380155402XXXX",
"Invoice": "testinvoice12345cvx",
"ServiceCode": "afterpay",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": null,
"DateTime": "2019-03-14T12:24:19"
},
"IsTest": true,
"Order": null,
"Currency": "EUR",
"AmountCredit": 10,
"TransactionType": "I014",
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 3,
"RelatedTransactions": null,
"IsCancelable": false,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": "Test Acceptatie",
"PayerHash": null,
"PaymentKey": null
}
}Capture
A Capture request can be performed on a succesful Authorize transaction. If the capture is succesful, an invoice will be sent to the customer.
Request
JSON gateway request
When performing a full capture, no article information is required in the request; the original transaction key of the Authorize transaction will suffice. When performing a partial capture, the information of the captured article(s) is required in the request.
Secondly, when performing a partial capture, the AmountDebit should equal the sum of the article amounts.
|
OriginalTransactionKey
string
|
Required
This is a basic parameter. Transaction key of the Authorize transaction. |
|
Invoice
string
|
Required
This is a basic parameter. Invoice number given to the Capture transaction. When performing a full capture or just one partial capture in total, we advise to use the same invoice number as the Authorize transaction. But when performing multiple partial captures, each invoice number has to be unique. |
|
Description
string
|
GroupType: Article. Required for partial Capture. Article name/description. |
|
GrossUnitPrice
decimal
|
GroupType: Article. Required for partial Capture. Article price including VAT. |
|
VatPercentage
decimal
|
GroupType: Article. Required for partial Capture. VAT percentage on the article price. |
|
Quantity
string
|
GroupType: Article. Required for partial Capture. Article quantity. |
|
Identifier
string
|
GroupType: Article. Required for partial Capture. Article number/code. |
|
ImageUrl
string
|
GroupType: Article. URL for the image of this article. It will be turned into a thumbnail and displayed to the customer in MyAfterPay, on the invoice line next to the order item. The linked image must be a rectangle or square, width between 100 pixels and 1280 pixels. |
|
Url
string
|
GroupType: Article. URL to the article page. |
|
Type
string
|
GroupType: Article. Article type. Possible values: PhysicalArticle, DigitalArticle, GiftCard, Discount, ShippingFee, Surcharge, Info, ShippingFees. |
|
UnitCode
string
|
GroupType: Article. Unit in which the article is measured, such as pieces, liters, kilograms, etc. |
|
SummaryImageUrl
string
|
Currently does not do anything, but in the future, this might be used by AfterPay to show an image to the customer for the entire order. You can decide to send this in so that if/when AfterPay implements this, you will automatically use this feature. |
|
MerchantImageUrl
string
|
Image URL for the merchants brand. This image is shown at the top of the order page in MyAfterPay. |
JSON
{
"OriginalTransactionKey": "D5127080BA1D4644856FECDC560FXXXX",
"Currency": "EUR",
"AmountDebit": 10,
"Invoice": "testinvoice12345cvc",
"Services": {
"ServiceList": [
{
"Name": "afterpay",
"Action": "Capture",
"Parameters": [
{
"Name": "Description",
"GroupType": "Article",
"GroupID": "1",
"Value": "Blue Toy Car"
},
{
"Name": "GrossUnitPrice",
"GroupType": "Article",
"GroupID": "1",
"Value": "10.00"
},
{
"Name": "VatPercentage",
"GroupType": "Article",
"GroupID": "1",
"Value": "21"
},
{
"Name": "Quantity",
"GroupType": "Article",
"GroupID": "1",
"Value": "1"
},
{
"Name": "Identifier",
"GroupType": "Article",
"GroupID": "1",
"Value": "Articlenumber12345"
},
{
"Name": "ImageUrl",
"GroupType": "Article",
"GroupID": "1",
"Value": "https://www.buckaroo.nl/img/logo_menu.png"
},
{
"Name": "Url",
"GroupType": "Article",
"GroupID": "1",
"Value": "https://www.buckaroo.nl/"
},
{
"Name": "Type",
"GroupType": "Article",
"GroupID": "1",
"Value": "PhysicalArticle"
},
{
"Name": "UnitCode",
"GroupType": "Article",
"GroupID": "1",
"Value": "Pieces"
},
{
"Name": "SummaryImageUrl",
"GroupType": "Article",
"GroupID": "1",
"Value": "https://www.buckaroo.nl/img/logo_menu.png"
},
{
"Name": "MerchantImageUrl",
"GroupType": "Article",
"GroupID": "1",
"Value": "https://www.buckaroo.nl/img/logo_menu.png"
}
]
}
]
}
}Response 200 Status: Ok 400 Status: Access denied 500 Status: Bad request
JSON gateway response
JSON
{
"Key": "4F807F26432A484099474C1B119CXXXX",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S990",
"Description": "The request was successful."
},
"DateTime": "2019-03-14T10:19:40"
},
"RequiredAction": null,
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "testinvoice12345cvc",
"ServiceCode": "afterpay",
"IsTest": true,
"Currency": "EUR",
"AmountDebit": 10,
"TransactionType": "C040",
"MutationType": 1,
"RelatedTransactions": null,
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": "Test Acceptatie",
"PayerHash": null,
"PaymentKey": "39CAC9E39107438FBEB15E412E6BXXXX"
}Push
JSON push response
JSON
{
"Transaction": {
"Key": "4F807F26432A484099474C1B119CXXXX",
"Invoice": "testinvoice12345cvc",
"ServiceCode": "afterpay",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S990",
"Description": "The request was successful."
},
"DateTime": "2019-03-14T10:19:40"
},
"IsTest": true,
"Order": null,
"Currency": "EUR",
"AmountDebit": 10,
"TransactionType": "C040",
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 1,
"RelatedTransactions": null,
"IsCancelable": false,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": "Test Acceptatie",
"PayerHash": null,
"PaymentKey": "39CAC9E39107438FBEB15E412E6BXXXX"
}
}Request
JSON gateway request
When performing a full Refund, no article information is required in the request; the original transaction key of the Pay or Capture transaction will suffice. When performing a partial Refund, the information of the refunded article(s) is required in the request.
Secondly, when performing a partial Refund, the AmountCredit should equal the sum of the article amounts.
|
OriginalTransactionKey
string
|
Required
This is a basic parameter. Transaction key of the Pay or Capture transaction. |
|
Invoice
string
|
Required
This is a basic parameter. Invoice number given to the Refund transaction. Strongly adviced to use the same invoice number of the Pay or Capture transaction |
|
RefundType
string
|
GroupType: Article. Required for partial Refund. Possible values: Return, Refund. Return should be used for products that have been returned by the customer. Refund should be used for goodwill refunds, such as “the product was damaged, you’ll receive (part of) the purchase price back”. |
|
Description
string
|
GroupType: Article. Required for partial Refund. Article name/description. |
|
GrossUnitPrice
decimal
|
GroupType: Article. Required for partial Refund. Article price including VAT. |
|
VatPercentage
decimal
|
GroupType: Article. Required for partial Refund. VAT percentage on the article price. |
|
Quantity
string
|
GroupType: Article. Required for partial Refund. Article quantity. |
|
Identifier
string
|
GroupType: Article. Required for partial Refund. Article number/code. |
|
ImageUrl
string
|
GroupType: Article. URL for the image of this article. Tt will be turned into a thumbnail and displayed to the customer in MyAfterPay, on the invoice line next to the order item. The linked image must be a rectangle or square, width between 100 pixels and 1280 pixels. |
|
Url
string
|
GroupType: Article. URL to the article page. |
|
Type
string
|
GroupType: Article. Article type. Possible values: PhysicalArticle, DigitalArticle, GiftCard, Discount, ShippingFee, Surcharge, Info, ShippingFees. |
|
UnitCode
string
|
GroupType: Article. Unit in which the article is measured, such as pieces, liters, kilograms, etc. |
|
SummaryImageUrl
string
|
Currently does not do anything, but in the future, this might be used by AfterPay to show an image to the customer for the entire order. You can decide to send this in so that if/when AfterPay implements this, you will automatically use this feature. |
|
MerchantImageUrl
string
|
Image URL for the merchants brand. This image is shown at the top of the order page in MyAfterPay. |
JSON
{
"OriginalTransactionKey": "CE82E23DDF1740C79710B1BB9F25XXXX",
"Currency": "EUR",
"AmountCredit": 10,
"Invoice": "testinvoice12345cvs",
"Services": {
"ServiceList": [
{
"Name": "afterpay",
"Action": "Refund",
"Parameters": [
{
"Name": "RefundType",
"GroupType": "Article",
"GroupID": "1",
"Value": "Return"
},
{
"Name": "Description",
"GroupType": "Article",
"GroupID": "1",
"Value": "Blue Toy Car"
},
{
"Name": "GrossUnitPrice",
"GroupType": "Article",
"GroupID": "1",
"Value": "10.00"
},
{
"Name": "VatPercentage",
"GroupType": "Article",
"GroupID": "1",
"Value": "21"
},
{
"Name": "Quantity",
"GroupType": "Article",
"GroupID": "1",
"Value": "1"
},
{
"Name": "Identifier",
"GroupType": "Article",
"GroupID": "1",
"Value": "Articlenumber12345"
},
{
"Name": "ImageUrl",
"GroupType": "Article",
"GroupID": "1",
"Value": "https://www.buckaroo.nl/img/logo_menu.png"
},
{
"Name": "Url",
"GroupType": "Article",
"GroupID": "1",
"Value": "https://www.buckaroo.nl/"
},
{
"Name": "Type",
"GroupType": "Article",
"GroupID": "1",
"Value": "PhysicalArticle"
},
{
"Name": "UnitCode",
"GroupType": "Article",
"GroupID": "1",
"Value": "Pieces"
},
{
"Name": "SummaryImageUrl",
"GroupType": "Article",
"GroupID": "1",
"Value": "https://www.buckaroo.nl/img/logo_menu.png"
},
{
"Name": "MerchantImageUrl",
"GroupType": "Article",
"GroupID": "1",
"Value": "https://www.buckaroo.nl/img/logo_menu.png"
}
]
}
]
}
}Response 200 Status: Ok 400 Status: Access denied 500 Status: Bad request
JSON gateway response
JSON
{
"Key": "721559A240B34F7B9C3E266BD75CXXXX",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S990",
"Description": "The request was successful."
},
"DateTime": "2019-03-14T11:29:31"
},
"RequiredAction": null,
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "testinvoice12345cvs",
"ServiceCode": "afterpay",
"IsTest": true,
"Currency": "EUR",
"AmountCredit": 10,
"TransactionType": "C041",
"MutationType": 1,
"RelatedTransactions": [
{
"RelationType": "refund",
"RelatedTransactionKey": "CE82E23DDF1740C79710B1BB9F25XXXX"
}
],
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": "Test Acceptatie",
"PayerHash": null,
"PaymentKey": "AF55BB29923A421387E8CB4C2B0CXXXX"
}Push
JSON push response
JSON
{
"Transaction": {
"Key": "721559A240B34F7B9C3E266BD75CXXXX",
"Invoice": "testinvoice12345cvs",
"ServiceCode": "afterpay",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": null,
"DateTime": "2019-03-14T11:29:31"
},
"IsTest": true,
"Order": null,
"Currency": "EUR",
"AmountCredit": 10,
"TransactionType": "C041",
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 1,
"RelatedTransactions": [
{
"RelationType": "refund",
"RelatedTransactionKey": "CE82E23DDF1740C79710B1BB9F25XXXX"
}
],
"IsCancelable": false,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": "Test Acceptatie",
"PayerHash": null,
"PaymentKey": null
}
}