Skip to main content
Version: 4.0.2

Charge Endpoints

The Charge API is organised into a small set of resources that together let you take a payment from order creation through to completion. A typical integration calls them in this order:

ResourcePurpose
OrderCreate the order intent (POST /order_token) that the Charge SDK is mounted against, retrieve order details, and update an order.
EntityCreate and retrieve the customer/payer entity tokens referenced by an order or charge.
Payment InstrumentCreate, retrieve, and update the payment instrument (the encrypted payment method) used for a charge.
ChargeCreate a charge, retrieve a charge by ID, search charges by order, and drive a charge's next action.

For how these endpoints fit together across your frontend and backend — when to create the order, when to mount the SDK, and how to confirm the result — see the End-to-End Payment Flow guide. For the shape of the charge object returned by GET /charge/{charge_id} and how to interpret a payment result, see the Data Model.

All endpoints share the authentication scheme and the error semantics described in Error Messages.