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. Typically mandates represent the authorization to collect recurring payments, but some payment methods may also need mandates for one-time payments. For further information, see Introduction to mandate handling.
Mandates have parent-child relationships with a payment profile (the parent). In most cases, if a payer changes details impacting the payment profile, you need to create a new mandate as well as a new payment profile.
When the payment profile linked to a recurring payment (FinDock as source) is updated, the existing mandate is automatically removed and replaced with a new mandate when the change is saved if auto-create is enabled. Additionally, if mandate reuse is enabled, FinDock first checks if the new payment profile has an existing child mandate, and if so, links that to the recurring payment.
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 to collect recurring payments (checked = true) |
| Custom Reference | Text(255) | Optional field where you can enter your own custom identifier for the 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 (or Transaction Code) on installments to indicate first collection. Always marked true for new mandates. Only used for Bacs and SEPA direct debit. |
| 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 in a parent-child relationship |
| Pre-notification Date | Date | Date the payer was notified that you have received the mandate authorization |
| Prefix | Text(20) | Custom prefix value added to the mandate Id if defined in FinDock Core mandate settings |
| Status | Picklist | Status usage is processor and method dependent; please refer to the processor-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 |