Direct Charge with Step Down Option

Only applicable for Service Provider that is enabled for Direct Charging

This API call is only applicable for Service Provider with Direct Charging permission. This is the direct charging API when the Step Down option is available in initial Direct Charge API response. After user choose the step down option, Service Provider need to invoke this API.

Request

HTTP Method

POST

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

{
    "aocTransID":"12345678",
    "apiKey":"Ofa3M7zS2c3",
    "username":"test",
    "msisdn":"+60191234567",
  "subscriptionDuration":"8"
}

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

subscriptionDuration

This is the subscription duration for the step down option that the user chooses.

(INT)
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", 
  "chargeMode":"stepdown", 
  "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.)

(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;
● stepdown (this mean the charge is under Step Down charge mode)

(STRING)

expiryDate

ONLY APPLICABLE FOR STEP DOWN CHARGING

This is the expiry date of the step down subscription chosen by user in format dd-MM-yyyy.

(STRING)

subscriptionDuration

ONLY APPLICABLE FOR STEP DOWN CHARGING

This is the subscription duration of the step down subscription chosen by the user.

(INT)

errorCode

Please check on the error code list.

(STRING)

errorMessage

Explanation of the error.

(STRING)