welcome.svg

Start offering AfterPay now!

You are able to integrate via one of our existing connections using our plugins, payment service providers, connected platforms or you can build your own direct connection via the AfterPay API to integrate our payment methods, such as Invoice, Direct Debit, Business to business, Installments or Campaign invoice into your website or app.

If you want to connect with AfterPay via one of our plugins, payment service providers or connected platforms please proceed to our manual page.

If you want to build a direct API connection you can start exploring our API with the Sandbox. In this environment you can create your own API key to start testing and see the webservice logs.

plugins.svg

createSandbox.svg

Partner & Integrations

AfterPay Sandbox

<br/>

If you want to dive into the documentation directly you can proceed to one of the pages below.

Find all the calls for our API’s with detailed descriptions.

Get guided through our direct API integration - step by step.

See our complete list of available payment methods.

thumbnail_api.jpg

api.jpg

thumbnail_documentation.jpg

documentation.jpg

thumbnail_payment-methods.jpg

payment-methods.jpg

Documentation

Our payment methods

API Specification

Payment Methods

<br/>

### Pricing and contract
Before you can go live with your AfterPay connection you need to have a contract in place. If this is not yet the case for you, you can request a contract and pricing via the button below.

GET PRICING!

Welcome to the Developer Portal

#We are sorry :(

##We are sorry! We could not find this page. Please try again.

404 - Content not found

Invoice Element

AfterPay Elements

AfterPay Basics

First API Call

Main Flow

References

Introduction

Validations & Error Codes

LegalForm

Payment Method Presentation

Collecting Consumer Information

Prepare Checkout

Authorize Payment

Get Available Payment Methods

Checkout

Void

Refund

Capture

Order Management

Hosted Fields

IBAN Tokenization

Address Correction

Idempotency

Customer Lookup

Additional Services

Consumer FAQ

Legal & Privacy Texts

Logo & Visual Guidelines

Reconciliation & Accounting with AfterPay

Compliance Requirements

Compliance Requirements *New

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

Customer Account

FastTrack Services

Product

Common

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.


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

Postman

Swagger

SDKs

Adyen

Buckaroo

CM.com

Cardgate

Computop

DigiWallet

Ingenico

MultiSafepay

Pay.

PayPro

Sisow

PSPs

050media

CCV Shop

Cloudcommerce

Divide 

Lightspeed

Logic4

Magento

Magento 1 

Magento 2

Mijnwebwinkel

MyShop

NextChapter

Prestashop

Shoppagina

Shoptrader

Shopware

Shopware 5

Shopware 6.3

Shopware 6.4

Spryker New

WooCommerce

Plugins

Our standardised connections

## Welcome to our FAQ

#### If your question is not listed, always feel free to contact us.



### Onboarding



**1. When do we get access to the test environment/production environment?**

Access to the test environment usually takes place as soon as all formalities (e.g. conclusion of contract) have been settled. In this case you will receive the API key for the test environment. 
You will receive the API key for the production environment as soon as all necessary tests have been performed on the test environment and we are sure that no further problems occur.
<br/>

**2. What is the difference between sandbox, the test environment and the production environment?**

- Within the Sandbox you can get started right away and get to know AfterPay. You will be granted access rights immediately and you can view log files and test positive results for customer orders.

- Within the test environment you can also test negative results for customer orders, but you have to contact us to get access. Log files can no longer be viewed here.

- Within the production environment, AfterPay runs live in your online store, so it is integrated into the daily business and customers can actively use AfterPay 	

<br/>

**3. Which store systems are supported by AfterPay?**

