Schema2020-08-27object

mandate

A Mandate is a record of the permission a customer has given you to debit their payment method.

Source: openapi/spec3.json
Commit: d70de345383d
Active snapshot: da69df7e6e11

mandate_payment_method_details

object

acss_debit mandate_acss_debit object

optional

au_becs_debit mandate_au_becs_debit object

optional

bacs_debit mandate_bacs_debit object

optional

card card_mandate_payment_method_details object

optional

sepa_debit mandate_sepa_debit object

optional

type string

required

The type of the payment method associated with this mandate. An additional hash is included on `payment_method_details` with a name matching this value. It contains mandate information specific to the payment method.

maxLength:5000

Root JSON Schema

{"description":"A Mandate is a record of the permission a customer has given you to debit their payment method.","properties":{"customer_acceptance":{"$ref":"#/components/schemas/customer_acceptance"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"multi_use":{"$ref":"#/components/schemas/mandate_multi_use"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["mandate"],"type":"string"},"payment_method":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/payment_method"}],"description":"ID of the payment method associated with this mandate.","x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/payment_method"}]}},"payment_method_details":{"$ref":"#/components/schemas/mandate_payment_method_details"},"single_use":{"$ref":"#/components/schemas/mandate_single_use"},"status":{"description":"The status of the mandate, which indicates whether it can be used to initiate a payment.","enum":["active","inactive","pending"],"type":"string"},"type":{"description":"The type of the mandate.","enum":["multi_use","single_use"],"type":"string"}},"required":["customer_acceptance","id","livemode","object","payment_method","payment_method_details","status","type"],"title":"Mandate","type":"object","x-expandableFields":["customer_acceptance","multi_use","payment_method","payment_method_details","single_use"],"x-resourceId":"mandate"}