| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerToken |
For consumer payment reversal requests, contains the unique customer token used to identify the customer performing the reversal. |
string |
None. |
| InvoiceReversals |
Specifies the specific amounts to be refunded per invoice for multi-invoice partial refunds. Omit for cancellations or full refunds. |
Collection of PaymentReversalRequestInvoiceModel |
None. |
| OriginalPaymentAmount |
Specifies the original amount of the payment to be reversed. Used to verify the lookup. |
decimal |
Required |
| OriginalPaymentProcessDate |
Specifies the original payment's processing date. Used to verify the lookup. |
date-time |
Required |
| Partial |
If the refund is a partial amount, set to true. Otherwise should be false or omitted. |
boolean |
None. |
| pcOptionalDate |
OptionalDate field - additional information required for some of the Payment Consolidator Reversal Reason codes |
date-time? |
Data type: Date |
| pcReversalReasonID |
Payment Consolidator ReversalReasonID |
int? |
None. |
| ReversalAmount |
Specifies the partial amount to be refunded. Omit for cancellations, full refunds or multi-invoice partial refunds. |
decimal? |
None. |
| ReversalComment |
Specifies the description for a refund. Omit for cancellations. |
string |
String length: inclusive between 0 and 100 |
| TransactionID |
Specifies the transaction ID of the payment to be reversed. |
long |
Required |