Mandate Properties |
The GoCardlessMandate type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | created_at |
Fixed timestamp, recording when this resource was created.
|
| id |
Unique identifier, beginning with “MD”.
|
| IDEMPOTENCYKEY |
Not part of actual object sent to GoCardless. Used in HTTP header to prevent duplicating a successful request.
|
| links |
IDs of things that could be related.
When creating Mandate set: customer_bank_account.
After Mandate is create, GoCardless sets: customer + creditor.
|
| metadata |
Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters.
|
| next_possible_charge_date |
The earliest date a newly created payment for this mandate could be charged.
|
| payments_require_approval |
Boolean value showing whether payments and subscriptions under this mandate require approval via an automated email before being processed.
|
| reference |
Unique reference. Different schemes have different length and character set requirements. GoCardless will generate a unique reference satisfying the different scheme requirements if this field is left blank.
|
| scheme |
Direct Debit scheme to which this mandate and associated payments are submitted. Can be supplied or automatically detected from the customer’s bank account. Currently only “autogiro”, “bacs”, and “sepa_core” are supported.
|
| status |
One from picklist GoCardlessMandatemandates_status.
For list API: At most three valid status values.
|
See Also