Skip to main content
A mandate (mdt_*) is a payer’s consent to let you charge their saved card while they’re away, within the terms they accepted. To learn more, see Charge a saved card.

Example

GET /mandates/{mandateId}
The object is everything inside data. The field names below are relative to it: attributes.paymentMethod is data.attributes.paymentMethod in the response.

Fields

string
required
Mandate ID (mdt_*).
string
required
Resource type. Always mandate.
object
required
The mandate’s details.

Statuses

Permissions

Get needs mandates.read. Revoke needs any of externalParties.create, payments.create or paymentIntents.create.

Events

Errors

See the error codes these endpoints return.

Sandbox simulations

None.