POST payments/cash/refund
Creates a cash repayment (refund) record for a previous sale transaction.
Request Information
URI Parameters
None.
Body Parameters
request payload
CashRefundRequestName | Description | Type | Additional information |
---|---|---|---|
TransactionData |
Specific information for the transaction. |
CashRefundTransactionData |
Required |
AmountsReq |
Amount requested for this transaction. |
CashRefundAmountsRequest |
None. |
OriginalTransactionData |
Specific information for the original transaction (to be refunded). |
CashRefundOriginalTranData |
Required |
SendReceiptRequest |
Request for sending a transaction receipt. |
PaymentReceiptRequest |
None. |
Request Formats
application/json, text/json
Sample:
{ "TransactionData": { "UniqueIdentifier": "sample string 1", "TimeStamp": "2024-05-19T07:13:03.845Z", "TotalAmount": 3.0, "Description": "sample string 4", "GeotagInfo": { "Longitude": 1.1, "Latitude": 2.1 }, "InvoiceNumber": "sample string 5", "DeviceRegistrationIdentifier": "1095c9b2-a69e-42cc-bdf4-f3be0ac7687b" }, "AmountsReq": { "SubTotalAmount": 1.0, "TaxAmount": 2.0, "TipAmount": 3.0 }, "OriginalTransactionData": { "HostTransactionID": 1 }, "SendReceiptRequest": { "Emails": [ { "Email": "sample string 1" }, { "Email": "sample string 1" } ] } }
Response Information
Resource Description
Creates a cash repayment (refund) record for a previous sale transaction.
CashRefundResponseName | Description | Type | Additional information |
---|---|---|---|
TransactionRequestData |
Transaction request data, such as echo back properties. |
PaymentTransactionRequestData |
Required |
TransactionResultData |
Transaction result data. |
PaymentTransactionResultData |
Required |
Result |
Transaction result, such as success or failure. |
PaymentTransactionResult |
Required |
Response Formats
application/json, text/json
Sample:
{ "TransactionRequestData": { "UniqueIdentifier": "sample string 1" }, "TransactionResultData": { "AuthCode": "sample string 1", "HostTransactionID": 1, "ParentHostTransactionID": 1, "RRN": "sample string 2", "ReceiptID": 1 }, "Result": { "ProcessorResponseCode": "sample string 1", "ProcessorResponseText": "sample string 2", "ResponseCode": 3, "ResponseText": "sample string 4" } }