Request for Refund Status

Service Providers can request refund status for a 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 NameDescriptionUsage
usernameThis will be the username provided to the Service Provider by BOOSTCONNECT.(STRING)
Mandatory
apiKeyThis will be API Key to access AOC. Will be provided by BOOSTCONNECT.(STRING)
Mandatory
spTransIDThis is the SP transaction ID used in the original refund transaction.(STRING)
Mandatory

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 NameDescriptionUsage
transactionOperationStatusThe status of the charge transaction is as below:

1. Refunded. (mean successfully refunded).
2. Denied. (failed to refund. Check the error code list for reason).
(STRING)
amountRefundedThis is the actual amount being refunded. It can be a whole number or a two-digit decimal.(DECIMAL)
aocTransIDThis is the unique transaction id generated by AOC Gateway. This id will be used for any future reconciliation purposes.(STRING)
clientCorrelatorThis is the client correlator id that will be returned for all successful refund transactions. Do keep this id as it will be used for reconciliation purposes.(STRING)
errorCodePlease check the error code list.(STRING)
errorMessageExplanation of the error.(STRING)