GoCardlessMandate Class |
Mandate object to pass information about a mandate.
A mandate is a Direct Debit mandate with a bank account. Almost always only want 1 mandate per bank account.
Can take multiple payments against a mandate.
Corresponds directly to GoCardless Mandate object https://developer.gocardless.com/api-reference/#core-endpoints-mandates.
Inheritance HierarchyNamespace: NetQuarry.Services.Payment
Assembly: EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
SyntaxThe GoCardlessMandate type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GoCardlessMandate |
Empty constructor.
|
| GoCardlessMandate(String) |
Constructor with idempotency key.
|
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.
|
Methods| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) |
 | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | EqualValue |
Determines if the object value is equal to another object. If the two objects are null, then this returns true.
There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways).
If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.) |
See Also