The Mandate object 

Attributes

• idstring

  Unique identifier for the object.

• customer_acceptanceobject

  Details about the customer’s acceptance of the mandate.

  Hide child attributes

  • customer_acceptance.accepted_atnullable timestamp

    The time that the customer accepts the mandate.

  • customer_acceptance.offlinenullable object

    If this mandate is accepted offline, this hash provides details about the offline acceptance.

  • customer_acceptance.onlinenullable object

    If this mandate is accepted online, this hash provides details about the online acceptance.

    Hide child attributes

    • customer_acceptance.online.ip_addressnullable string

      The customer accepts the mandate from this IP address.

    • customer_acceptance.online.user_agentnullable string

      The customer accepts the mandate using the user agent of the browser.

  • customer_acceptance.typeenum

    The mandate includes the type of customer acceptance information, such as: online or offline.

    Possible enum values

    offline

    online

• payment_methodstringExpandable

  ID of the payment method associated with this mandate.

• payment_method_detailsobject

  Additional mandate information specific to the payment method type.

  Hide child attributes

  • payment_method_details.acss_debitnullable object

    If this mandate associates with a acss_debit payment method, this hash contains mandate information specific to the acss_debit payment method.

    Hide child attributes

    • payment_method_details.acss_debit.default_fornullable array of enums

      List of Stripe products where this mandate can be selected automatically.

      Possible enum values

      invoice Enables payments for Stripe Invoices. ‘subscription’ must also be provided.

      subscription Enables payments for Stripe Subscriptions. ‘invoice’ must also be provided.

    • payment_method_details.acss_debit.interval_descriptionnullable string

      Description of the interval. Only required if the ‘payment_schedule’ parameter is ‘interval’ or ‘combined’.

    • payment_method_details.acss_debit.payment_scheduleenum

      Payment schedule for the mandate.

      Possible enum values

      combined Payments can be initiated at a pre-defined interval or sporadically

      interval Payments are initiated at a regular pre-defined interval

      sporadic Payments are initiated sporadically

    • payment_method_details.acss_debit.transaction_typeenum

      Transaction type of the mandate.

      Possible enum values

      business Transactions are made for business reasons

      personal Transactions are made for personal reasons

  • payment_method_details.amazon_paynullable object

    If this mandate associates with a amazon_pay payment method, this hash contains mandate information specific to the amazon_pay payment method.

  • payment_method_details.au_becs_debitnullable object

    If this mandate associates with a au_becs_debit payment method, this hash contains mandate information specific to the au_becs_debit payment method.

    Hide child attributes

    • payment_method_details.au_becs_debit.urlstring

      The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.

  • payment_method_details.bacs_debitnullable object

    If this mandate associates with a bacs_debit payment method, this hash contains mandate information specific to the bacs_debit payment method.

    Hide child attributes

    • payment_method_details.bacs_debit.network_statusenum

      The status of the mandate on the Bacs network. Can be one of pending, revoked, refused, or accepted.

      Possible enum values

      accepted

      pending

      refused

      revoked

    • payment_method_details.bacs_debit.referencestring

      The unique reference identifying the mandate on the Bacs network.

    • payment_method_details.bacs_debit.revocation_reasonnullable enum

      When the mandate is revoked on the Bacs network this field displays the reason for the revocation.

      Possible enum values

      account_closed The bank account has been closed. Refer to the customer to collect a new mandate.

      bank_account_restricted The bank account has restrictions on either the type or the number of payouts allowed. This normally indicates that the bank account is a savings or other non-checking account. Refer to the customer to collect a new mandate.

      bank_ownership_changed The destination bank account is no longer valid because it has been transferred to a new bank or to a new branch. A new mandate with the updated account details has been submitted on your behalf and you will be notified when it is accepted.

      could_not_process The bank could not process this payout. Refer to the customer to collect a new mandate.

      debit_not_authorized Debit transactions are not approved on this bank account. Refer to the customer to collect a new mandate.

    • payment_method_details.bacs_debit.urlstring

      The URL that will contain the mandate that the customer has signed.

  • payment_method_details.cardnullable object

    If this mandate associates with a card payment method, this hash contains mandate information specific to the card payment method.

  • payment_method_details.cashappnullable object

    If this mandate associates with a cashapp payment method, this hash contains mandate information specific to the cashapp payment method.

  • payment_method_details.kakao_paynullable object

    If this mandate associates with a kakao_pay payment method, this hash contains mandate information specific to the kakao_pay payment method.

  • payment_method_details.kr_cardnullable object

    If this mandate associates with a kr_card payment method, this hash contains mandate information specific to the kr_card payment method.

  • payment_method_details.linknullable object

    If this mandate associates with a link payment method, this hash contains mandate information specific to the link payment method.

  • payment_method_details.nz_bank_accountnullable objectPreview feature

    If this mandate associates with a nz_bank_account payment method, this hash contains mandate information specific to the nz_bank_account payment method.

  • payment_method_details.paypalnullable object

    If this mandate associates with a paypal payment method, this hash contains mandate information specific to the paypal payment method.

    Hide child attributes

    • payment_method_details.paypal.billing_agreement_idnullable string

      The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.

    • payment_method_details.paypal.payer_idnullable string

      PayPal account PayerID. This identifier uniquely identifies the PayPal customer.

  • payment_method_details.revolut_paynullable object

    If this mandate associates with a revolut_pay payment method, this hash contains mandate information specific to the revolut_pay payment method.

  • payment_method_details.sepa_debitnullable object

    If this mandate associates with a sepa_debit payment method, this hash contains mandate information specific to the sepa_debit payment method.

    Hide child attributes

    • payment_method_details.sepa_debit.referencestring

      The unique reference of the mandate.

    • payment_method_details.sepa_debit.urlstring

      The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.

  • payment_method_details.typestring

    This mandate corresponds with a specific payment method type. The payment_method_details includes an additional hash with the same name and contains mandate information that’s specific to that payment method.

  • payment_method_details.us_bank_accountnullable object

    If this mandate associates with a us_bank_account payment method, this hash contains mandate information specific to the us_bank_account payment method.

    Hide child attributes

    • payment_method_details.us_bank_account.collection_methodnullable enum

      Mandate collection method

      Possible enum values

      paper Mandate customer acceptance was collected using a paper document

• statusenum

  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.

• typeenum

  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

Collapse all

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• multi_usenullable object

  If this is a multi_use mandate, this hash contains details about the mandate.

• on_behalf_ofnullable stringConnect only

  The account (if any) that the mandate is intended for.

• single_usenullable object

  If this is a single_use mandate, this hash contains details about the mandate.

  Hide child attributes

  • single_use.amountinteger

    The amount of the payment on a single use mandate.

  • single_use.currencyenum

    The currency of the payment on a single use mandate.