What's new?

Release Notes - 2021

Computop

Ingenico

MultiSafepay

Cardgate

PayPro

DigiWallet

Buckaroo

Sisow

CM.com

Adyen

Pay.

Partner & Integrations

PSPs

Magento

Magento 1 

Magento 2

WooCommerce

Shopware 6.3

Spryker New

Lightspeed

Shoppagina

Shopware 6.4

Shopware 5

Shopware

Shoptrader

MyShop

Logic4

050media

NextChapter

Mijnwebwinkel

CCV Shop

Cloudcommerce

Prestashop

Divide 

Plugins

Postman

Swagger

SDKs

Our standardised connections

Our standardised integrations

Get Started

thumbnail_magento-logo.jpg

magento-logo.jpg

Magento is a popular open-source e-commerce platform. You can use our plugin to add AfterPay to your Magento-based webshop.

#### Versions
AfterPay supports multiple versions of Magento. Please select your version to proceed to the manual.

- [Magento 2](../../plugins/magento-2)
- [Magento 1](../../plugins/magento-1)

thumbnail_computop-logo.jpg

computop-logo.jpg

Computop Paygate offers secure payment processing for all channels including E-Commerce, mobile, and PoS. 

##How to configure Computop & AfterPay?

Please click on the link below to find more information on how to set-up Computop and AfterPay.

German Documentation

English Documentation

thumbnail_ingenico-logo.jpg

ingenico-logo.jpg

Ingenico is the global trusted partner for financial institutions and retailers, providing the most extensive network connecting acquirers and payment methods.

##How to configure Ingenico & AfterPay?

Please click on the link below to find more information on how to set-up Ingenico and AfterPay.



Ingenico Online Documentation

thumbnail_postman-logo.jpg

postman-logo.jpg

Download our pre-created Postman collection and start testing our API right away. All examples in the documentation are already there and you can start trying out with ease. 

POSTMAN

##How can I use Postman and AfterPay?

**Open Postman** You should see an empty request window. In this window you can specify the type of request (POST, GET etc.), the URL additional field like the Headers, Body, Pre-request Script and Tests. Mostly the Headers contain values which are needed for authentication. In the case of the example for AfterPay the API-Key is needed as well as a “Content-Type” which states that the body is in a JSON format. 

Those fields are required regardless of a POST or GET-Request. The Body can be empty (as in a GET-Request) or can contain several key-value pairs needed for manipulation. As the name reveals a Pre-request Script runs before a request is send in order to set some values or similar. However, it can be empty as well. Tests are “Post-Request Scripts” which can check if your request was sent successfully and had the desired results. 

