Payment
API Name: Payment__c
The payment is used to track the status of an exchange of money and the lifecycle of the chosen payment method.
| Label | API Name | Type | Description |
|---|---|---|---|
| Payment Name | Name |
AutoNumber | |
| Account | Account__c |
Lookup(Account) | The associated account. |
| Outstanding Amount | Amount__c |
Currency(16, 2) | The difference of Open Amount and Settled Amount. A payment with a zero outstanding amount is fully settled. |
| Assigned Amount | AssignedAmount__c |
SUM(EntryItem__c.Amount__c) | The sum of all related Entry Item Amounts. |
| Available Amount | AvailableAmount__c |
Currency(16, 2) | The difference of Settled Amount and Assigned Amount. A payment with zero available amount is fully assigned. |
| Bank Account | BankAccount__c |
Lookup(BankAccount__c) | The bank account that was used for this payment. |
| Business Entity | BusinessEntity__c |
Lookup(BusinessEntity__c) | The legal entity associated with this payment. |
| Collection Date | CollectionDate__c |
Date | The date of the collection of the money, can be in the future for certain payment methods (like SEPA Direct Debit) |
| Creditor BIC | CreditorBIC__c |
Text(11) | BIC of the creditor for future reference. |
| Creditor IBAN | CreditorIBAN__c |
Text(34) | The IBAN of the creditor for future reference. |
| Creditor Name | CreditorName__c |
Text(255) | Name of the creditor for future reference. |
| Debtor BIC | DebtorBIC__c |
Text(11) | BIC of the debtor for future reference. |
| Debtor IBAN | DebtorIBAN__c |
Text(34) | The IBAN of the debtor for future reference. |
| Debtor Name | DebtorName__c |
Text(255) | Name of the debtor for future reference. |
| Entry | Entry__c |
Lookup(Entry__c) | For payment methods initiated by the business owner (via a payment provider or via SEPA), the payment links to an entry. |
| Error Message | ErrorMessage__c |
LongTextArea(32768) | Optional: human readable error message as provided by some payment providers |
| Error Response | ErrorResponse__c |
LongTextArea(32768) | The raw error message in case the payment has been rejected |
| External Id | ExternalId__c |
Text(255) | External Id that identifies this payment record |
| Open Amount | OpenAmount__c |
Currency(16, 2) | The amount that should be moved. Positive value if it is a payout, negative value if it is a payment. This value never changes. |
| Payment Customer | PaymentCustomer__c |
Lookup(PaymentCustomer__c) | The associated payment customer |
| Payment ID | PaymentId__c |
Text(255) | Unique ID for keeping track of changes (e.g. refund, chargeback). Usually provided by a payment provider, or created as an end-to-end ID in case of SEPA. |
| Payment Instrument | PaymentInstrument__c |
Lookup(PaymentInstrument__c) | The payment instrument that has been used to move the money. |
| Payment Method | PaymentMethod__c |
Picklist | The payment method used for this payment. |
| Payment Provider | PaymentProvider__c |
Lookup(PaymentProvider__c) | The associated payment provider |
| Related Statements | RelatedStatements__c |
LongTextArea(32768) | |
| Settled Amount | SettledAmount__c |
Currency(16, 2) | The sum over all related payment transactions. Positive value if it is a payout, negative value if it is a payment. |
| Status | Status__c |
Picklist | The status a payment is currently in. Depends on the payment method. |