POST payments/credit/refund
Creates a card repayment (refund) for a previously approved credit sale transaction.
Request Information
URI Parameters
None.
Body Parameters
request payload
CreditRefundRequestName | Description | Type | Additional information |
---|---|---|---|
TransactionData |
Specific information for the transaction. |
CreditRefundTransactionData |
Required |
OriginalTransactionData |
Specific information for the original transaction (to be refunded). |
CreditRefundOriginalTranData |
Required |
AmountsReq |
Amount requested for this transaction. |
CreditRefundAmountsRequest |
None. |
PaymentData |
Payment data for this transaction. |
CreditRefundPaymentData |
None. |
Signature |
Base64-encoded string representing the cardholder's signature as captured by a POS device. |
string |
None. |
SendReceiptRequest |
Transaction receipt information. |
PaymentReceiptRequest |
None. |
Request Formats
application/json, text/json
Sample:
{ "TransactionData": { "UniqueIdentifier": "sample string 1", "TimeStamp": "2024-05-19T07:13:04.329Z", "TotalAmount": 3.0, "Description": "sample string 4", "GeotagInfo": { "Longitude": 1.1, "Latitude": 2.1 }, "InvoiceNumber": "sample string 5", "DeviceRegistrationIdentifier": "c37a7f88-e715-425f-92bf-d5f697ecf25a" }, "OriginalTransactionData": { "HostTransactionID": 1 }, "AmountsReq": { "SubTotalAmount": 1.0, "TaxAmount": 2.0, "TipAmount": 3.0, "SurchargeAmount": 4.0 }, "PaymentData": { "EntryMethod": "Standard", "CardData": { "CardVerificationMethod": "Unknown", "PinCode": "sample string 1", "PinKeySerialNumber": "sample string 2", "ManualCardData": { "PAN": "sample string 1", "ExpirationDate": "sample string 2", "CardHolderName": "sample string 3" }, "SensitiveCardData": { "Track1": "sample string 1", "Track2": "sample string 2" }, "ProtectedCardData": { "Reader": "sample string 1", "ReaderEncoding": "None", "MaskedCardData": { "FirstSix": "sample string 1", "LastFour": "sample string 2", "CardHolderName": "sample string 3" }, "EncryptedData": { "CombinedBlock": "sample string 1", "Track1": "sample string 2", "Track2": "sample string 3" }, "KeyID": "sample string 2", "TrackDataKeySerialNumber": "sample string 3" }, "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" }, "CardOnFileData": { "Token": "sample string 1" } }, "EmvCapable": true }, "Signature": "sample string 1", "SendReceiptRequest": { "Emails": [ { "Email": "sample string 1" }, { "Email": "sample string 1" } ] } }
Response Information
Resource Description
Creates a card repayment (refund) for a previously approved credit sale transaction.
CreditRefundResponseName | 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" } }