For further readings and first steps in Postman, please feel free to read these instructions (https://www.getpostman.com/docs/requests). 

Postman Environments can be downloaded in the My Account > Credentials section of the AfterPay Developer Portal, as they are specific to your API key. 

AfterPay Payment API Sandbox Test Sets.postman_collection.json

Sandbox Test Sets

Sandbox.postman_environment.json

Sandbox Environment

thumbnail_swagger-logo.jpg

swagger-logo.jpg

We describe our API using Swagger and give you the possibility to generate your own SDK from scratch or stub server.

Authorize Payment

Get Available Payment Methods

Checkout

Order Management

Additional Services

FastTrack Services

Common

Product

Customer Account

All the API Calls in more detail

# API Documentation
 
The AfterPay Management API contains resource collections to get available payment methods, authorization, capture, refund and void operations. On this page, you can find a detailed description of each operation with input parameters, possible responses, sample requests and integration examples for different platforms.

Approves the payment for a specified customer and basket. Main use-cases are One-Step and Two-Step Authorization. Full fraud and credit scoring applied. If the online-shop customer enter the incorrect address data, the system delivers a suggestion for a corrected address.

Authorize payment

Returns the available payment methods for a specified basket value and offers available for client. Returns monthly installment amount, interest and fees. Sending in customer data and contents of the basket to enhance the result is optional. If the online-shop customer enters the incorrect address data, the system delivers suggestion for a corrected address. Main use-case is Two-Step Authorize.

Available Payment Methods

Completes the payment that has been authorized. Typically done when the order is shipped. Can be a full or partial capture of the order amount.

Capture Payment

Notifies about a full or partial return registered by the consumer on the merchants web shop.

Return Notification

Refunds a partially or fully captured payment.

Refund Payment

Void (cancel) an authorization that has not been captured.

Void Authorization

Change the contents of an Authorized but not Captured order. Use this call to add or remove items in an existing Order, without creating a new orderNumber.
You must provide the entire body of the query, in the same format as Authorize, including all Order Items. (If you added an item, Update Order must contain previously Authorized items as well. If you removed an item, Update Order must contain the new full list of Order Items.)
If the TotalGrossAmount has increased compared to the Authorize call for this orderNumber, a new Risk Check will be made for the additional amount. If the additional Risk Check returns a rejection, the original Authorize will remain valid.

Update Order

Returns the contents of the specified order

Get Order

Returns all or specific captured payments of the order

Get Captures

Returns all or specific refunds of the order.

Get Refunds

Returns all or specific voided (cancelled) authorizations of the order.

Get Voids

Add new shipping details information to the capture.

Add Shipping Details

Update shipping details information of the specific capture.

Update Shipping Details

Returns address based on input (Social security number, mobile number, Organization number).

Customer lookup

Update customer

Returns the available installment plans for the specific product/basket value. Returns monthly installment amount, interest and fees. Typically used on a product page.


Available installment plans

Validates and evaluates the account and bank details in the context of direct debit payment. It is possible to transfer either the combination of BankCode and AccountNumber or IBAN and BIC

Validate bank account

Check the delivered customer addresses as well as a phonetic and associative identification of duplicates. Additionally, checks of client-specific negative or positive lists can be processed. Usually, the AddressCheck is used for the pure verification of the address data e.g. for registration processes.

Validate address

Creates an installment and/or direct debit contract that can be displayed for the customer.

Create contract

Apply for account credit

Get remaining credit limit

Add event

Find customer account by SSN (social security number)


Lookup account by SSN

Get Version

All the Checkout API Calls in more detail

# API Documentation
 
## Checkout API Calls

All the Order Management API Calls in more detail

# API Documentation
 
## Order Management

Collecting Consumer Information

Payment Method Presentation

Validations & Error Codes

LegalForm

Documentation

Prepare Checkout

Compliance Requirements

Capture

Void

Refund

Logo & Visual Guidelines

Our payment methods

AfterPay Basics

First API Call

AfterPay Sandbox

References

Main Flow

Introduction

Hosted Fields

Customer Lookup

Address Correction

IBAN Tokenization

Idempotency

Invoice Element

AfterPay Elements

Welcome to our documentation

# AfterPay Documentation

The Developer Portal gives you access to view all of our documentation, download plugins or dive into the details of our API.

This documentation guide gives you an overview of all the features and also detailed instructions on how to use them. 

doc.svg

The Prepare Checkout section of our Developers has been created in order to help you to set up your checkout in the way that AfterPay is supported in the best way possible. 

Here you get an overview of:
- What information needs to be collected from the customer?
- What logotype to use? 
- How to present the payment options on your payment page? 
- How to deal with error codes. 

In order to see an increase in conversion, higher-order values, and increasing the likelihood of returning customers.

#Consumer Information

In the following table, you can see which information is required per country for sending a complete request. However, check out our Customer LookUp functionality under 5.1 to further reduce the information that has to be provided by the consumer.


|Country|Salutation|SSN|First Name|Last Name|Email|Mobile Phone|Date of Birthday|Country|Postal Code|Street|Street Number|City|
|--- |--- |--- |--- |--- |--- |--- |--- |--- |--- |--- |--- |--- |
|**Germany**| | |&#10004;|&#10004;|&#10004;||&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|
|**Austria**|||&#10004;|&#10004;|&#10004;||&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|
|**Switzerland**|||&#10004;|&#10004;|&#10004;||&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|
|**Netherlands**|||&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|
|**Belgium**|||&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|
|**Sweden**||&#10004;|&#10004;|&#10004;|&#10004;|||&#10004;|&#10004;|&#10004;||&#10004;|
|**Norway**||&#10004;|&#10004;|&#10004;|&#10004;|||&#10004;|&#10004;|&#10004;||&#10004;|
|**Finland**||&#10004;|&#10004;|&#10004;|&#10004;|||&#10004;|&#10004;|&#10004;||&#10004;|
|**Denmark**||&#10004;|&#10004;|&#10004;|&#10004;||&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|&#10004;|

#Payment Options

AfterPay, as illustrated in the After Basics offers various invoice and part payment options. Here is a short recap of how we have structured them and a best-practice example of the way they shall be displayed. To get a more detailed explanation of how to display the different payment options, check our Display Guidelines.

![Payment_methods(1).png](/uploads/Payment_methods_1_098dc767a8.png)

For specific verticals, AfterPay makes it possible to generate a merchant-specific consolidated invoice that is a standalone AfterPay payment option. It allows consolidating all purchases made by the customer into a single invoice. If the consolidated invoice is used, no other AfterPay payment options are presented at checkout. Below is how the consolidated invoice is presented at checkout.

![Payment_methods(2).png](/uploads/Payment_methods_2_dc42d3514f.png)

You can check the Merchant Playbook to get more information about payment options and how they are presented at checkout.

Merchant Playbook -  German version

Merchant Playbook - English version

Merchant Playbook - Dutch version

#Compliance Requirements

In order to make the offering of AfterPay’s payment method compliant you will have to add one note with two links underneath the AfterPay payment method as shown in the picture below:

"The general **Terms & Conditions** for the AfterPay Payment Method apply. The privacy policy of AfterPay can be found **here**."

**Important for your conversion:** You do not need a confirmation checkbox here.

![MicrosoftTeams-image (84).png](/uploads/Microsoft_Teams_image_84_e22054d000.png)

Find localized links in the tables below. 

###Legal Statements for AfterPay Payment Methods
|Language|Legal Text below Payment Method|
|--- |--- |
|Dutch|De algemene voorwaarden voor de betaalmethode AfterPay zijn van toepassing. Het privacybeleid van AfterPay vind je hier.|
|German|Es gelten die allgemeinen Geschäftsbedingungen für die Zahlungsmethode AfterPay. Die Datenschutzbestimmungen von AfterPay findest Du hier.|
|English|The general Terms & Conditions for the AfterPay Payment Method apply. The privacy policy of AfterPay can be found here.|
|Danish|De generelle vilkår og betingelser for AfterPay-betalingsmetoden gælder. AfterPay's fortrolighedspolitik kan findes her.|
|Finnish|Sovelletaan AfterPay-maksutavan yleisiä käyttöehtoja. AfterPayn tietosuojakäytäntö löytyy täältä.|
|French|Les conditions générales du mode de paiement AfterPay s'appliquent. La politique de confidentialité d'AfterPay peut être consultée ici.|
|Italian|Si applicano i termini e le condizioni generali per il metodo di pagamento AfterPay. La politica sulla privacy di AfterPay può essere trovata qui.|
|Norwegian|De generelle vilkårene for AfterPay-betalingsmåten gjelder. Personvernerklæringen til AfterPay finner du her.|
|Swedish|De allmänna villkoren för betalningsmetoden AfterPay gäller. AfterPays sekretesspolicy finns här.|

### Terms & Conditions

|Country|Language|URL|
|--- |--- |--- |
|Norway   |Norwegian |[https://documents.myafterpay.com/consumer-terms-conditions/no_no](https://documents.myafterpay.com/consumer-terms-conditions/no_no)  |
|Norway   |English        |[https://documents.myafterpay.com/consumer-terms-conditions/en_no](https://documents.myafterpay.com/consumer-terms-conditions/en_no)  | 
||||
|Sweden  |Swedish  |[https://documents.myafterpay.com/consumer-terms-conditions/sv_se](https://documents.myafterpay.com/consumer-terms-conditions/sv_se)  |
|Sweden  |English  |[https://documents.myafterpay.com/consumer-terms-conditions/en_se](https://documents.myafterpay.com/consumer-terms-conditions/en_se)  |
||||
|Finland  |Finnish  |[https://documents.myafterpay.com/consumer-terms-conditions/fi_fi](https://documents.myafterpay.com/consumer-terms-conditions/fi_fi)  |
|Finland  |English  |[https://documents.myafterpay.com/consumer-terms-conditions/en_fi](https://documents.myafterpay.com/consumer-terms-conditions/en_fi)  |
||||
|Denmark  |Danish  |[https://documents.myafterpay.com/consumer-terms-conditions/da_dk](https://documents.myafterpay.com/consumer-terms-conditions/da_dk)  |
|Denmark  |English  |[https://documents.myafterpay.com/consumer-terms-conditions/en_d](https://documents.myafterpay.com/consumer-terms-conditions/en_dk)  |
||||
|Germany  |German|[https://documents.myafterpay.com/consumer-terms-conditions/de_de](https://documents.myafterpay.com/consumer-terms-conditions/de_de)  |
|Germany  |English  |	[https://documents.myafterpay.com/consumer-terms-conditions/en_de](https://documents.myafterpay.com/consumer-terms-conditions/en_de) |
||||
|Netherlands  |Dutch   |[https://documents.myafterpay.com/consumer-terms-conditions/nl_nl](https://documents.myafterpay.com/consumer-terms-conditions/nl_nl)  |
|Netherlands  |English  |[https://documents.myafterpay.com/consumer-terms-conditions/en_nl](https://documents.myafterpay.com/consumer-terms-conditions/en_nl)  |
||||
|Austria  |German |[https://documents.myafterpay.com/consumer-terms-conditions/de_at](https://documents.myafterpay.com/consumer-terms-conditions/de_at)  |
|Austria  |English  |	[https://documents.myafterpay.com/consumer-terms-conditions/en_at](https://documents.myafterpay.com/consumer-terms-conditions/en_at)  |
||||
|Belgium  |Dutch  |[https://documents.myafterpay.com/consumer-terms-conditions/nl_be](https://documents.myafterpay.com/consumer-terms-conditions/nl_be)  |
|Belgium  |French  |[https://documents.myafterpay.com/consumer-terms-conditions/fr_be](https://documents.myafterpay.com/consumer-terms-conditions/fr_be)  |
|Belgium  |English  |[https://documents.myafterpay.com/consumer-terms-conditions/en_be](https://documents.myafterpay.com/consumer-terms-conditions/en_be)  |
||||
|Switzerland  |German  |[https://documents.myafterpay.com/consumer-terms-conditions/de_ch](https://documents.myafterpay.com/consumer-terms-conditions/de_ch)  |
|Switzerland  |French  |[https://documents.myafterpay.com/consumer-terms-conditions/fr_ch](https://documents.myafterpay.com/consumer-terms-conditions/fr_ch)  |
|Switzerland  |Italian  |[https://documents.myafterpay.com/consumer-terms-conditions/it_ch](https://documents.myafterpay.com/consumer-terms-conditions/it_ch)  |
|Switzerland  |English  |	[https://documents.myafterpay.com/consumer-terms-conditions/en_ch](https://documents.myafterpay.com/consumer-terms-conditions/en_ch)  |

### Privacy policy

|Country|Language|URL
|--- |--- |--- |
|Norway   |Norwegian |[https://documents.myafterpay.com/privacy-statement/no_no](https://documents.myafterpay.com/privacy-statement/no_no)|
|Norway   |English        |[https://documents.myafterpay.com/privacy-statement/en_no](https://documents.myafterpay.com/privacy-statement/en_no)|
||||
|Sweden  |Swedish  |[https://documents.myafterpay.com/privacy-statement/sv_se](https://documents.myafterpay.com/privacy-statement/sv_se)  |
|Sweden  |English  |[https://documents.myafterpay.com/privacy-statement/en_se](https://documents.myafterpay.com/privacy-statement/en_se)  |
||||
|Finland  |Finnish  |[https://documents.myafterpay.com/privacy-statement/fi_fi](https://documents.myafterpay.com/privacy-statement/fi_fi)  | 
|Finland  |English  |[https://documents.myafterpay.com/privacy-statement/en_fi](https://documents.myafterpay.com/privacy-statement/en_fi)  |
||||
|Denmark  |Danish  |[https://documents.myafterpay.com/privacy-statement/da_dk](https://documents.myafterpay.com/privacy-statement/da_dk)  |
|Denmark  |English  |[https://documents.myafterpay.com/privacy-statement/en_dk](https://documents.myafterpay.com/privacy-statement/en_dk)  |
||||
|Germany  |German|[https://documents.myafterpay.com/privacy-statement/de_de](https://documents.myafterpay.com/privacy-statement/de_de)  |
|Germany  |English  |[https://documents.myafterpay.com/privacy-statement/en_de](https://documents.myafterpay.com/privacy-statement/en_de) |
||||
|Netherlands  |Dutch   |[https://documents.myafterpay.com/privacy-statement/nl_nl](https://documents.myafterpay.com/privacy-statement/nl_nl)  |
|Netherlands  |English  |[https://documents.myafterpay.com/privacy-statement/en_nl](https://documents.myafterpay.com/privacy-statement/en_nl)  |
||||
|Austria  |German |[https://documents.myafterpay.com/privacy-statement/de_at](https://documents.myafterpay.com/privacy-statement/de_at)  |
|Austria  |English  |	[https://documents.myafterpay.com/privacy-statement/en_at](https://documents.myafterpay.com/privacy-statement/en_at)  |
||||
|Belgium  |Dutch  |[https://documents.myafterpay.com/privacy-statement/nl_be](https://documents.myafterpay.com/privacy-statement/nl_be)  |
|Belgium  |French  |[https://documents.myafterpay.com/privacy-statement/fr_be](https://documents.myafterpay.com/privacy-statement/fr_be)  |
|Belgium  |English  |[https://documents.myafterpay.com/privacy-statement/en_be](https://documents.myafterpay.com/privacy-statement/en_be)  |
||||
|Switzerland  |German  |[https://documents.myafterpay.com/privacy-statement/de_ch](https://documents.myafterpay.com/privacy-statement/de_ch)  |
|Switzerland  |French  |[https://documents.myafterpay.com/privacy-statement/fr_ch](https://documents.myafterpay.com/privacy-statement/fr_ch)  |
|Switzerland  |Italian  |[https://documents.myafterpay.com/privacy-statement/it_ch](https://documents.myafterpay.com/privacy-statement/it_ch)  |
|Switzerland  |English  |	[https://documents.myafterpay.com/privacy-statement/en_ch](https://documents.myafterpay.com/privacy-statement/en_ch)  |


# Error Codes & Validations

##Error Codes

In the following, you can see the various error codes. You can also download a spreadsheet with the corresponding error messages and action codes.

### Validation error messages



|Error Code|Description|Action code|
|--- |--- |--- |
|400.000	|Unknown error|Unavailable|
|400.001	|Request body missing|Unavailable|
|400.002	|Value is required|Unavailable/ AskConsumerToReEnterData|
|400.003|Value out of range|Unavailable/ AskConsumerToReEnterData|
|400.004|Value format is incorrect|Unavailable/ AskConsumerToReEnterData|
|400.005|A string value exceeds maximum length of {value}|Unavailable/ AskConsumerToReEnterData|
|400.006|A string value with minimum length {value} is required|Unavailable/ AskConsumerToReEnterData|
|400.007|A decimal value has more than allowed decimal digits|Unavailable/ AskConsumerToReEnterData|

### Business error messages

|Error Code|Description|Action code|Field reference|
|--- |--- |--- |--- |
|400.001|Request body is empty or invalid|Unavailable|request|
|400.100|Order number is already used on the client|Unavailable|order.number|
|400.101|TotalNetAmount doesn't match with items prices|Unavailable|order.totalNetAmount|
|400.102|Order gross amount doesn't match with items prices|Unavailable|order.totalGrossAmount|
|400.103|The provided customerNumber differs from the customerNumber specified in the checkout|Unavailable|customer.customerNumber|
|400.108|Invalid payment method selected|Unavailable|payment.type|
|400.109|A valid contract id is required|Unavailable|payment.contractId|
|400.110|Installment profile not found|Unavailable|payment.installment.profileNo|
|400.111|Installment profile plans missing|Unavailable|-|
|400.112|Monthly installment amount is invalid|Unavailable|payment.installment.numberOfInstallments|
|400.113|Number of installments is not allowed for amount|Unavailable|payment.installment.numberOfInstallments|
|400.114|Invalid AccountProfileNo|Unavailable|paymentInfo.account.profileNo|
|400.115|Reservation not found|Unavailable|-|
|400.117|Cannot capture the order because full capture can only be done for the entire reserved amount within the given tolerance level.|Unavailable|-|
|400.118|Capture partial cannot capture more than the current reservation balance|Unavailable|-|
|400.119|Order items missing|Unavailable|-|
|400.120|Cannot capture the order as capture with the specified number is already exists|Unavailable|-|
|400.121|Reservation, to which this order is linked to does not have a checkout|Unavailable|-|
|400.124|The grand total of gross unit prices must be positive|Unavailable|orderItems[].grossUnitPrice|
|400.126|Cannot refund the order because specified capture was not created from reservation, to which this order is linked to|Unavailable|-|
|400.127|Cannot refund the order as refund amount is higher than the capture balance amount|Unavailable|-|
|400.128|Cannot refund the order because there are no captures related to this order|Unavailable|-|
|400.129|Cannot cancel the order, because it is partially or fully captured|Unavailable|-|
|400.131|Order not found|Unavailable|-|
|400.132|Capture not found|Unavailable|-|
|400.133|Refund not found|Unavailable|-|
|400.134|Void not found|Unavailable|-|
|400.135|Customer not found|Unavailable|-|
|400.136|Contract already exists|Unavailable|-|
|400.137|When order items are provided then capture number is mandatory|Unavailable|-|
|400.138|Shipping details not found|Unavailable|-|
|400.139|Valid BankCode is required|Unavailable|payment.directDebit.bankCode|
|400.140|Valid BankAccount is required|Unavailable|payment.directDebit.bankAccount|
|400.142|Checkout not found|Unavailable|-|
|400.144|Validation failed|Unavailable|-|
|400.146|Capture amount can't be with opposite sign to Reservation amount|Unavailable|order.totalGrossAmount|
|400.147|Void amount can't be with opposite sign to Reservation amount|Unavailable|cancellationDetails.totalGrossAmount|
|400.148|Cannot refund a negative invoice|Unavailable|-|
|400.150|Installment profile is not valid for amount|Unavailable|payment.installment.profileNo|
|400.151|IdempotencyKey is aleady used with different endpoint URL|Unavailable|-|
|400.152|DirectDebit is not enabled for client|Unavailable|-|
|400.153|A valid order number can include alphanumeric characters, dashes and underscores|Unavailable|order.number|
|400.154|totalGrossAmount cannot be negative|Unavailable|-|
|400.155|In case of partial request the totalGrossAmount is required|Unavailable|-|
|400.156|The country code is not valid for this customer|AskConsumerToReEnterData|customer.address.countryCode|
|400.157|The currency code is not valid for this customer|Unavailable|-|
|400.158|Reservation is already cancelled, captured, or expired|Unavailable|-|
|400.159|Item gross price, net price and VAT amount must be all positive or all negative|Unavailable|order.items[].grossUnitPrice|
|400.160|Gross unit price must be equal to Net unit price plus VAT amount|Unavailable|order.items[].grossUnitPrice|
|400.161|Item net price can't be bigger than gross price|Unavailable|order.items[].netUnitPrice|
|400.162|Item VAT amount can't be bigger than gross price|Unavailable|order.items[].vatAmount|
|400.166|The provided currency differs from the currency specified in the checkout|Unavailable|-|
|400.167|File format is not supported. We support the following formats: {value}|Unavailable|-|
|400.168|Order items must be specified if order amount is increased within the allowed tolerance level|Unavailable|order.items|
|400.169|Order items must be specified if order amount has changed|Unavailable|order.totalGrossAmount|
|400.170|Full refund is not allowed after partial refund.|Unavailable|-|
|400.171|Cannot refund the order as the total refund amount exceeds the maximum allowed amount.|Unavailable|-|
|400.172|The maximum Idempotency Key length is 50 characters.|Unavailable|-|
|400.173|The Idempotency key may contain alphanumeric characters and hyphens.|Unavailable|-|
|400.174|Active campaign not found.|Unavailable|payment.campaign.campaignNumber|
|400.175|The merchant id is not valid.|Unavailable|merchantId|
|400.176|The merchant id is deactivated.|Unavailable|merchantId|
|400.177|Too many operations with zero amount for this order.|Unavailable|-|
|400.178|Account number is not supported.|AskConsumerToReEnterData|bankAccount|
|400.179|B2B customers not supported for this region.|Unavailable|-|
|400.180|Nonce not found.|Unavailable|nonce|
|400.181|A valid customer card classification can include only digits from 1 to 5.|Unavailable|customer.riskData.customerCardClassification|
|400.182|Virtual bank account not found.|Unavailable|-|
|400.183|The checkout is already used by reservation.|Unavailable|checkoutId|
|400.184|totalGrossAmount is higher than order amount.|Unavailable|order.totalGrossAmount|
|400.185|Both, orderItems and items are used. Please use one or another.|Unavailable|-|


Please notice that besides the error code and action code you will also get a field reference that will help you to understand which field caused an error. For example, you may get a 400.004 error with the action code "AskConsumerToReEnterData" and field reference "customer.mobilePhone" which means that the customer has entered the mobile phone number that was in incorrect format and the customer has to insert the phone number in a correct format.

#### Exemplary Error Message:

### Errors responded by the risk check

As part of the risk assessment the consumer's input is validated against internal and external data sources. Although the input might be well-formatted, the input could be still incorrect (e.g. postal Code has the correct format but does not exist).

| Code    | Description                                                                                                                                         |
|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
| 200.001 | Sorry, the age you entered does not meet the minimum requirement (18 years), please choose a different payment method or reenter your date of birth |
| 200.002 | Sorry, B2B purchases are not allowed for this merchant. Please choose another payment method                                                        |
| 200.003 | Sorry, the payment method is currently not available. Please choose another payment method                                                          |
| 200.004 | Pick-Up-point can not be used as billing address                                                                                                    |
| 200.005 | Address of the Pick-Up-point is invalid, please doublecheck and correct it                                                                          |
| 200.006 | Billing and delivery address must be the same                                                                                                       |
| 200.101 | This billing address is invalid, please double check and correct it                                                                                 |
| 200.102 | This delivery address is invalid, please double check and correct it                                                                                |
| 200.103 | The billing address was corrected, please verify                                                                                                    |
| 200.104 | The delivery address was corrected, please verify                                                                                               |
| 200.105 | Sorry, the payment method is currently not available. Please choose another payment method                                                          |
| 200.900 | Sorry, the payment method is currently not available. Please choose another payment method                                                          |
| 200.901 | Sorry, the payment method is currently not available. Please choose another payment method                                                          |
| 200.902 | Sorry, the payment method is currently not available. Please choose another payment method                                                          |
| 200.903 | Sorry, the payment method is currently not available. Please choose another payment method                                                        |
| 200.909 | Account number from this country is not supported for this AfterPay merchant|
| 200.910 | Strong identification needed |



## Customer Facing Error Messages

These are the human-readable, descriptive messages returned by the eCom API for common business errors. They are usually due to missing mandatory information, or information provided in the incorrect format. When integrating AfterPay in your checkout page, please make sure the contents of these messages are displayed to the customer. In the following you see the customer facing error messages in English. As part of the response of our API they are translated into the local language used by the shopper.

#### Exemplary Error Message:

error-codes.xlsx

To fit into organizing nature of your business the Order Management is an important part of payments. Order Management enables you to manage all transactions that happen for an order. Easily capture previously authorized funds, void an unsettled transaction, or do a full or partial refund of a settled transaction.



Release Notes - 2016

Release Notes - 2017

Release Notes - 2018

Release Notes - 2019

What's new? 

Release Notes - 2020

Ship the goods

Based on the example of the API Walkthrough, let’s take a pretty common scenario:

*Astrid made her purchase, but the merchant checks his warehouse and sees that the leather jacket size M she ordered is not in stock. The merchant knows he is getting a new shipment of leather jackets in size M next week; he is willing to accept the cost of shipping the leather jackets separately, rather than risk losing Astrid as a customer.*

*The merchant sends Astrid an email explaining this, and then does a Partial Capture.*

The response contains the following information:

- **Captured Amount** – the total amount captured by this API call.
- **Authorized Amount** – the original amount of the full order, as it was provided in the AUTHORIZE call.
- **Remaining Authorized Amount** – how much money is left for possible captures after this partial capture.
- **Capture Number** – the unique ID of this capture in the AfterPay system. Needed for Refunds etc. 

### Important to keep in mind

Please send your own unique identifier for the specific capture into the field *invoiceNumber*. If you don't send it, AfterPay will generate a number and use this for the communication with the shopper. Using different numbers might confuse the shopper.


See the detailed [API documentation](/api/order-management/capture/) for more information.



Cancel the order

Based on the example of the API Walkthrough and Partial Capture, let’s take a common scenario:

The merchant has not shipped the socks that Astrid bought. He thought that he would get them in stock soon, but as it turns out, his supplier has stopped producing them. He sends an email to Astrid to apologize.

Fortunately, since he did not Capture the socks yet, Astrid does not have to pay anything or wait for a refund.

The merchant sends a Void / Cancellation call for the unavailable item. This is a POST call to the VOIDS endpoint of the AfterPay eCommerce API. It contains the total price of all the items being cancelled, and the individual item details (same format as in the Authorize call).

The response contains the following information:

- **Total Captured Amount** – the sum of all Captures on this order so far.
- **Total Authorized Amount** – the full order value, as originally submitted during the Authorize call.

See the detailed [API documentation](/api/order-management/void/) for more information.

Process returned items

Astrid has received her shipment, and has decided that the jacket in size M looks better on her. She uses the original packaging to send the size S jacket back to the merchant. Then she goes to MyAfterPay.com and uses the “Report a Return” feature. The merchant is notified to expect a return of the jacket.

The merchant receives the jacket, sees that it is in great condition and still has the tags attached. The refund is accepted, and the merchant issues a REFUND call from their webshop to the AfterPay eCom API. Astrid’s invoice is updated, and the cost of the jacket is deducted from the total; she only has to pay for the items she kept.

This is a POST call to the REFUND endpoint of the AfterPay eCommerce API. Embedded in the URL is the Order.Number from the AUTHORIZE and CAPTURES calls.

The API call contains the following blocks:

**Capture Number**

This is the unique ID that was provided in the response to the CAPTURES call. This tells AfterPay where to debit the money (from the merchant’s settlement account, and the specific transaction) that will be credited to the customer.

**Order Items**

This contains the same information as the AUTHORIZE (and/or CAPTURES) call, for the product(s) being refunded.

In this example, we are doing a Partial Refund – refunding only one order item out of many.

If we send the POST call to the REFUND endpoint with nothing in the body, we will be making a Full Refund – refunding all order items.

You can do multiple Partial Refunds within the same order. You can also do a Full Refund after a Partial Refund – refunding all items that were not refunded before.

See the detailed [API documentation](/api/order-management/refund/) for more information.


Visual guidelines - Logos and banners

Buy Now - Pay Later

# AfterPay's Payment Methods 

More shoppers than ever before shop on their mobile devices, and making the checkout experience as easy as possible continues to be a top priority. Pay-after-delivery services facilitate just that and allow shoppers to separate the checkout from the execution of the actual payment.

AfterPay gives shoppers the freedom to pay whenever and however they find it most convenient. AfterPay consists of two fundamental payment alternatives: Invoice and Part Payment. Each alternative offers various options, as illustrated below.

![afterpay_payment_structure.PNG](/uploads/afterpay_payment_structure_18c52b2f37.PNG)

## Invoice

Shoppers who chose AfterPay’s invoice are subject to predefined payment terms to pay the invoice and shall pay the full purchase amount on the invoice due date. The due date is always calculated based on the dispatch date of the goods, not the purchase date.

### 14 Day Invoice

The most common terms of payment are within 14 days after the purchase, which gives shoppers enough time to experience the goods before paying. The full purchase amount is to be paid by the due date.

## Campaign Invoice

During peak seasons, such as Christmas, merchants may use campaign invoicing, which allows shoppers extended payment terms per purchase or a fixed due date.

AfterPay offers standard campaigns depending on the season. Merchants are able to set up specific campaigns through separate agreements. All campaigns can be retrieved by calling the AfterPay API.

For example, Christmas campaign A would be displayed at checkout as “Buy now, pay after Christmas” and payment is due by January 31, regardless of the actual purchase date as below:

![christmas_campaign_A.PNG](/uploads/christmas_campaign_A_711167c9c8.PNG)

In contrast, Christmas campaign B would be displayed at checkout as “Buy now, pay in 30 days” and payment is due within 30 days from dispatch, as shown below:

![christmas_campaign_B.PNG](/uploads/christmas_campaign_B_4d836bcb62.PNG)

### Consolidated Invoice

Providing convenience for shoppers who frequently make small purchases, AfterPay can consolidate all these purchases into a single invoice. The most common use case is a monthly invoice, which is typically suitable for transportation tickets or digital streaming services, but the frequency of the invoicing can be agreed separately. While the actual purchases are made on different dates, the payment terms of 14 days start from the date on which the consolidated invoice is issued. An example of a consolidated invoice is illustrated below

![consolidated_invoice_new.png](/uploads/consolidated_invoice_new_419794e32b.png)

## Part Payments / Instalments

Through its part payment option, AfterPay allows shoppers to pay a particular purchase over time, enabling them to make higher order value purchases while limiting their monthly spending.

### Fixed Instalments

AfterPay offers fixed instalment plans with predefined maturities of 3, 6, 12, or 24months. The Payment API determines which of these instalment plans can be offered. The monthly amount to be paid in a fixed instalment plan is the same during the entire plan.

![fixed_instalments.PNG](/uploads/fixed_instalments_62ef6afd15.PNG)

### Flex Payment (Account)

Merchants can provide shoppers with a more flexible payment option at checkout by allowing them to control the amount they are willing to pay per month, which means there is no set maturity. However, shoppers are obliged to pay a monthly minimum as defined by AfterPay. Shoppers can alter the amount they are willing to pay every month in AfterPay’s customer portal. Additional orders can be added at any time as long as the amount does not exceed the credit limit set by AfterPay.

To use the Flex payment options, shoppers must sign a credit agreement within 14 days after receiving the first invoice, and shoppers in Sweden or Norway must also sign KALP.

The account notice is sent on country-specific dates (e.g. the 18th of the month in Sweden) and has payment terms of 12 days like the fixed instalments.

![flex_payment.PNG](/uploads/flex_payment_0e518a6c12.PNG)





# Customer Experience

AfterPay supports consumers in purchasing the items they desire by providing them with the freedom to pay whenever and however they find it most convenient. This is achieved by separating the purchase from the payment. Consequently, AfterPay distinguishes between the checkout and the post-purchase experience.

## Checkout

After shoppers add items to their shopping basket in the webshop, they proceed to checkout to complete the purchase. Checkout can be designed in various ways. It typically contains the following information blocks that are relevant for payment: personal information about the shopper, invoice and delivery address, payment method selection, and payment confirmation.

The first step is the identification step, during which shoppers are required to enter their personal details and the invoice and delivery address. In order to provide shoppers with an easy checkout experience, it is important to minimize the amount of data they need to enter. AfterPay, therefore, provides several look-up services as well as an address validation service. After having entered the required data, shoppers then proceed to the payment method selection.

AfterPay offers several different payment options that can be displayed in the payment selection step: 14-day invoice, campaign invoice, fixed installments, and flex payment. After having selected a payment method, shoppers receive either a payment confirmation or a message that the payment option has been declined. A declined message always redirects the shopper back to the payment method selection page. To illustrate a generic checkout, see below.

![customer_journey_checkout.PNG](/uploads/customer_journey_checkout_e28fdd5d10.PNG)

## Post-purchase

Shoppers’ post-purchase experience starts after they have completed the checkout process. This experience consists of two primary interfaces: invoice communication (email/text messages) and AfterPay’s customer portal, “MyAfterPay”. Shoppers can experience a merchant-branded journey throughout these touch-points. Brand hero images and product images strengthen a merchant’s brand communication and campaign messaging.

The invoice communication is triggered once the merchant dispatches the goods. This communication is normally synchronized with the ‘capture’ API request.

In MyAfterPay, shoppers can see an overview of and control all purchases and payments. After logging in to MyAfterPay shoppers instantly see currently outstanding invoices and can choose how these invoices will be paid: bank transfer, direct debit, or any other local payment methods. In MyAfterPay the shopper can choose to partially pay an invoice. By going to the ‘Purchase history’, shoppers can see an overview of all purchases/returns.

After making a purchase via MyAfterPay, shoppers can save the payment method information in order to later make convenient purchases with a one-click payment function within the portal.



In this section, we will follow the lifecycle of a transaction in detail, with examples of API calls to the AfterPay eCommerce API, and expected responses.

We encourage you to read through the descriptions here from start to finish, to get an overall grasp of the AfterPay eCommerce API and how it works. Then you can refer back as you integrate your webshop.

The examples are in JSON format, for the AfterPay eCommerce REST API v3. Examples in other formats are available in our detailed [API documentation](/api/).

Place the order

# Checkout / Authorize

Astrid places the items into her Cart, and goes to the Checkout page. She sees AfterPay as an option, and selects it.

When she clicks the Buy button, the shop sends a POST call to the AUTHORIZE endpoint of the AfterPay eCommerce API. This call contains Astrid’s name, email, national ID number, and postal address; and the details of the items she is buying. The API responds with a confirmation.

Now a reservation exists in AfterPay’s accounts, in the merchant’s name, for the purchase price. Before responding, AfterPay has used the provided details to run a risk/credit check, and is happy to accept this invoice.

The API request contains the following blocks:

**Payment**
This determines the payment method, out of those offered by AfterPay. Any method besides Invoice requires additional information; please see the detailed payment object documentation for further information.

**Customer**
This contains the customer’s personally identifiable information, including their postal address.

Mandatory fields depend on the country. Click [here](/documentation/prepare-checkout/collecting-consumer-information/) to see which fields are required for each country.

**Order**
This contains the details of the purchase:

- **Number** – this is a unique identifier for the order. It is provided by the merchant, and can be human-readable. Can contain letters, numbers, dashes, and underscores. Not case-sensitive.
- **TotalGrossAmount** – the full payable amount of the order. Sum of grossUnitPrice * quantity for all Order Items.
- **TotalNetAmount**
- **Currency**
- **Items**

**Order.Items**
Details of the items being purchased

For each order item, the following information is provided:
- **ProductID** – the unique identifier of the item in the invoice. Provided by the merchant. Can be equivalent to the merchant’s own SKU.
- **Description** – the name of the item, as it appears on the invoice line.
- **ImageURL** – the product image. Optional.
- **GrossUnitPrice** – the price for one unit of this item, including VAT.
-  **netUnitPrice** – the price for one unit of this item, excluding VAT.
- **vatPercent** – the VAT rate for this item as a number (e.g. 19% VAT - "vatPercent": 19)
- **vatAmount** – provided as a currency value, not a percentage.
- **Quantity** – the amount of units of this item included in the purchase.
- **Type** – optional parameter used to identify items like digital downloads, shipping fees, etc. These are handled differently from normal items during refunds and for accounting purposes.

See the detailed [API documentation](/api/checkout/authorize-payment/) for more information.

Get all the details

#Get Available Payment Methods

Astrid goes to the webshop and puts all the items she wants into her cart, from the individual item pages. Then she clicks on the shopping cart icon.

On the shopping cart page, the merchant shows the items she’s buying, and asks her to fill in her name, email, national ID number, and address. Astrid then clicks “Go to Checkout”. As the checkout page loads, the webshop sends a POST call to the PAYMENT-METHODS endpoint of the AfterPay eCom API. The call contains the customer’s details and the order item details.

Based on the provided information, AfterPay returns a **list of available payment methods**. The merchant can then give Astrid multiple options – the standard 14-day invoice, a Consolidated Invoice or Campaign Invoice if they are available, or Part Payment options (either a fixed-term scheme or a flexible monthly payment scheme).

The response contains the following information:

**Payment Methods** – the details of the payment methods that AfterPay is willing to accept for this order. There will be one or more blocks, each consisting of:
- **Type** – as per Payment Methods.
- **Title** – the title of this payment method, as displayed to the customer.
- **Tag** – the tagline (short description) of this payment method, as displayed to the customer.
- **Logo** – the URL of the AfterPay logo, as displayed to the customer.
- **Account** – if the type is Account, this block contains additional information about flexible monthly payments.
- **Campaigns** – if the type is Invoice and campaign invoices are currently available, this block contains additional information about the campaign.
- **Direct Debit** – if the type is Invoice and direct debit is configured, this block will read “true”. You will need to collect the customer’s bank account information and pass it to AfterPay in the Capture call.
- **Installment** – if the type is Installment, this block contains additional information about the fixed term payments.

See the detailed [API documentation](/api/checkout/available-payment-methods/) for more information.

14-Day Invoice

14-Day Invoice with Direct Debit

# Your First request to AfterPay API

In order to send requests to AfterPay, an AfterPay Sandbox account is needed. To create a new account, register on the [My Account](https://developer-sandbox.afterpay.io/) page. The API key will be generated automatically after account creation. If you don't see it immediately, refresh the "Account" page after a few seconds and it will appear. The page also shows you how long the key will be valid. Your API Key is stored in your account and will be used for authentication. API Keys have to be present in every request.

Let’s start with the easiest request in the AfterPay API - the [GetVersion](/api/common/get-version/) request. GetVersion does not require any input parameters (except your API key of course) and returns the simple message containing only the version of the API. This example serves as a baseline for future requests and introduces the core concepts in AfterPay API.
Generally, all our requests can be tested with [Postman](/partner-and-integrations/sdks/postman/), however, you can use any other API-Testing application.


### Your first transaction with AfterPay in Postman

Open Postman and an empty request window. The current tutorial shows you how to get the API Version. The [GetVersion](/api/common/get-version/) page in the documentation gives you the URL and a method for a request.

![qsg-01-blank-postman.png](/uploads/qsg_01_blank_postman_946b2821d2.png)


Insert the *https://sandbox.afterpay.io/api/v3/version* to the URL input box and select the corresponding method (GET in this tutorial) from the dropdown list. If the "Send" button is pressed, the request is sent to the AfterPay server and the response can be seen in the Postman window.

![qsg-03-set-url-method.png](/uploads/qsg_03_set_url_method_89ff02d7f7.png)



As you can see from the picture (and from your Postman window), the server responded with status code 401 Unauthorized and the response body contains an error message. The error appeared because the AfterPay API did not know who made the request and did not grant access to its services. To avoid this kind of error, the API key must be provided for authentication. There is a button with the label "Headers (0)" under the URL box. In this tab, it is possible to define the list of all headers which are sent during the request. (0) in the tab label indicates that there are currently no headers.

![qsg-04-authorization-required.png](/uploads/qsg_04_authorization_required_deee157e57.png)

For authentication, the header "X-Auth-Key" must be added to the list of headers. The value of this header will be your personal API key (you can get this key from your account).
If the request is sent again, the server responds with status code 200 "OK" and the response body contains the version of the current API.

![qsg-05-key-added.png](/uploads/qsg_05_key_added_cb161ab195.png)

The same request principles apply to the other available requests too.

#First Steps

To enable AfterPay in a first-class experience you should prepare your checkout, and then set up the authorization of the AfterPay payment options with our CheckOut Services, before you complete the integration with the order management calls. We recommend also implement our additional services (e.g. Customer LookUp) to support the collection of consumer information. They optimize the authorization and checkout experience of the consumer.

###Main Concepts

In order to easily integrate with AfterPay, we have adapted the terminology stemming from the usage of CreditCards as much as possible. Hence, our checkout services are triggered via authorization calls. You can either use the simple One-Step Authorization or Two-Step Authorization. To manage the order after authorization has been successful, use the Order Management calls: Capture, Refund, and Void. Furthermore, explore our additional services, such as the checkout optimizing Customer LookUp that minimizes the required consumer input or our Address Correction that helps to eliminate annoying errors due to typos or spelling mistakes. The validate bank account can be used to facilitate installments in the DACH region.

As stated previously, we have two ways of authorizing payment. Either you use the simple One-Step Authorization, that approves the payment based on the shopping basket (e.g. OrderValue, VAT), the consumer (e.g. Name, Address), and which AfterPay Payment Option is chosen (e.g. 14-day invoice, consolidated invoice, fixed installments, or flex payment). Or you use the Two-Step Authorization that lets you evaluate which payment options shall be presented based on the shopping basket (e.g. OrderValue, VAT) and the consumer (e.g. Name, Address).

To fit into the organizing nature of your business the Order Management is an important part of payments. Order Management enables you to manage all transactions that happen for an order. Easily capture previously authorized funds, void an unsettled transaction, or do a full or partial refund of a settled transaction.

Secure input of sensitive information

#Hosted Fields

Hosted Fields is a solution that lets merchants offer Afterpay at checkout without collecting sensitive information themselves.

The solution involves a special text entry box (or any other standard HTML data entry field) that collects data directly to AfterPay’s servers, from within the merchant’s website/app. The merchant receives only a proprietary unique ID (nonce). This can be used to identify the customer in calls to the AfterPay eCommerce API, but not to resolve the customer’s Personally Identifiable Information. This allows the merchant to avoid the obligations and risks that stem from handling sensitive data.

The solution creates a text entry box in the merchant’s website / app that is an iFrame to AfterPay’s servers. Any data entered into this field by the customer is visible only to AfterPay’s servers, and not to the merchant. The fields are displayed by the merchant’s website/app, but hosted by AfterPay’s servers.

### Nonce
Hosted Fields are designed to collect the customer’s Personally Identifiable Information (name, email, national ID number, address, etc.).

The merchant wants to minimize the amount of PII handled by their systems. However, this information is required by AfterPay for its credit/risk checks and to positively identify the customer for invoicing.

The merchant’s customer signup (or checkout) includes a transparently embedded iFrame of a text entry box (or other HTML entry field). The iFrame is hosted on AfterPay’s Hosted Fields Server. When the customer submits the form, the contents of the Hosted Field are sent directly from the customer’s device to AfterPay’s server, and never pass through the merchant’s systems.

Instead, the merchant receives a nonce – a unique string that can be used as a replacement for the customer’s PII in the Authorize call to the AfterPay eCommerce API. The eCommerce API takes the nonce and sends it to the Hosted Fields Server, which provides the original data in response, all over a secure backend connection.

You can use multiple Hosted Fields in one webform. If they are all part of a single Authorize call, the merchant will receive a single nonce in return, and all the collected data will be associated with that nonce.

### Integration

The solution includes the following components on AfterPay’s end:

**ID Service:**
- Takes the merchant’s API key
- Issues an authentication token that can be used with the Hosted Fields Server

**Hosted Fields Server:**
- Takes the customer’s authentication token
- Returns the iFrame code (Hosted Fields Client Library) for the PII field
- Takes the data that was entered into the hosted PII field
- Returns the nonce

The nonce can be used for subsequent AfterPay eCommerce API calls, as part of the Checkout Customer block. If the nonce is provided, the identificationNumber is optional.

The nonce can be used only with the same merchant API key as the one that was used to generate it. Otherwise, the eCommerce API will reject the call.

The nonce can be used only for a single Authorize call. Each checkout must be conducted with a new nonce.

Plugin

Magento payment plugin for AfterPay and Buy Now Pay Later

Versions