Payment Instrument
API Name: PaymentInstrument__c
A payment instrument record holds a single credit card or bank account, which can be used to collect a payment for an invoice.
| Label | API Name | Type | Description |
|---|---|---|---|
| # | Name |
AutoNumber | |
| Account Holder | AccountHolder__c |
Text(255) | The name of the card holder or bank account owner. |
| Account | Account__c |
Lookup(Account) | The account where this payment instrument is associated. |
| SWIFT-BIC | BIC__c |
Text(11) | The Bank Identifier Code code (only useful for type Bank Account). |
| Deactivation Reason | DeactivationReason__c |
Picklist | The reason can be set by a user or an automated process (e.g. capture). |
| IBAN | IBAN__c |
Text(34) | The International Bank Account Number (only useful for type Bank Account). |
| Is Active | IsActive__c |
Checkbox | The payment instrument is not active, if it has been deactivated or is expired. |
| Last Capture Amount | LastCaptureAmount__c |
Currency(16, 2) | The amount which the system tried to capture. |
| Last Capture Is Success | LastCaptureIsSuccess__c |
Checkbox | Is checked if the last capture has been successful. |
| Last Capture Message | LastCaptureMessage__c |
Text(255) | The message as reported by the payment provider. |
| Last Capture Notification | LastCaptureNotification__c |
LongTextArea(32768) | The payload which got used to create the notification message. |
| Last Successful Capture Time | LastCaptureSuccess__c |
DateTime | The timestamp of the last successful capture. |
| Last Capture Time | LastCapture__c |
DateTime | The timestamp of the last capture regardless of success/failure. |
| Last Successful Capture Amount | LastSuccessfulCaptureAmount__c |
Currency(16, 2) | The amount which the system captured successfully. |
| Masked PAN | MaskedPAN__c |
Text(255) | The masked account number (eg. credit card, IBAN) as provided by the payment provider. |
| Payment Institution | PaymentInstitution__c |
Text(255) | The name of the bank (only useful for type Bank Account). |
| Payment Provider | PaymentProvider__c |
Picklist | The payment provider, who is handling this payment instrument. |
| Provider Specific Data | ProviderSpecificData__c |
LongTextArea(32768) | JSON encoded values which are needed for the specific payment provider. |
| Retry Count | RetryCount__c |
Number(18, 0) | Defaults to zero, will be increased by one on each unsuccessful capture. |
| Sequence | Sequence__c |
Number(18, 0) | The sequence is used to order payment instruments for processing. |
| Token | Token__c |
Text(255) | The tokenized representation of the payment instrument. The token is generated by the payment provider is stored in a PCI compliant manner. |
| Type | Type__c |
Picklist | The type and payment provider define how this payment instrument can be captured. |
| Valid until | ValidUntil__c |
Date | The date until the payment instrument is valid and can be captured. |