Mandates

A Mandate is a record of the permission that your customer gives you to debit their payment method.

Was this section helpful? Yes No

Retrieve a Mandate

GET / v1 / mandates /:id

The Mandate object

Attributes

id string Unique identifier for the object.
customer _ acceptance object Details about the customer’s acceptance of the mandate.
payment _ method string Expandable ID of the payment method associated with this mandate.
payment _ method _ details object Additional mandate information specific to the payment method type.
status enum The mandate status indicates whether or not you can use it to initiate a payment. Possible enum values active The mandate can be used to initiate a payment. inactive The mandate was rejected, revoked, or previously used, and may not be used to initiate future payments. pending The mandate is newly created and is not yet active or inactive.
type enum The type of the mandate. Possible enum values multi_use Represents permission given for multiple payments. single_use Represents a one-time permission given for a single payment.

More attributes

object string, value is "mandate"
livemode boolean
multi _ use nullable object
on _ behalf _ of nullable string Connect only
single _ use nullable object

The Mandate object

{ "id": "mandate_1MvojA2eZvKYlo2CvqTABjZs", "object": "mandate", "customer_acceptance": { "accepted_at": 123456789, "online": { "ip_address": "127.0.0.0", "user_agent": "device" }, "type": "online" }, "livemode": false, "multi_use": {}, "payment_method": "pm_123456789", "payment_method_details": { "sepa_debit": { "reference": "123456789", "url": "" }, "type": "sepa_debit" }, "status": "active", "type": "multi_use"}

Retrieve a Mandate

GET / v1 / mandates /:id

Retrieves a Mandate object.

Parameters

No parameters.

Returns

Returns a Mandate object.

Response

{ "id": "mandate_1MvojA2eZvKYlo2CvqTABjZs", "object": "mandate", "customer_acceptance": { "accepted_at": 123456789, "online": { "ip_address": "127.0.0.0", "user_agent": "device" }, "type": "online" }, "livemode": false, "multi_use": {}, "payment_method": "pm_123456789", "payment_method_details": { "sepa_debit": { "reference": "123456789", "url": "" }, "type": "sepa_debit" }, "status": "active", "type": "multi_use"}