Afterpay
Afterpay (operating as Clearpay in the UK) is an interest-free Buy Now Pay Later product. Consumers can choose to Pay-in-4 interest-free instalments or, for qualified Afterpay consumers, an additional repayment option during checkout allows them to pay over 6 or 12 monthly instalments, available exclusively for US consumers. With a global payback rate of 95% early or on time, transparent spending limits, and capped late fees, Afterpay aims to unlock growth for merchants and prevent overspending for the consumer. Learn more about Afterpay.
Payment method properties
Markets (consumer) |
|
Processing currencies |
|
Consumer currencies |
|
Authentication methods |
|
Authentication timeout | 4 hours |
Minimum payment amount | 1.00 USD (Pay-in-4) |
Maximum payment amount | 2,000.00 USD (Pay-in-4) |
Payment instrument |
|
Recurring payments | No |
Separate captures | No |
Refund | Full - Partial - Multiple |
Refund validity | 120 days |
Disputes | Yes |
Settlement risk | No |
Make an Afterpay payment
Afterpay is available through our standardized REDIRECT flow. We recommend including all relevant settings for any authentication methods you support.
To create a Afterpay payment, you'll need to provide the following data at minimum when calling our payment charges API:
Field | Description |
---|---|
|
|
| The amount to be paid in the smallest units of the currency used. |
|
|
| The country where the consumer is shopping. |
| The consumer email. |
authenticationSettings: REDIRECT | Add the URL where the consumer should be redirected after they complete the payment. Required for the |
GuidanceTo improve the consumer experience and maximize payment approval rates with the BNPL provider, consider including the following fields. See the API Reference for full details.
Fields Description consumer.merchantConsumerReference
Helps with conversions, and chargeback investigations. consumer.billingAddress
Billing details support scoring and approval decisions. order.orderItems
Share the full cart with item-level details for optimal experience. order.shippingAddress
Include shipping details for tracking.
Request
POST /v1/payment-charges
{
"paymentMethod": "AFTERPAY",
"amount": {
"value": 1000,
"currency": "USD"
},
"consumer": {
"email": "[email protected]",
"country": "US"
},
"authenticationSettings": [
{
"type": "REDIRECT",
"settings": {
"returnUrl": "https://www.webshop.com/order-results-page"
}
}
]
}
Response
You'll receive our standard payment charge response with the available authentication methods:
{
"id": "charge_Y3JVzvEaJpvG53xd2R2Zt",
"paymentMethod": "AFTERPAY",
"paymentMedium": "ECOMMERCE",
"scheduleType": "UNSCHEDULED",
"instrumentId": "instr_Asu0ig2PXXZSiNrhY44A5",
"currency": "USD",
"country": "US",
"status": "AUTHENTICATION_PENDING",
"consumer": {
"email": "[email protected]",
"country": "US"
},
"authenticationMethods": [
{
"details": {
"requestUrl": "https://redirection-target.ppro.com",
"requestMethod": "GET"
},
"type": "REDIRECT"
}
],
"authorizations": [
{
"id": "authz_aPobet0FNZNU1bYqfexFd",
"amount": 1000,
"status": "AUTHENTICATION_PENDING",
"createdAt": "2025-06-21T08:34:20.766Z",
"updatedAt": "2025-06-21T08:34:20.766Z"
}
],
"captures": [],
"refunds": [],
"voids": [],
"createdAt": "2025-06-21T08:34:20.114Z",
"updatedAt": "2025-06-21T08:34:20.766Z",
"_links": {
"authorizations": {
"href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/authorizations"
},
"captures": {
"href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/captures"
},
"refunds": {
"href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/refunds"
},
"voids": {
"href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/voids"
}
}
}
Pick the desired authentication method
REDIRECT
- Redirect your consumer to the returned
$.authenticationMethods[?(@.type == "REDIRECT")].details.requestUrl
.
For example, with the value ofhttps://redirection-target.ppro.com/
using the returned$.authenticationMethods[?(@.type == "REDIRECT")].details.requestMethod
HTTP method. - The consumer will be presented with the reference number and instructions to complete the payment.
Handling the payment result
REDIRECT
- After the consumer completes the payment, they are redirected to the
returnUrl
specified in the payment charge creation request. - Upon redirect back to your site, retrieve the latest payment status by performing a GET /v1/payment-charges/{paymentChargeId}. Use the returned
status
field to determine and display the final payment outcome to the consumer. - Additionally, webhooks are triggered to notify you of the payment result. This ensures you receive the outcome even if the consumer closes their browser or fails to return to your website.
Payment instrument
A PASSTHROUGH_WALLET
instrument will be created for Afterpay, with no additional data provided.
Request
GET /v1/payment-instruments/{instrument-id}
Response
{
"id": "instr_Asu0ig2PXXZSiNrhY44A5",
"type": "PASSTHROUGH_WALLET"
}
Sandbox testing
Updated 4 days ago