A Mandate is a record of the permission that your customer gives you to debit their payment method.
Attributes
- idstring
Unique identifier for the object.
- customer_
acceptanceobject Details about the customer’s acceptance of the mandate.
- payment_
methodstringExpandable ID of the payment method associated with this mandate.
- payment_
method_ detailsobject Additional mandate information specific to the payment method type.
- statusenum
The mandate status indicates whether or not you can use it to initiate a payment.
Possible enum valuesactiveThe mandate can be used to initiate a payment.
inactiveThe mandate was rejected, revoked, or previously used, and may not be used to initiate future payments.
pendingThe mandate is newly created and is not yet active or inactive.
- typeenum
The type of the mandate.
Possible enum valuesmulti_use Represents permission given for multiple payments.
single_use Represents a one-time permission given for a single payment.
More attributes
- objectstring
- livemodeboolean
- multi_
usenullable object - on_
behalf_ ofnullable stringConnect only - single_
usenullable 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"}Retrieves a Mandate object.
Parameters
No parameters.
Returns
Returns a 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"}