Afterpay API

Name: Afterpay API
Brand: Afterpay API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentPaymentsPayment 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.

Install Jentic One Beta

Connect the Afterpay API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Afterpay API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Afterpay 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

GET STARTED

Start building with Afterpay API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Afterpay 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 Jentic?

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

Credential isolation

Your Afterpay merchant id and secret are stored once, encrypted, by your own Jentic One instance as basic-auth credentials and injected at execution time. They never enter the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'create a buy-now-pay-later checkout', and Jentic returns the matching Afterpay operation with its parameter schema so the agent calls the right endpoint without browsing the reference docs.

Time to first call

FAQs

Specific to using Afterpay 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 with Jentic One, the self-hosted execution layer.

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.

Can I limit what my agent is allowed to do with the Afterpay API?

Yes. Because you run Jentic One yourself, your own rules decide which Afterpay operations and credentials the agent may use, and you choose which operations are in the allowed set. Since checkout reads put the token in the URL path at /v2/checkouts/{token}, a rule can pin the agent to reading one specific checkout while checkout creation, which takes its input in the request body, stays out of the allowed set unless you add it. That lets you grant capture, refund, and dispute operations to the agent without ever exposing checkout creation.