DevelopersHomeAPI referenceGuidesChangelogMarketplacePartnersCommunityStatus

Mandates

Recurring debits with notice.

POST /v1/mandates asks the customer. Once it is active, POST /v1/mandates/{id}/debits schedules a debit, refused under 24 hours' notice. POST /v1/mandates/{id}/revoke ends it. mandate.updated reports each change.

In the sandbox, POST /v1/sandbox/mandates/{id}/approve stands in for the customer and POST /v1/sandbox/debits/{id}/execute runs a debit without waiting. A live call answers 422 no_route until your gateway supports mandates through this API.