Integrating Afterpay
Auth: API key · Partner program: not required · Setup time: about 10 minutes · Last verified: 2026-05-15
BNPL in the US, Australia, and New Zealand — Pay-in-4 and Pay Monthly. Block-owned (parent of Cash App).
Auth model
Section titled “Auth model”
rawis opt-in. The upstream payload is withheld unless an operator enablesdata_store.raw_payload.paymentsin Admin → Settings → Data store. It is off by default because across the payments adapters it declares bank account numbers, IBANs and card numbers the canonical schema does not expose.
HTTP Basic from merchantId:secretKey. Region-specific hosts:
- US:
api.us-sandbox.afterpay.com/api.us.afterpay.com - AU/NZ:
api-sandbox.afterpay.com/api.afterpay.com
Sandbox credentials are generated through the Cash App developer portal (Afterpay’s sandbox lives under the broader Cash App developer tooling); live keys come from the Afterpay merchant dashboard.
Required adapter quirks
Section titled “Required adapter quirks”- Same installments-vs-principal model as Klarna and Affirm —
Charge.amountis the order principal; installment schedule lives inraw. - Capture is required. Afterpay authorises at customer-confirm time, but merchants must explicitly call
captureCharge(defer-shipping flow) before the auth expires (~24h depending on region). requestIdidempotency. Every refund needs a unique request ID; the adapter generatesoi-<timestamp>automatically.
Webhooks
Section titled “Webhooks”Configure in the merchant dashboard. HMAC-SHA-256 of the raw body keyed with the configured secret, hex-encoded in Signature.
References
Section titled “References”- Developer portal (entry point for Afterpay Online, Partner API, and Button docs): https://developers.afterpay.com/
opensteward.dev ·Plans and free license ·Terms ·Privacy ·support@opensteward.dev
© 2026 Falco Consulting AB. Built from open-steward/opensteward@a3961d8. This site sets no cookies, runs no analytics and loads nothing from other sites, except platform logos from Brandfetch on the Platforms page.