Payment Profile
API name: cpm__Payment_Profile__c
Description
The Payment Profile object contains details about a specific payment method that a contact or account has used. A separate Payment Profile record is created for different credit cards, bank account and BIC or sort code combinations, etc. Installments are linked to payment profiles to determine what details should be used when collecting the payment.
FinDock does not store the primary account number (PAN) of a card on the payment profile, only tokenized card details.
When handling changes to payment details stored on a payment profile, in most cases you should create a new Payment Profile record rather than updating the existing record. This preserves the history of payment data related to installments paid using the original payment profile information.
For recurring payments, the payment profile is linked to the mandate in a child-parent relationship. Re-parenting is not supported. Linking a different payment profile to an existing recurring payment automatically triggers a new mandate creation/selection process.
Record types
Record types are used to separate and display information relevant for a given payment method. The FinDock Core package includes four record types that cover all payment method types. However, older installations may still have and use other record types that are no longer required in new installations.
Record types:
- BBAN - for all non-IBAN account types; record layout and data validation are determined by the Country Picklist value.
- Credit Card - for all card types and brands
- IBAN - for all IBAN accounts
- Wallet - for various payment methods such as ApplePay, GooglePay, Swish, etc.
Legacy record types:
- Bank Account - UK bank accounts for Bacs package (replaced by BBAN record type)
- Bank Account - Norway and Sweden bank accounts for Nordics package (replaced by BBAN record type)
- Bank Account (Stripe) - UK bank accounts for Stripe package (replaced by BBAN record type)
- Legacy Bank Account (Deprecated) - UK bank accounts for (Core package replaced by BBAN record type)
- PayPal - Payer account for PayPal package (replaced by Wallet record type)
Page layouts
FinDock provides page layouts for each record type. The out-of-the box page layout assignments should be modified to fit your specific payment operations. For information about working with record types and page layouts, see Assign Page Layouts to Profiles or Record Types.
FinDock also ships a dynamic Lightning Page Record, Payment Profile Record Page - Dynamic Form, which we recommending use as the org default if it is not already. The layout presents the most relevant fields based on record type.
Identification and uniqueness
The Payment Profile object includes two fields for identification and enforcing uniqueness: Primary Identifier and Unique Identifier.
The Primary Identifier field is an indexed identification field that can be queried by processes like Guided Matching. The field value is determined by Record Type (account, credit card, etc.).
The Unique Identifier field is an indexed field with an enforceable, unique value that is upserted during Guided Matching processing. FinDock automatically enforces profile uniqueness to ensure duplicate records are not created because of parallel processing. This is controlled by the Enforce Payment Profile Uniqueness (cpm__Enforce_Payment_Profile_Uniqueness__c) custom setting which is true (checked) by default.
The Unique Identifier value is composed of the following elements separated by an underscore:
Record Type Name + Primary Identifier + Wallet Type (if applicable) + 18 char Contact Id (or Account Id)
Payment Profile fields
| Label | Type | Description |
|---|---|---|
| Account | Lookup(Account) | Account record linked to the payment profile |
| Active | Checkbox | If not checked, the payment profile cannot be used to collect payments |
| Bank Account | Text(50) | The unique, country-specific number that identifies the payer’s account at a specific bank |
| Bank Code | Text(255) | A unique identifier for a financial institution in a given country issued by a central bank or banking association |
| Bank Name | Text(255) | The name of the financial institution where the payer hold the bank account |
| BIC | Text(50) | The Business Identifier Code or SWIFT Code of the payer’s bank |
| Branch Code | Text(50) | The country-specific identifier of the payer’s bank branch location, also known as clearing number, routing number, etc. |
| Brand | Text(50) | Card brand |
| Card BIN | Text(6) | Bank Identification Number of card (first four to six digits) |
| CCV | Text (Encrypted)(5) | 3-digit Card Verification Value |
| City | Text(255) | Non-EEA payer city name, required for SEPA Direct Debit |
| Clearing Member Id | Text(80) | The legal identifier of the payer’s Swiss financial institution |
| Contact | Lookup(Contact) | Contact record linked to the payment profile |
| Country | Picklist | Picklist for BBAN accounts used for validation and record type page layout |
| Country | Text(255) | Non-EEA payer Alpha-2 ISO country code, required for SEPA Direct Debit |
| Credit Card Number | Text (Encrypted)(175) | Last four digits of the card number |
| Custom Tax Code | Text(80) | Tax code for SEPA/SEDA payments in Italy that overrides payer's default tax code from contact/account |
| Enforce Uniqueness | Checkbox | Indicates if FinDock enforces uniqueness of payment profile |
| Expiration Month | Picklist | Card expiration month |
| Expiration Year | Picklist | Card expiration year |
| Fingerprint | Text(100) (External ID) | Stripe-specific unique identifier |
| Funding Type | Picklist | Indicates card type (credit or debit), required by specific processors |
| Holder Name | Text(255) | Payer’s name as it appears in the bank account owner details |
| House name or number | Text(255) | Non-EEA payer house name or number, required for SEPA Direct Debit |
| Housenumber (deprecated) | Number(18, 0) | Deprecated |
| IBAN | Text(35) | International Bank Account Number that identifies the country, bank and account number of a payer’s bank account in a valid format |
| Payer Id | Text(255) (External ID) | Payer identification specific to PayPal |
| Payer Name | Text(255) | Payer name specific to PayPal |
| PayPal Email Address | Payer email address specific to PayPal | |
| Primary Identifier | Text(255) (External ID) | Indexed identification for payment profile |
| ProcessingHub Id | Text(80) (External ID) | Id of process ProcessingHub process that last used the payment profile |
| Reparent Payment Profile | Text(255) | Deprecated |
| Sort Code | Text(50) | 6-digit sort code of the payer’s UK bank |
| Sort Code | Text(50) | Deprecated |
| State/Province | Text(255) | Payer's address state or province |
| Street | Text(255) | Non-EEA payer street address, required for SEPA Direct Debit |
| Suffix | Text(10) | Payer's name suffix, such as Jr. or Sr. |
| Token | Text(255) | Token used to securely identify the card (instead of the card number) |
| Token Issuer | Text(80) | Provider that issued the card token stored in the payment profile |
| Unique Identifier | Text(255) (External ID) (Unique Case Insensitive) | Indexed identification with enforceable uniqueness for payment profile |
| Wallet Id | Text(50) | Identification number of payer's digital wallet |
| Wallet Type | Picklist | Indicates the payment method associated with the wallet, e.g. Apple Pay or Google Pay |
| Zipcode | Text(15) | Non-EEA payer postal code, required for SEPA Direct Debit |