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.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
401unauthorized request
403forbidden request
404unknown cardholder card
409idempotency key replayed with a different body
422inaccessible account_uuid