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. |
| Assigned Amount | AssignedAmount2__c |
SUM(EntryItem__c.EffectiveAmount__c) | The sum of all related Entry Item Effective Amounts. |
| Assignment Key | AssignmentKey__c |
Text(255) | The payment assignment key is used to filter eligible payments for automatic settlement. |
| Available Amount | AvailableAmount__c |
Currency(16, 2) | The amount available for assignment, depending on the payments status. |
| Bank Account | BankAccount__c |
Lookup(BankAccount__c) | The bank account that was used for this payment. |
| Blocked Amount | BlockedAmount__c |
SUM(Refund__c.OpenAmount__c) | The sum over all refunds. |
| 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 |
| Initial Amount | InitialAmount__c |
Currency(16, 2) | The initial amount for this payment. This value is positive if it is a payout and negative if it is a payment. This value never changes. |
| Matching Date | MatchingDate__c |
Date | The date where it was matched with an entry |
| Matching Records | MatchingRecords__c |
LongTextArea(131072) | Matching process log |
| Matching Result | MatchingResult__c |
Picklist | Picklist values: Unmatched, Account matched, Entry matched, Manually settled, Settled by Payment Id, Settled by automatic match, Payment Id matched, Unmatched, multiple results |
| 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 Link Id | PaymentLinkId__c |
Text(255) | The external payment link id. Indicates that this payment was made through a payment link with this corresponding Id. |
| Payment Method | PaymentMethod__c |
Picklist | The payment method used for this payment. Picklist values: SEPA Direct Debit Core, SEPA Direct Debit B2B, SEPA Credit Transfer, Bank Transfer, Paypal, Credit Card, Direct Debit (via payment provider) |
| Payment Provider | PaymentProvider__c |
Lookup(PaymentProvider__c) | The associated payment provider |
| Payment Reference | PaymentReference__c |
Text(255) | Describes the purpose of a SEPA transaction (direct debit, credit transfer) or credit card statement |
| Refunded Amount | RefundedAmount__c |
SUM(Refund__c.RefundedAmount__c) | The sum over all successful refunds. |
| Reject Reason | RejectReason__c |
Text(255) | |
| Related Statements | RelatedStatements__c |
LongTextArea(32768) | |
| Collected 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 Details | StatusDetails__c |
Picklist | Detailed information about the status a payment is currently in. Picklist values: FirstChargeback, SecondChargeback, FirstRepresentment, SecondRepresentment, Arbitration |
| Status | Status__c |
Picklist | The status a payment is currently in. Depends on the payment method. Picklist values: Open, Issued, Collected, Final, Rejected, Reversed, Failed, Pending, Canceled, Refunded |
| Type | Type__c |
Picklist | Type of the payment Picklist values: Payment, Payout |