Mandate
API name
cpm__Mandate__c
Description
The Mandate object is used to store and manage the authorization given by payers to collect payments from their account. Common use cases for the Mandate object are recurring credit card or direct debit payments. For further information about how FinDock uses mandates, see Introduction to mandate handling
Fields
Mandates are usually not created manually. Fields are filled in automatically by FinDock, by an external Payment Service Provider, or through a specific automation such as data migration.
| Label | Type | Description |
|---|---|---|
| Active | Checkbox | Indicates if the mandate can be used; checked = true, unchecked = false |
| Custom Reference | Text(255) | Optional field where you can enter your own custom identifier for this mandate; if used, this value overrides the Mandate Id generated by FinDock |
| Date Signed | Date | Date the payer authorized the mandate |
| End Date | Date | Date the authorization of the mandate expires; expiration is automatic according to the rules of the payment method, or it can be set manually |
| Use First Next Run | Checkbox | Sets the Sequence Type on installments to indicate first collection. Always marked true for new mandates, but only used for Bacs DD and SEPA DD. |
| Last Used | Date | Date of last payment made with this mandate |
| Payment Processor | Text(80) | The payment processor through which the mandate was created and is maintained |
| Payment Profile | Lookup | The payment profile the mandate is linked to; every mandate must be linked to a parent payment profile |
| Pre-notification Date | Date | Date the payer was notified that you have recieved an authorized mandate. |
| Prefix | Text(20) | Custom prefix value added to the mandate Id according to the mandate prefix value in the FinDock Core general settings |
| Status | Picklist | Status usage is processor and method dependent; please refer to the processing-specific documentation for further information |
| Target | Picklist | The account at the payment processor (bank account or merchant account) that this mandate authorizes to receive payments |
| Type | Picklist | Type of payment authorization (one-time or recurring) the mandate represents |
| Unique Mandate Id | Text(255) | The mandate reference for the payment processor; this an indexed text field automatically filled in using the Salesforce record Id and Mandate Prefix, or the Custom Reference field |
| Reference | Text(255) | The reference value of the customer mandate at the payment processor |