The Refund service is used to credit back a previously authorized or captured payment request. This service will check the status of the original item using the transaction ID.
IMPORTANT NOTE:
- If the transaction is authorized but not captured it will reverse the authorization.
- If the transaction is captured but not yet settled it will void the capture.
- If the transaction is settled and the merchant has been paid a credit to the card holder is generated and processed.
- If the amount refunded is less than the original amount, then an adjustment is made if not settled, or a partial credit is given if settled.
A Refund can also be sent without a transactionID and offsetting payment. In order to allow, special configuration must be set on the merchant record. Because the refund is not tied to any transaction, a credit will be generated to the cardholder and no checking is performed.
REFUND/VOID RESPONSE
The EdgePay Refund Response contains non-sensitive data that you use to validate the status of the request and confirm your next steps. See table below for the following response when using Refund Request:
Field Name | Max Size | Attribute | Notes |
|---|---|---|---|
Result | 1 | A | A = Approved |
responseCode | 5 | AN | [SEE TABLE HERE](https://developers.edgepay.io/reference/managing-responses-1>) |
responseMessage | 225 | AN | |
merchantID | 19 | N | ECHO Back |
terminalID | 19 | N | ECHO Back |
processor | 10 | AN | Process ID |
timestamp | 19 | Date | YYYY-MM-DD-hh-mm-ss (UTC Time) |
transactionID | 19 | AN | A transaction ID will be assigned to the requested refund |
originalTransactionID | 18 | AN | New transactionID associated with this transaction |
Authentication Header:
- merchantKey = this is the API KEY 🔑 that is associated with your MID provided by GETTRX.
- externalReferenceId = It is a unique record identifier. Combination of 123456 + UNIX timestamp Sample: 1234561687543122
- transacationDate = Set to UTC timezone 🕑
Format: YYYY-MM-DDTHH:MM:SS