Direct Charge API

This API call is only applicable to Service Providers with Direct Charging permission. This is the direct charging API where it doesn’t require the customer to go through the AOC Payment page.

Once Service Provider has requested AOC Token for charging, Service Provider will need to call Direct Charge API to complete the payment.

Request

HTTP Method
POST
POST <AOC_SERVER>/api/directCharge
HTTP/1.1
Content type: application/x-www-form-urlencoded


{
  "aocTransID":"12345678",
  "apiKey":"Ofa3M7zS2c3",
  "username":"test",
  "msisdn":"+60191234567",
  "tac":"1234"
}

Request Parameter

Parameter Name

Description

Usage

aocTransID

This is the unique transaction id generated by AOC Gateway. This is the aocTransID returned to the Service Provider during the getAOCToken API.

(STRING) Mandatory

apiKey

This will be API Key to access AOC. Will be provided by BOOSTCONNECT during onboarding.

(STRING) Mandatory

username

This will be the username provided to the Service Provider during onboarding.

(STRING) Mandatory

msisdn

The MSISDN of the subscriber. The user’s MSISDN includes the country code, e.g. 60191234567.

(STRING) Mandatory

tac

The TAC key-in by user.

Note: This parameter is optional, only mandatory if OTP is enabled for the Service Provider.

(STRING) Optional

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 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 section “Processing Status for Operator XL” for more details.)
  4. pending_step_down (mean there is step down option for user to choose)If the transactionOperationStatus is “pending_step_down”, Service Provider need to show users the step down option for them to choose and invoke the Direct Charge for Step Down API.

(STRING)

totalAmountCharged

This is the actual amount being charged. It can be a whole number or two digit decimal.

(DECIMAL)

msisdn

The MSISDN of the target user. The user’s MSISDN includes the country code preceded by '+', e.g. +60191234567.

(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)

chargeMode

This represent the charge mode with available value as below;
● standard (this mean it’s normal standard transaction)
● split (this mean the charge is under Split Charge mode)

(STRING)

stepDowns

If charging failed and step down option is available, this parameter will have array value as below;

"stepDowns":[
{
"stepDownAmount":3.00,
"stepDownSubscriptionDuration":15
},
{
"stepDownAmount":1.00,
"stepDownSubscriptionDuration":8
}
]

(JSON ARRAY)

errorCode

Please check on the error code list.

(STRING)

errorMessage

Explanation of the error.

(STRING)