Refund
API Name: Refund__c
A refund tracks money sent back to a debtor in relation to a received payment.
| Label | API Name | Type | Description |
|---|---|---|---|
| Name | Name |
AutoNumber | |
| Account Name | AccountName__c |
Text | The name of the account of the parent payment. |
| Bank Account | BankAccount2__c |
Lookup(BankAccount__c) | The bank account that was used for this refund. |
| Creditor BIC | CreditorBIC__c |
Text(11) | The 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) | The name of the creditor for future reference. |
| Debtor BIC | DebtorBIC__c |
Text(11) | The 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) | The name of the debtor for future reference. |
| 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. |
| Open Amount | OpenAmount__c |
Currency(16, 2) | The amount that should be moved. Always a positive value. This value never changes. |
| Payment Customer | PaymentCustomer__c |
Lookup(PaymentCustomer__c) | The associated payment customer. |
| 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 refund. Picklist values: SEPA Credit Transfer |
| Payment Provider | PaymentProvider__c |
Lookup(PaymentProvider__c) | The associated payment provider. |
| Payment Reference | PaymentReference__c |
TextArea | Describes the purpose of the payment. |
| Payment | Payment__c |
MasterDetail(Payment__c) | The master payment for this refund. |
| Refund Date | RefundDate__c |
Date | The date of the refund. |
| Refund Id | RefundId__c |
Text(255) | A unique id for keeping track of changes (e.g. refund, chargeback) which is usually provided by a payment provider OR created as an end-to-end-id in case of SEPA. Required only when the status is not Open or Rejected. |
| Refund Method | RefundMethod__c |
Picklist | The refund method used for this refund. Picklist values: Prepared Refund, Direct Refund, Unrelated Refund |
| Refund Reason | RefundReason__c |
Picklist | The reason of the refund. Possible values can be defined by the user. Picklist values: Default |
| Refunded Amount | RefundedAmount__c |
Currency(16, 2) | The actual amount which has been moved. Always a positive value. |
| Status | Status__c |
Picklist | The payment status. (Values also depends on the payment method.) Picklist values: Prepared, Approved, Issued, Refunded, Canceled, Rejected, Failed, Pending, Open, Reversed |