All store systems supported by AfterPay can be found [here](https://developer.afterpay.io/partner-and-integrations/)
<br/>

**4. What is the endpoint for the test environment?**

The endpoint for the sandbox: https://sandboxapi.horizonafs.com/

The endpoint for the test environment : ://api-pt.afterpay.io/
<br/>

**5. Which endpoint needs to be entered for the production environment?**

https://api.afterpay.io		
<br/>

**6. Do I get a technical contact?**

Depending on the type of integration, you may be assigned a technical contact. Otherwise, merchant support is available to answer your questions.
<br/>

**7. Which fields within the API calls are necessary?**

The required fields can be found on this page https://developer.afterpay.io/api/ . To do this, select the required call and receive a list of all fields, with the required ones marked accordingly.
<br/>

**8. Do I need a seperate API key for each country?**

Yes, for the live environment you need a separate API key for each country. In the test environment, it is sufficient to obtain a key for Switzerland and Germany, as the key for Germany can also be used for Austria should you wish to use AfterPay for these countries.
<br/>

**9. Is the implementation of profile tracking mandatory?**

Usually, profile tracking must be included in Germany. Of course, exceptions may be made. Check your contract to see whether profile tracking has been agreed on or not.
<br/>

**10. How do I implement profile tracking?**

Please have a look at the profile tracking Guide, which you received from us separately. Generally speaking, you can say that with a direct integration you need a profile tracking tag, whereas with a plug-in integration you only need to insert the profile tracking ID into the corresponding field.
<br/>

**11. Where do I get the profile tracking ID from?**

Your designated implementation manager will give you the ID.
<br/>



### Testing


**1. Why don't we receive billing emails for trial orders?** 

Unfortunately, we cannot send invoices from our test environment.
<br/>

**2. What does the following error code xxx tell me?**

For a detailed list of all possible error codes, as well as their meaning, please refer to the following [page](https://developer.afterpay.io/documentation/prepare-checkout/validations-and-error-codes/).
<br/>

**3. Does AfterPay have an Integration Guide?**

Yes the integration guide will be sent to you after the contract has been signed.
<br/>

**4. How can I test my trail orders?**

You can perform test orders initially via the sandbox. If you have already signed the contract, you will get access to the AfterPay test environment, where you can test the cases from the test matrix you receive from us.
<br/>

**5. A customer wants to place an order later. Does an authorisation then have to be carried out again later?**

If the order is completed within the next 30 days, this is not necessary, as successful authorisations are stored with us for this period.
<br/>


### Live


**1. Does an invoice number have to be transferred?**

An invoice number is not mandatory. If an invoice number is transferred, however, this will also be used. 
If none is transferred, the API will assign an invoice number independently.
<br/>

**2. Why is the capture rejected?**

Captures are usually rejected if there is an error in the implementation and thus in the call. If this can be ruled out, the problem is usually that a capture with the same number has already been made. In this case we ask to use another number.
<br/>

**3. Why was the transaction rejected?**

The transaction can be rejected for various reasons. If a technical error can be ruled out, the reason for rejection is usually due to our risk assessment. AfterPay always strives to keep the risk of default as low as possible and for this reason declines some transactions.
<br/>

**4.  How do I pay AfterPay's fees?**

Depending on the agreed condition in the contract, the settlement will be as follows:
- At the end of the month an invoice will be issued which will be deducted from the next invoice.
- The fees will be deducted immediately with the respective invoice.
<br/>

**5. How do I resend an invoice?**

If the end customer needs a new invoice, they should contact customer service. If the merchant has a question about his invoice, he should contact Operational Finance.
<br/>

**6. An error has occurred with an order and I can't get any further. What can I do?**

Contact Merchant Support. Describe your problem as precisely as possible and tell them the order number for which you need help. One of the support staff will try to deal with the problem as quickly as possible.
<br/>



### Consumer FAQ

Here you can find common used FAQ for consumers 

## Cookie Policy
Cookies are small files that are temporarily placed on your hard drive. They are used only to obtain information on the use of the Arvato Holding AB website. This makes it possible to recognize your computer automatically the next time you view the Arvato Holding AB website. However, cookies contain no personal data, so the protection of your private sphere is ensured. Depending on your settings, your Internet browser may automatically accept cookies. However, you may also change your browser settings at any time and use the Arvato Holding AB website without cookies.

## Disclaimer
AfterPay Service Desk (“Service Desk”) is operated by Arvato Holding AB and all rights thereto are owned and reserved by Arvato Holding AB. The Service Desk allows individuals from the public to log support and other tickets on a private instance of Atlassian’s Service Desk.

Neither Arvato Holding AB or Atlassian shall be liable to you for any loss of use, lost or inaccurate data, lost profits, failure of security mechanisms, interruption of business, delays or any direct, indirect, special, incidental, reliance or consequential damages of any kind, regardless of the form of action, whether in contract, tort (including negligence), strict liability or otherwise, even if informed of the possibility of such damages in advance.

You further acknowledge and agree that any text, data, content, code, video, or other materials of any type that you upload, submit, or otherwise transmit to or through the service desk are not confidential and can be used or shared by Arvato Holding AB in accordance with the privacy policy of Arvato Holding AB or Atlassian.

Service Desk is provided “as is,” and Atlassian and its suppliers expressly disclaim any and all warranties and representations of any kind, including any warranty of non-infringement, title, fitness for a particular purpose, functionality, or merchantability, whether express, implied, or statutory.

Imprint

# Privacy Policy

### Data protection on the website of Arvato Holding AB
Arvato Holding AB welcomes your visit to our website and your interest in our company and range of services. Protection of personal data is important to us. All the web-based activities of Arvato Holding AB occur in accordance with applicable legal provisions on the protection of personal data and data security. This data protection information notifies you about how Arvato Holding AB handles information collected during your visit to the website of Arvato Holding AB.

### Collection and processing of personal data
The website of Arvato Holding AB can generally be used without providing personal data. Personal data refers to all information that identifies you, such as your name, your email address, or your mailing address. Such data is stored only if you provide it to Bertelsmann SE & Co. KGaA, for example, when ordering information or subscribing to the newsletter.

Arvato Holding AB ensures all data to be stored safely and takes all precautions on security to prevent unauthorized access to information. We would like to emphasize that you shouldn’t share your personal information with 3rd parties for your information security.

### Use and transmission of personal data
Except in the cases described here, Arvato Holding AB will use your personal data exclusively for the purpose of technical administration of the website, to give you access to special information and to provide you our products and services and for general communication with you. Except in the cases described here, Arvato Holding AB will not transmit your personal data to third parties or use it elsewhere.

Personal information will never be shared with third parties except for cases such as court ruling in accordance with legislative harmonization, legal exceptions, exceptions mentioned in this Privacy Policy and personal approval for information sharing. In cases of forgery/fraud, investigation, or information security breach, Arvato Holding AB reserves the right to partner with legal authorities and reveal all kinds of information (including personal) when requested by judicial authorities.

The employees of Arvato Holding AB are obliged to maintain confidentiality.

Privacy Policy

What's new?

Release Notes - 2016

Release Notes - 2017

Release Notes - 2018

Release Notes - 2019

Release Notes - 2020

Release Notes - 2021

## Releases in previous years

- [Release Notes - 2021](/release-notes-2021/) 
- [Release Notes - 2020](/release-notes-2020/) 
- [Release Notes - 2019](/release-notes-2019/) 
- [Release Notes - 2018](/release-notes-2018/) 
- [Release Notes - 2017](/release-notes-2017/) 
- [Release Notes - 2016](/release-notes-2016/) 

Release Notes

# AfterPay Elements

AfterPay elements are informational components for customers and should be displayed on product page to ensure the customer is informed about AfterPay purchase option. They are hosted in Content Delivery Network (CDN) to ensure the best performance and availability for your website. Furthermore, you do not have to take care of changes. That is all done by AfterPay.

### How to use AfterPay Elements

Include the scripts from AfterPay CDN. Add these two lines to your HTML (for instance, at the end of the 'head' element). 
Why two lines? It's a performance optimization called Differential Serving. Only older browsers will load the second script file - modern browsers use the first one, which is smaller and faster.

```
<script type="module" src="https://cdn.myafterpay.com/elements/v1/build/afterpay-elements.esm.js" async="true"></script>
<script nomodule src="https://cdn.myafterpay.com/elements/v1/build/afterpay-elements.js" async="true"></script>
```

# Invoice Element

For merchants convenience we have an AfterPay Invoice Element which will show relevant and useful information about 14-day invoice to the customer before the checkout stage. This will ensure that the customer is aware of payment possibility with AfterPay which could lead to a purchase decision.

To include this component to your webpage please ensure you have AfterPay CDN scripts present in page HTML and use this snippet where the element should be displayed. Note: this element acts as a div and takes up a whole row in its parent container, also it is responsive and will change size based on the screen size. 

Invoice element demo

'modal-body-inner': customize the content of modal window opening from LEARN MORE button.

### Choosing the language

HTML attribute 'language' should correspond to the language that the customer is using currently.

Supported languages:
* English - "en"
* German - "de"
* Finnish - "fi"
* Swedish - "sv-SE"
* Danish - "da"
* Norwegian - "no"
* Dutch - "nl"

### Custom text in Read More modal

Clicking on the Read More button opens a overlay modal which contains additional information about 14-day invoice.
Using slots you can have custom information in Read More modal.
Custom message must be in a div HTML tag container with slot="modal-body-inner" attribute:

```
<afterpay-invoice language="nl">
    <div slot="modal-body-inner">
        <h1>Hello world!</h1>
    </div>
</afterpay-invoice>
```

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

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.

All the Checkout API Calls in more detail

# API Documentation
 
## Checkout API Calls

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.



#API Documentation

## Additional Services

AVAILABLE INSTALLMENT PLANS

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


CUSTOMER LOOKUP

UPDATE CUSTOMER

VALIDATE BANK ACCOUNT

VALIDATE ADDRESS

CREATE CONTRACT

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



Get started and explore

# Sandbox
Get access to our sandbox, start to explore our APIs and build the integration.

Click [here](https://developer-sandbox.afterpay.io/) to create your account.

## What is AfterPay Sandbox
The sandbox environment is built for you to generate your own API keys, run different API queries, inspect system logs and easily test your integration with our platform without needing any contact with us in advance. This is a no-strings-attached test environment for you to get to know our service.

> Note, once you start onboarding with us you will get access to the real partner test environment you will use to build your integration with us before go-live.

**Where to Start?**

[Create an account](https://developer-sandbox.afterpay.io/account/register) or [log in](https://developer-sandbox.afterpay.io/).

### Generate your Sandbox Credentials

The first page you will see once you have logged in is the Credentials page. Since AfterPay API keys are country-specific you are able to choose the Country and generate the credentials you need to test AfterPay. Note, the API keys are valid for 1 year.

In addition, you can also download our Postman test scenarios and the pre-set environments from the “Credentials”- Page, which you can find after you logged into your Sandbox-Account. These can be imported into Postman. To do this, select "File" at the top of Postman. Next click on "Import" and then "Upload File". Finally select the downloaded file for the credentials. Postman will now import the required variables for the environments.
[Here](/uploads/After_Pay_Recommended_Integration_Guide_4ae386839a.pdf) you can download the Recommended Integration Guide showing you each call definition and its structure.

You can download and create a free account to postman [here](https://www.postman.com/downloads/).

![tempsnip.png](/uploads/tempsnip_1d5023142c.png)

### Postman scenarios

To allow you to get a full experience of our API we allow you to add specific triggers in your API calls to generate specific outcomes. On the Triggers page, you can see what these triggers are. To get a specific outcome all you have to do is insert the trigger in the destined field in the API call.

![tempsnip1.png](/uploads/tempsnip1_458b75e10d.png)
 
### Clear Sandbox Database

On this page, you can clean up the Sandbox database. All data related to your account (voids, captures, refunds, reservations, contracts, orders, checkouts and communication logs) will be deleted.

![tempsnip2.png](/uploads/tempsnip2_41c06e6455.png)

### Communication Logs

On the communication logs tab, you will find the latest communication log records for your Sandbox environment. The newest logs are on top.

![tempsnip3.png](/uploads/tempsnip3_7b1dc4455a.png)

### Supported Locals on the Sandbox Environment

This table specifies the supported combinations of country, currency and language.

![tempsnip4.png](/uploads/tempsnip4_3b2cdd922a.png)

### Not supported functionalities

Our Sandbox does not support the following features:

- You cannot perform a risk check to see how AfterPay will react when you enter real invalid customer or billing data.
- You cannot create and export invoices.
- You cannot generate and export settlement and reconciliation files.

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.

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.

# 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

Get Started

# Settlement

This page has been moved. You will see the content [here](https://www.figma.com/proto/62r1vMZu420sMgTg0tMQH4/AP---Reconciliation--%26-Accounting-Manual?page-id=1%3A36&node-id=136%3A2768&starting-point-node-id=136%3A2751).