POST payments/credit/reversal
Reverses (cancels) any payment transaction that is still within an open batch.
Request Information
URI Parameters
None.
Body Parameters
request payload
ReversalRequestName | Description | Type | Additional information |
---|---|---|---|
TransactionData |
Specific information for the transaction. |
ReversalTransactionData |
Required |
OriginalTransactionData |
Specific information for the original transaction (to be reversed). |
ReversalOriginalTranData |
Required |
EmvTransactionData |
Specific information to reverse and EMV transaction. |
ReversalEmvTransactionData |
None. |
Request Formats
application/json, text/json
Sample:
{ "TransactionData": { "UniqueIdentifier": "sample string 1", "TimeStamp": "2024-05-19T07:13:05.22Z", "DeviceRegistrationIdentifier": "b2b566e5-35da-48d2-8b4e-ed3cecfe4cd6" }, "OriginalTransactionData": { "HostTransactionID": 1 }, "EmvTransactionData": { "ReasonType": "Canceled", "EMVCardData": { "Reader": "sample string 1", "ReaderSerialNumber": "sample string 2", "ReaderKernelHash": "sample string 3", "ReaderConfigurationVersion": "sample string 4", "ReaderEncoding": "None", "TlvEncrypted": "sample string 5", "Tlv": "sample string 6", "KeySerialNumber": "sample string 7" } } }
Response Information
Resource Description
Reverses (cancels) any payment transaction that is still within an open batch.
ReversalResponseName | Description | Type | Additional information |
---|---|---|---|
TransactionRequestData |
Transaction request data, such as echo back properties. |
PaymentTransactionRequestData |
Required |
Result |
Transaction result, such as success or failure. |
PaymentTransactionResult |
Required |
Response Formats
application/json, text/json
Sample:
{ "TransactionRequestData": { "UniqueIdentifier": "sample string 1" }, "Result": { "ProcessorResponseCode": "sample string 1", "ProcessorResponseText": "sample string 2", "ResponseCode": 3, "ResponseText": "sample string 4" } }