Capabilities
Overview
After a merchant has been successfully onboarded via the Onboardings API, you can use the Capabilities API to retrieve the merchant’s onboarding status. Capabilities API can also retrieve merchant credentials and configuration details. You can also use it to manage merchant activations for various Afterpay products.
Managing New Afterpay Merchants
Once a merchant has been successfully onboarded, you must retrieve the onboarding’s associated capabilities. You need these capabilities to verify important information such as onboarding status, merchant credentials and configuration details.
Note on status
Merchants are typically approved immediately after they have been onboarded. If a merchant onboarding is attempted and certain validations fail, the merchant is not onboarded and a 4xx is returned.
Note on credentials
The merchantId and merchantSecret are used to authenticate requests made to the Afterpay Checkout API. The merchantId and merchantSecret are specific to each merchant, so manage them securely.
Note on configuration
These configuration details specify the minimum and maximum transaction limits allowed with the Afterpay Checkout API for this particular merchant. These transaction limits are set by default. Merchants can request transaction limit adjustments by working directly with the Afterpay team. Any PSP-enforced transaction limits applied to Afterpay should follow the limits specified via the capabilities endpoint.
Enabling and Disabling Afterpay Products
The Capabilities API has several endpoints that allow partners to enable and disable specific Afterpay products. Currently, all merchants are automatically enrolled into Afterpay’s Pay by Installments (PBI) product by default and Pay Monthly (PM) if the merchant is registered in the United States.
