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.
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.
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.
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.
Void (cancel) an authorization that has not been captured.
Refunds a partially or fully captured payment.
Returns the contents of the specified order
Returns all or specific voided (cancelled) authorizations of the order.
Returns all or specific refunds of the order.
Returns all or specific captured payments of the order
Capture Shipping Details
Returns all or specific shipping details information of the capture.
Add new shipping details information to the capture.
Update shipping details information of the specific capture.
Delete shipping details information from the specific capture.
Returns the available installment plans for the specific product/basket value. Returns monthly installment amount, interest and fees. Typically used on a product page.
Returns the customers address based on social security number (national ID number) or mobile number. Works only for B2C customers (private persons), cannot look up companies.
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
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.
Creates an installment and/or direct debit contract that can be displayed for the customer.
Apply for customer account credit
Get remaining account credit limit
Add event to account
Find customer account by SSN (social security number)