API Reference

Complete reference documentation for the Checkout API.

Base URL

All API requests should be made to:

https://checkout-api.exodus-int.com

Authentication

All API requests require authentication using your API key in the Authorization header.

headers: {
  'Authorization': 'Bearer sk_live_xxxxxxxxxxxxxxxx'
}

Pagination

The checkout, payment, subscription, subscription charge, subscription checkout, and webhook event list endpoints are cursor-paginated and take the same three parameters. Lists are returned newest first, and the order is not configurable. Endpoints that return a fixed set of configuration rows, such as GET /payments/settlement, are not paginated, and the payouts endpoints document their parameters on their individual pages.

Each response carries object: "list", the rows in data, and a has_more boolean.

{
  "object": "list",
  "data": [{ "id": "chk_1234567890abcdef" }],
  "has_more": true
}

Omit both cursors to get the first page. To walk forward, take the last id of a page and pass it as starting_after. To walk back, take the first id and pass it as ending_before.

starting_after and ending_before are mutually exclusive. Sending both is a 400, since the two ask for opposite directions from different anchors and there is no sensible page to return:

{
  "error": {
    "type": "validation_error",
    "message": "starting_after and ending_before are mutually exclusive",
    "param": "ending_before"
  }
}

Endpoints

Checkouts

Create and manage one-time payment sessions.

Subscription Checkouts

Single-use intents that authorize a customer to start a subscription. Customer pays the first charge and signs the on-chain authorization atomically; the resulting Subscription is the durable billing record.

Subscriptions

Manage active subscriptions. Subscriptions are created when a customer completes a Subscription Checkout. There is no direct POST /subscriptions endpoint. Each charge is authorized with the @exodus/checkout-signer SDK; cap/budget raises are subscriber-authorized on-chain.

Subscription Charges

Per-attempt records of cycle charges. Both succeeded and failed attempts are persisted with a typed failure_reason for dunning and reconciliation.

Payments

View payment details, capture and refund two-step payments, and recover stranded funds.

Payouts (Beta)

Off-ramp crypto to a beneficiary’s bank account in fiat. See the Payouts overview.

Beneficiaries — bank accounts that receive fiat.

Customers — people who send crypto, after a one-time KYC.

Payouts — off-ramp transactions that move the funds.

Reports

Export data as CSV for accounting and reconciliation.

Settings

Read your business configuration and register the signer, settlement address, and webhook URL.

Webhooks

Receive real-time event notifications.