POST payments/cash/refund

Creates a cash repayment (refund) record for a previous sale transaction.

Request Information

URI Parameters

None.

Body Parameters

request payload

Name	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-04-26T11:09:33.457Z",
    "TotalAmount": 3.0,
    "Description": "sample string 4",
    "GeotagInfo": {
      "Longitude": 1.1,
      "Latitude": 2.1
    },
    "InvoiceNumber": "sample string 5",
    "DeviceRegistrationIdentifier": "3b4fb02c-1661-4d52-b6ff-54b3e84af852"
  },
  "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.

CashRefundResponse

Name	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"
  }
}