Request for Refund Status
Service Provider can request for refund status for previous refund transaction.
Request
HTTP Method |
---|
POST |
POST <AOC_SERVER>/api/refundStatus
HTTP/1.1
Content type: application/x-www-form-urlencoded
{
"apiKey":"Ofa3M7zS2c3",
"username":"test",
"spTransID":"201903192030-test1"
}
Request Parameter
Parameter Name | Description | Usage |
---|---|---|
username | This will be the username provided to the Service Provider by BOOSTCONNECT. | (STRING) |
apiKey | This will be API Key to access AOC. Will be provided by BOOSTCONNECT. | (STRING) |
spTransID | This is the SP transaction ID used in the original refund transaction. | (STRING) |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Date: Tue, 01 Nov 2016 12:00:00 GMT
{ "data":
{
"aocTransID":"12345",
"transactionOperationStatus":"refunded",
"amountRefunded":"1.00",
"errorCode":"00",
"errorMessage":""
}
}
Response Parameter
Parameter Name | Description | Usage |
---|---|---|
transactionOperationStatus | The status of the charge transaction as below:
| (STRING) |
amountRefunded | This is the actual amount being refunded. It can be a whole number or two digit decimal. | (DECIMAL) |
aocTransID | This is the unique transaction id generated by AOC Gateway. This id will be used for any future reconciliation purposes. | (STRING) |
clientCorrelator | This is the client correlator id that will be returned for all success refund transactions. Do keep this id as it will be used for reconciliation purposes. | (STRING) |
errorCode | Please check on the error code list. | (STRING) |
errorMessage | Explanation of the error. | (STRING) |
Updated 3 days ago