API Documentation

Payment API

The AfterPay Management API contains resource collections for 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 request and integration examples for different platforms.

Checkout Services

POST /api/v3/checkout/authorize
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.
POST /api/v3/checkout/payment-methods
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.

Order Management

POST /api/v3/orders/{orderNumber}/captures
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.
POST /api/v3/orders/{orderNumber}/voids
Void (cancel) an authorization that has not been captured.
POST /api/v3/orders/{orderNumber}/refunds
Refunds a partially or fully captured payment.
GET /api/v3/orders/{orderNumber}
Returns the contents of the specified order
GET /api/v3/orders/{orderNumber}/voids/{voidNumber}
Returns all or specific voided (cancelled) authorizations of the order.
GET /api/v3/orders/{orderNumber}/refunds/{refundNumber}
Returns all or specific refunds of the order.
GET /api/v3/orders/{orderNumber}/captures/{captureNumber}
Returns all or specific captured payments of the order

Capture Shipping Details

GET /api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details/{shippingNumber}
Returns all or specific shipping details information of the capture.
POST /api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details
Add new shipping details information to the capture.
PATCH /api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details/{shippingNumber}
Update shipping details information of the specific capture.
DELETE /api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details/{shippingNumber}
Delete shipping details information from the specific capture.

Additional Services

POST /api/v3/lookup/installment-plans
Returns the available installment plans for the specific product/basket value. Returns monthly installment amount, interest and fees. Typically used on a product page.
POST /api/v3/lookup/customer
Returns the customers address based on social security number or mobile number.
POST /api/v3/validate/bank-account
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
POST /api/v3/validate/address
Check of 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.
POST /api/v3/checkout/{checkoutId}/contract
Creates an installment and/or direct debit contract that can be displayed for the customer.

FastTrack Services

POST /api/v3/customer-account
Apply for customer account credit
GET /api/v3/customer-account/{accountNumber}/credit-limit
Get remaining account credit limit
POST /api/v3/customer-account/{accountNumber}/event
Add event to account
GET /api/v3/customer-account/{ssn}
Find customer account by SSN (social security number)