Create a Recurring Charge

Creates a recurring "money-in" schedule that automatically charges the cardholder card on a cadence (weekly, biweekly, monthly, or the exact 1st & 15th). The funding source each run draws from is resolved by the platform from the card in the path (the cardholder's highest-priority active payment method); partners neither see nor supply one. The first run is scheduled, not charged synchronously. Send an Idempotency-Key to make retries safe: a repeat with the same key and body replays the original schedule with its original 201 status and an Idempotent-Replayed: true response header (so a replay is told apart from a fresh create by that header, not by the status), and the same key with a different body is a conflict (409). 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 charged each run, in major units. At most 2 decimal places; a more precise amount is rejected (422).

uuid
required

Accounting-API account each generated charge credits.

string
enum
required

weekly, biweekly, monthly, or semimonthly_1_15 (exact 1st & 15th).

Allowed:
date
required

First run date; anchors weekly/biweekly/monthly.

date | null

Stop on/after this date; null = open-ended.

string | null

Applied to each generated charge: 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 replayed with a different body

422

inaccessible account_uuid

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