Mandates
Retrieves a Mandate object.
Table Specific Information
Select
The server uses the Stripe API to filter the results by the following columns and operators:
The Id is a required column to query the table.
The rest of the filter is executed client-side within the server.
You can select from Mandates with the following queries:
SELECT * FROM Mandates WHERE Id = 'mandate_1MvojA2eZvKYlo2CvqTABjZs'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | Unique identifier for the InvoicePayment object. | |
| CustomerAcceptanceType | String | The mandate includes the type of customer acceptance information, such as: online or offline.
The allowed values are offline, online. | |
| CustomerAcceptanceAcceptedAt | Datetime | The time that the customer accepts the mandate. | |
| CustomerAcceptanceOffline | String | If this mandate is accepted offline, this hash provides details about the offline acceptance. | |
| CustomerAcceptanceOnlineIpAddress | String | The customer accepts the mandate from this IP address, if this mandate is accepted online. | |
| CustomerAcceptanceOnlineUserAgent | String | The customer accepts the mandate using the user agent of the browser, if this mandate is accepted online. | |
| Status | String | The mandate status indicates whether or not you can use it to initiate a payment.
The allowed values are active, inactive, pending. | |
| Type | String | The type of the mandate.
The allowed values are multi_use, single_use. | |
| Object | String | String representing the object's type. Objects of the same type share the same value. | |
| Livemode | Boolean | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
| MultiUse | String | If this is a multi_use mandate, this hash contains details about the mandate. | |
| SingleUseAmount | String | If this is a single_use mandate, this field contains the amount of the payment on a single use mandate. | |
| SingleUseCurrency | String | If this is a single_use mandate, this field contains currency of the payment on a single use mandate. | |
| OnBehalfOf | String | The account (if any) that the mandate is intended for. | |
| PaymentMethodId | String | ID of the payment method associated with this mandate. | |
| PaymentMethodDetailsType | String | 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. | |
| PaymentMethodDetailsAcssDebitDefaultFor | String | If this mandate associates with an acss_debit payment method, this field contains a list of Stripe products where this mandate can be selected automatically.
The allowed values are invoice, subscription. | |
| PaymentMethodDetailsAcssDebitIntervalDescription | String | If this mandate associates with an acss_debit payment method, this field contains the description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. | |
| PaymentMethodDetailsAcssDebitPaymentSchedule | String | If this mandate associates with an acss_debit payment method, this field contains the payment schedule for the mandate.
The allowed values are combined, interval, sporadic. | |
| PaymentMethodDetailsAcssDebitTransactionType | String | If this mandate associates with an acss_debit payment method, this field contains the transaction type of the mandate.
The allowed values are personal, business. | |
| PaymentMethodDetailsAmazonPay | String | If this mandate associates with an amazon_pay payment method, this hash contains mandate information specific to the amazon_pay payment method. | |
| PaymentMethodDetailsAuBecsDebitUrl | String | If this mandate associates with an au_becs_debit payment method, this field contains the URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. | |
| PaymentMethodDetailsBacsDebitNetworkStatus | String | If this mandate associates with a bacs_debit payment method, this field contains the status of the mandate on the Bacs network. Can be one of pending, revoked, refused, or accepted.
The allowed values are accepted, pending, refused, revoked. | |
| PaymentMethodDetailsBacsDebitReference | String | If this mandate associates with a bacs_debit payment method, this field contains the unique reference identifying the mandate on the Bacs network. | |
| PaymentMethodDetailsBacsDebitRevocationReason | String | If this mandate associates with a bacs_debit payment method, this field contains the reason for the revocation when the mandate is revoked on the Bacs network.
The allowed values are account_closed, bank_account_restricted, bank_ownership_changed, could_not_process, debit_not_authorized. | |
| PaymentMethodDetailsBacsDebitUrl | String | If this mandate associates with a bacs_debit payment method, this field contains the URL that will contain the mandate that the customer has signed. | |
| PaymentMethodDetailsCard | String | If this mandate associates with a card payment method, this hash contains mandate information specific to the card payment method. | |
| PaymentMethodDetailsCashapp | String | If this mandate associates with a cashapp payment method, this hash contains mandate information specific to the cashapp payment method. | |
| PaymentMethodDetailsKakaoPay | String | If this mandate associates with a kakao_pay payment method, this hash contains mandate information specific to the kakao_pay payment method. | |
| PaymentMethodDetailsKrCard | String | If this mandate associates with a kr_card payment method, this hash contains mandate information specific to the kr_card payment method. | |
| PaymentMethodDetailsLink | String | If this mandate associates with a link payment method, this hash contains mandate information specific to the link payment method. | |
| PaymentMethodDetailsNaverPay | String | If this mandate associates with a naver_pay payment method, this hash contains mandate information specific to the naver_pay payment method. | |
| PaymentMethodDetailsNzBankAccount | String | If this mandate associates with a nz_bank_account payment method, this hash contains mandate information specific to the nz_bank_account payment method. | |
| PaymentMethodDetailsPaypalBillingAgreementId | String | If this mandate associates with a paypal payment method, this field contains the PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. | |
| PaymentMethodDetailsPaypalPayerId | String | If this mandate associates with a paypal payment method, this field contains the PayPal account PayerID. This identifier uniquely identifies the PayPal customer. | |
| PaymentMethodDetailsRevolutPay | String | If this mandate associates with a revolut_pay payment method, this hash contains mandate information specific to the revolut_pay payment method. | |
| PaymentMethodDetailsSepaDebitReference | String | If this mandate associates with a sepa_debit payment method, this field contains the unique reference of the mandate. | |
| PaymentMethodDetailsSepaDebitUrl | String | If this mandate associates with a sepa_debit payment method, this field contains the URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. | |
| PaymentMethodDetailsUsBankAccountCollectionMethod | String | If this mandate associates with a us_bank_account payment method, this field contains the mandate collection method.
The allowed values are paper. |