Afterpay API

Name: Afterpay API API
Brand: Afterpay API
Availability: InStock

★ Only Publicly Available SpecPaymentsPayment Processingbasic40 EndpointsREST

For Agents

Create Afterpay/Clearpay checkouts, capture and refund BNPL orders, manage disputes, and exchange merchant configuration for buy-now-pay-later commerce.

Quickstart

Get started with Afterpay API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"create an afterpay checkout"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Afterpay API API.

Create a BNPL checkout token redeemable on the Afterpay-hosted payment page

Authorise and capture an Afterpay order against a completed checkout

Issue full or partial refunds on a captured Afterpay order

Submit and track dispute responses including evidence files

Exchange merchant configuration and product mapping data with the Afterpay platform

GET STARTED

Start building with Afterpay API API

Explore with Jentic

View OpenAPI Spec

Use for: I need to create an Afterpay checkout for a $200 cart, Capture a previously authorised Afterpay order, Issue a partial refund on an Afterpay order, Retrieve the status of a Clearpay checkout token

Not supported: Does not handle traditional card processing, recurring subscriptions, or general invoicing — use for buy-now-pay-later checkout, capture, refund, and dispute flows only.

Jentic publishes the only available OpenAPI specification for Afterpay API, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for Afterpay API, keeping it validated and agent-ready. Afterpay (also branded Clearpay in the UK) is a buy-now-pay-later checkout service that splits a purchase into four interest-free instalments. The API covers the full BNPL flow: creating checkouts, authorising and capturing orders, processing refunds, exchanging configuration data with the merchant platform, handling disputes, and managing post-purchase grants and adjustments.

Use Cases

Patterns agents use Afterpay API API for, with concrete tasks.

★ BNPL Checkout for E-Commerce

Online retailers add Afterpay as a checkout option so shoppers can split a purchase into four interest-free instalments. The merchant calls POST /v2/checkouts with the cart total and shopper details, redirects the buyer to the Afterpay-hosted page, then captures the order on completion. Typical conversion lift on eligible carts is in the 10-20% range and integration takes a few days.

Create an Afterpay checkout for a $249 USD cart with the shopper's billing details and return the redirect URL for the hosted page

Order Capture and Refund Operations

Once a shopper completes the Afterpay checkout, the merchant captures the order to take the funds, and later issues partial or full refunds when goods are returned. The Orders and Payments endpoints expose the same lifecycle a card processor does — authorise, capture, refund — but settled against Afterpay's instalment ledger rather than a card network.

Capture an authorised Afterpay order by token and then issue a $50 partial refund when the customer returns one item

Dispute Handling Automation

Afterpay merchants face chargebacks and customer disputes that require evidence submission within tight windows. The Disputes endpoints let an integration list open cases, fetch the response template, and submit evidence (proof of delivery, communications) programmatically — replacing manual portal work that often misses deadlines.

List all Afterpay disputes opened in the last 14 days and submit standard delivery-proof evidence on each one before the response deadline

AI Agent BNPL Operations

Through Jentic, an agent can manage Afterpay operations — quoting checkouts, capturing orders, issuing refunds, and watching disputes — without holding the merchant's basic auth credentials directly. Jentic isolates the credential per call, returning a structured response the agent can reason over.

Search Jentic for 'create afterpay checkout', load the schema for POST /v2/checkouts, and execute it for a $99 USD test cart

Key Endpoints

40 endpoints — jentic publishes the only available openapi specification for afterpay api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/v2/checkouts

Create a checkout token for the BNPL flow

GET

/v2/checkouts/{token}

Retrieve the status of a checkout

GET

/v2/configuration

Fetch merchant configuration

GET

/v2/configuration/mappings

List merchant product mappings

POST

/v2/checkouts

Create a checkout token for the BNPL flow

GET

/v2/checkouts/{token}

Retrieve the status of a checkout

GET

/v2/configuration

Fetch merchant configuration

GET

/v2/configuration/mappings

List merchant product mappings

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Afterpay basic auth credentials are stored encrypted in the Jentic vault. Agents receive scoped access at execution time — the merchant ID and secret never enter the agent's context, which matters for PCI scope and partner contract compliance.

Intent-based discovery

Agents search Jentic by intent (e.g., 'create a buy-now-pay-later checkout') and Jentic returns the matching Afterpay operation with its parameter schema, so the agent picks the right endpoint without reading Afterpay docs.

Time to first call

Direct Afterpay integration: 3-5 days for auth, checkout, capture, refund, and dispute handling. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Affirm API

US-focused BNPL provider with longer-term financing options alongside split-pay.

Choose Affirm when the customer base is US-heavy and merchants want larger ticket financing (6-36 months). Choose Afterpay for the standard pay-in-four flow.

Complementary

Stripe API

General-purpose payments platform that can route Afterpay alongside cards and wallets.

Use Stripe when the merchant wants Afterpay as one of many payment methods with unified reporting. Use Afterpay direct for tighter merchant terms or non-Stripe stacks.

Alternative

PayPal Invoicing API

PayPal offers Pay Later as part of its checkout for merchants already on PayPal.

Pick PayPal Pay Later when the merchant is already on PayPal and wants BNPL inside that checkout instead of a separate Afterpay flow.

Complementary

Shopify Admin API

Storefront platform that often hosts the cart Afterpay is checking out.

Pair with Shopify when the merchant uses Shopify as the storefront and needs Afterpay called from the cart for eligible orders.

FAQs

Specific to using Afterpay API API through Jentic.

Why is there no official OpenAPI spec for Afterpay API?

Afterpay does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Afterpay API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Afterpay API use?

Afterpay uses HTTP Basic authentication with a merchant ID as the username and a secret as the password, encoded into the Authorization header. Through Jentic, the basic credential is stored encrypted in the vault and injected at execution time.

Can I issue refunds with the Afterpay API?

Yes. After capturing an order, use the Payments endpoints to issue a full or partial refund on the captured amount. Refunds settle against the original instalment plan rather than going back to a card.

What are the rate limits for the Afterpay API?

Afterpay's public spec does not include hard rate limits. Plan for a few requests per second per merchant in steady state and back off on HTTP 429. Spike traffic for sale events is best paced with a queue in front of /v2/checkouts.

How do I create a checkout through Jentic?

Search Jentic for 'create afterpay checkout', load the schema for POST /v2/checkouts, and execute the call with the cart total and shopper details. Jentic returns the checkout token so your storefront can redirect the buyer to the Afterpay-hosted page.

Is the Afterpay API free to use?

The API itself is free for merchants under contract with Afterpay/Clearpay. The cost model is a per-transaction merchant fee, set in the merchant agreement, plus regional VAT where applicable.