Request Charging Status
Once Service Provider receives the request on the callback URL from AOC Gateway, they need to invoke the “Request Charging Status” API to get the status of the charging transaction.
Then, Service Provider needs to display a success or failed page to the user/payer.
Request
HTTP Method |
---|
POST |
POST <AOC_SERVER>/api/chargeStatus
HTTP/1.1
Content type: application/x-www-form-urlencoded
{
"aocTransID":"12345678",
"apiKey":"Ofa3M7zS2c3",
"username":"test"
}
Request Parameter
Request Parameter | Description | Usage |
---|---|---|
aocTransID | This is the unique transaction id generated by AOC Gateway. This id is passed to Service Provider’s Callback URL. | (STRING) Mandatory |
apiKey | This will be API Key to access AOC. Will be provided by BOOSTCONNECT. | (STRING) Mandatory |
username | This will be the username provided to the Service Provider by BOOSTCONNECT. | (STRING) Mandatory |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 12345
Date: Tue, 01 Nov 2016 12:00:00 GMT
{ "data":
{
"transactionOperationStatus":"Charged",
"totalAmountCharged":"10.00",
"msisdn":"+60191234567",
"clientCorrelator":"12345678901234567",
"errorCode":"00",
"errorMessage":""
}
}
Response Parameter
Parameter Name | Description | Usage |
---|---|---|
transactionOperationStatus | The status of the charge transaction is as below: 1. Charged. (mean successfully charged). 2. Denied. (failed to charge. Check the error code list for reason). 3. Processing. (mean the charge is still under processing. Refer to sections “Processing Status for Operator XL” and “Processing Status for PayTM Wallet” for more details). 4. pending_consent (mean the transaction is still pending user consent. This status is only applicable for certain Operator). 5. pending_topup (mean the transaction is still pending user process to top-up their balance before recharge. This status is only applicable for certain Operator). | (STRING) |
totalAmountCharged | This is the actual amount being charged. It can be a whole number or a two-digit decimal. | (DECIMAL) |
msisdn | The MSISDN of the target user. The user’s MSISDN includes the country code preceded by '+', e.g. +60191234567. Note: For e-Wallet transactions, there will be no MSISDN return. | (STRING) |
clientCorrelator | This is the client correlator id that will be returned for all success charged transactions. Do keep this id as it will be used for reconciliation purposes. | (STRING) |
errorCode | Please check the error code list. | (STRING) |
errorMessage | Explanation of the error. | (STRING) |
Updated over 2 years ago