Create a One-Time Charge

Partner-initiated "money-in": charges the cardholder card in the path and credits the given Accounting-API account. The funding source is resolved by the platform from that card (the cardholder's highest-priority active payment method); partners neither see nor supply one. Idempotent via the Idempotency-Key header (per card, per day): a retry replays the original charge with its original status and an Idempotent-Replayed: true response header, so a replay is told apart from a fresh create by that header rather than by the status. The account_uuid must be an active Accounting-API account of a Business Partner this partner is entitled to, so charging onboarding also requires an accounting_api entitlement. Charging itself is entitled separately from the rest of the Distributor API: a partner without a distributor_charging role is refused (403), so charging can be withheld per distributor.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Body Params
float
required

Amount to charge, in major units. At most 2 decimal places; a more precise amount is rejected (422).

uuid
required

Accounting-API account (a LedgerPosition) to credit.

string | null

Optional: other, donation, gift.

string | null
string | null
Headers
string

Client-generated key that makes a retried create safe (honoured per card, per day).

Responses

401

unauthorized request

403

forbidden request

404

unknown cardholder card

409

idempotency-key conflict

502

pending charge whose authorization could not be resolved

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*