Vous êtes sur la page 1sur 38

Darmawisata Indonesia H2H API

Url API Development


https://139.255.78.145/h2h

Authorization
To use API, user will be registered in a first place, to get userID and password. All operations use POST
method.

List API Operations


Session
 Login
Operation to login to API.
 Logout
Operation to logout from API.

Top Up
 Get Top Up Product Type List
Operation to get list of top up product type to be used in top up API request.
 Get Top Up Provider List
Operation to get list of top up provider to be used in top up API request.
 Get Top Up Product List
Operation to get list of top up product to be used in top up API request.
 Set Order Top Up
Operation to order top up via API.
 Get List Top Up Transaction
Operation to get agent’s list of top up transaction via API.
 Get Top Up Transaction Detail
Operation to get information detail of agent’s top up transaction via API.

PPOB
 Get PPOB Product Group List
Operation to get list of PPOB product group to be used in top up API request.
 Get PPOB Up Product List
Operation to get list of PPOB product to be used in top up API request.
 Set Inquiry PPOB
Operation to check PPOB inquiry information via API.
 Set Payment PPOB
Operation to set PPOB payment via API.
 Set Open Payment PPOB
Operation to set PPOB open payment via API.
 Get List PPOB Transaction
Operation to get agent’s list of PPOB transaction via API.
 Get PPOB Trasaction Detail
Operation to get information detail of agent’s PPOB transaction via API.
Topup Transaction Flowchart

*Impotant Note
-Please be careful, FAILED response status does not indicate that your order
transaction is also FAILED

- each order process must end with ‘Transaction Detail’ execution especially for
cases when finding FAILED response with respMessage ‘transaction status is PENDING please
check transaction detail’ or timeout error

- when you find your transaction status ‘Pending’, you can check your newest transaction status
via the ‘TransactionDetail’ feature because the ‘Pending’ transaction status can be a ‘Failed or
‘Success.

- Pending means that your balance has been deducted and transactions in our admin validation
process, the transaction status can change to ‘Failed or ‘Success’

- Success means the status of your transaction is successfully paid and your Failed means
transaction fails
PPOB Transaction Flowchart

*Impotant Note
-Please be careful, FAILED response status does not indicate that your order
transaction is also FAILED

- each payment and open payment process must end with ‘Transaction Detail’
execution especially for cases when finding FAILED response with respMessage ‘transaction
status is PENDING please check transaction detail’ or timeout error

- when you find your transaction status ‘Pending’, you can check your newest transaction status
via the ‘TransactionDetail’ feature because the ‘Pending’ transaction status can be a ‘Failed or
‘Success.

- Pending means that your balance has been deducted and transactions in our admin validation
process, the transaction status can change to ‘Failed or ‘Success’

- Success means the status of your transaction is successfully paid and your Failed means
transaction fails
Detail Request and Response Information
Session
 Login

Url : https://139.255.78.145/h2h/Session/Login

Request

No Name Description Type Additional information


1 userID API User ID string
2 token Timestamp format "yyyy-MM- string Example timestamp: 2015-12-
dd’T’HH:mm:ss". 21T15:10:20
3 securityCode Code for authentication string
format MD5(token +
MD5(Password))

Response

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain string
access to all API
operation
3 status Response status string SUCCESS or FAILED
4 respMessage Detail description of string
status
5 respTime Time of response sent datetime Format yyyy-MM-dd’T’
HH:mm:ss

Example Request

{
"userID" : "UserAPI",
"securityCode":"7fab9b1cf1c9e670dbed69d4a65c2aaa",
"token":"2015-12-07T15:10:20"
}

Example Response

{
"accessToken":"7fab9b1cf1c9e670dbed69d4a65c2aaa ",
"respTime":"2015-12-07T15:10:20",
"userID":"UserAPI",
"status":"SUCCESS",
"respMessage":"SUCCESS"
}

 Logout
Url : https://139.255.78.145/h2h/Session/Logout

Request

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain access to string
all API operation
3 token Timestamp format "yyyy-MM- string Example timestamp: 2015-12-
dd’T’HH:mm:ss". 21T15:10:20

Response

No Name Description Type Additional information


1 UserID API User ID string
2 accessToken Access token to gain string
access to all API
operation
3 status Response status string SUCCESS or FAILED
4 respMessage Detail description of string
status
5 respTime Time of response sent datetime Format yyyy-MM-dd’T’
HH:mm:ss

Example Request

{
"userID" : "UserAPI",
"accessToken":"7fab9b1cf1c9e670dbed69d4a65c2aaa",
"token":"2015-12-07T15:10:20"
}

Example Response

{
"accessToken":"7fab9b1cf1c9e670dbed69d4a65c2aaa",
"respTime":"2015-12-07T15:10:20",
"userID":"UserAPI",
"status":"SUCCESS",
"respMessage":"SUCCESS"
}
Top Up

 Get Top Up Product Type List


Url : https:// 139.255.78.145/h2h/TopUp/ProductType

Request

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain access to string
all API operation

Response

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain string
access to all API
operation
3 status Response status string SUCCESS or FAILED
4 respMessage Detail description of string
status
5 respTime Time of response sent datetime Format yyyy-MM-dd’T’
HH:mm:ss
6 productTypes List of product type Collection of string

Example Request

"userID" : "UserAPI",

"accessToken":"fd492c0ec2d3c14691f3f3c3a606f123"

Example Response

{
"productTypes":
[
"GAME",
"PULSA",
"TOKENPLN"
],
"respTime":"2016-01-19T11:01:35.1300202+07:00",
"userID":"cokie",
"accessToken":"fd492c0ec2d3c14691f3f3c3a606f123",
"status":"SUCCESS",
"respMessage":"SUCCESS"
}

 Get Top Up Provider List


Url : https://139.255.78.145/h2h/TopUp/Provider

Request

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain access to string
all API operation
3 productType Topup product type string

Response

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain string
access to all API
operation
3 status Response status string SUCCESS or FAILED
4 respMessage Detail description of string
status
5 respTime Time of response sent datetime Format yyyy-MM-dd’T’
HH:mm:ss
6 productTypes TopUp product type string
7 providers List of provider Collection of string
Example Request

"userID" : " UserAPI",

"accessToken":"fd492c0ec2d3c14691f3f3c3a606f123",

"productType":"PULSA",

Example Response

"productType":"PULSA",

"providers":

"AXIS DATA",

"IM3",

"SIMPATI"

],

"respTime":"2016-01-19T11:04:32.5221665+07:00",

"userID":" UserAPI",

"accessToken":"fd492c0ec2d3c14691f3f3c3a606f123",

"status":"SUCCESS",

"respMessage":"SUCCESS"

}
 Get Top Up Product List
Url : https://139.255.78.145/h2h/TopUp/ProductType

Request

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain access to string
all API operation
3 provider Topup provider string

Response

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain string
access to all API
operation
3 status Response status string SUCCESS or FAILED
4 respMessage Detail description of string
status
5 respTime Time of response sent datetime Format yyyy-MM-dd’T’
HH:mm:ss
6 products List of provider Collection of
TopupProduct
6.1 code Product code string
6.2 provider Provider string
6.3 price Product price decimal
6.4 name Product name string
6.5 type Product type string
6.6 isActive Product status active bool If product isActive true,
that product can be
ordered
Example Request

"userID" : " UserAPI",

"accessToken":"fd492c0ec2d3c14691f3f3c3a606f123",

"provider":"IM3",

Example Response

"products":

"code":"3|HIL5",

"provider":"IM3",

"price":5700.00,

"name":"IM3 REGULER 5000",

"type":"PULSA",

"isActive":true

},

"code":"4|HI5G",

"provider":"IM3",

"price":5800.00,

"name":"IM3 PAKET GPRS 5000",

"type":"PULSA",

"isActive":true

},
{

"code":"5|HI5S",

"provider":"IM3",

"price":5800.00,

"name":"IM3 RPAKET SMS 5000",

"type":"PULSA",

"isActive":true

],

"respTime":"2016-01-19T11:04:32.5221665+07:00",

"userID":" UserAPI",

"accessToken":"fd492c0ec2d3c14691f3f3c3a606f123",

"status":"SUCCESS",

"respMessage":"SUCCESS"

 Set Order Top Up


Url : https://139.255.78.145/h2h/TopUp/Order

*note: transaction status is divided into 4 types : “REQUEST”, “PENDING”, “SUCCESS”,


“REQUEST_FAILED”, “TRANSACTION_FAILED”, and “FAILED”. REQUEST : the transaction is being
requested from the provider. PENDING : transactions being processed by the provider.
REQUEST_FAILED, TRANSACTION_FAILED, FAILED : transaction failed. SUCCESS : transaction
processed successfully.

Request

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain access to string
all API operation
3 productCode Top up product code string
4 MSISDN Customer MSISDN string
5 customerID Customer ID string Required in pln token
6 sequence Serial number for same msisdn int Filled with 1 for first transaction
same day (same msisdn same day),

Response

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain string
access to all API
operation
3 status Response status string SUCCESS or FAILED
4 respMessage Detail description of string
status
5 respTime Time of response sent datetime Format yyyy-MM-dd’T’
HH:mm:ss
6 transactionDate order date datetime Format yyyy-MM-dd’T’
HH:mm:ss
7 transactionStatus order status string "REQUEST", "PENDING",
“SUCCESS”,”FAILED”
8 transactionID transaction ID string
9 addtionalMessage additional message string
10 referenceID transaction billing string
refference ID
11 productCode product code string
12 MSISDN customer MSISDN string

Example Request

"userID" : " UserAPI",

"accessToken":"db0d08f31bffe5431ed2a995f276ac5c",

"productCode":"4|HI5G",

"MSISDN":"085655308xxx",

"customerID":"",

"sequence":1

}
Example Response

"transactionDate":"2016-01-27",

"transactionStatus":"PENDING",

"transactionID":"0000020160127100754",

"additionalMessage":"Order : 4|HI5G, MSISDN: 085655308xxx, VSN :


0000020160127100754 telah dikirim",

"referenceID":"10|20160127100751",

"productCode":"4|HI5G",

"MSISDN":"085655308xxx",

"respTime":"2016-01-27T10:08:15.4350819+07:00",

"userID":" UserAPI",

"accessToken":"1836d6279111c7b5d908444f6c457836",

"status":"SUCCESS",

"respMessage":"SUCCESS"

 Get List Top Up Transaction


Url : https://139.255.78.145/h2h/TopUp/TransactionList
*note: transaction status is divided into 4 types : “REQUEST”, “PENDING”, “SUCCESS”,
“REQUEST_FAILED”, “TRANSACTION_FAILED”, and “FAILED”. REQUEST : the transaction is
being requested from the provider. PENDING : transactions being processed by the provider.
REQUEST_FAILED, TRANSACTION_FAILED, FAILED : transaction failed. SUCCESS : transaction
processed successfully.

Request

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain string
access to all API operation
3 startDate date start filter datetime Format yyyy-MM-dd
4 endDate date end filter datetime Format yyyy-MM-dd

Response

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain string
access to all API
operation
3 status Response status string SUCCESS or FAILED
4 respMessage Detail description of string
status
5 respTime Time of response sent datetime Format yyyy-MM-dd’T’
HH:mm:ss
6 list list of top up Collection of
transaction TopUpTransaction
6.1 productCode top up product code string Format yyyy-MM-dd’T’
HH:mm:ss
6.2 MSISDN customer MSISDN string
6.3 SN transaction serial string
number
6.4 productDescription product description string
6.5 sellPrice top up sell price string
6.6 transactionStatus transaction status string "REQUEST", "PENDING",
“SUCCESS”,”FAILED”,
“REQUEST_FAILED”,
“TRANSACTION_FAILED”
6.7 transactionDate order date datetime Format yyyy-MM-dd’T’
HH:mm:ss
6.8 referenceID top up billing string
reference ID

Example Request

"userID" : "UserAPI",
"accessToken":"1d50f5625ca4314511eaad659a0fc139",
"startDate":"2016-01-01",
"endDate":"2016-01-31"
}

Example Response

"list":

"productCode":"3|HIL5",

"MSISDN":"085748543623",

"SN":"0031000714844541",

"productDescription":"IM3 REGULER 5000",

"sellPrice":6200.00,

"transactionStatus":"SUCCESS",

"transactionDate":"2016-01-23T16:24:04.807",

"referenceID":"9|20160123162406"

},

"productCode":"4|HI5G",

"MSISDN":"085748543623",

"SN":"0000020160127100754",

"productDescription":"IM3 PAKET GPRS 5000",

"sellPrice":6300.00,

"transactionStatus":"SUCCESS",

"transactionDate":"2016-01-27T10:07:47.463",

"referenceID":"10|20160127100751"

],

"respTime":"2016-01-27T11:16:22.0138208+07:00",
"userID":"UserAPI",

"accessToken":"1d50f5625ca4314511eaad659a0fc139",

"status":"SUCCESS",

"respMessage":"SUCCESS"

 Get Top Up Transaction Detail


Url : https://139.255.78.145/h2h/TopUp/TransactionDetail
*note: transaction status is divided into 4 types : “REQUEST”, “PENDING”, “SUCCESS” and
“FAILED”. REQUEST : the transaction is being requested from the provider. PENDING :
transactions being processed by the provider. FAILED : transaction failed. SUCCESS :
transaction processed successfully.

Request

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain string
access to all API operation
3 referenceID transaction billing string
refference ID
4 agentReferenceID Is used when topup string The composition is :
response failed and -When customerID is not
referenceID is empty empty :
customerID.MSISDN.sequence,
ex : 5647.0811737381.1
-When customerID is empty :
MSISDN.sequence, ex:
0811737381.1

Response

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain string
access to all API
operation
3 status Response status string SUCCESS or FAILED
4 respMessage Detail description of string
status
5 respTime Time of response sent datetime Format yyyy-MM-dd’T’
HH:mm:ss
6 detail Detail top up TopUpTransaction
transaction
6.1 productCode top up product code string Format yyyy-MM-dd’T’
HH:mm:ss
6.2 MSISDN customer MSISDN string
6.3 SN transaction serial string
number
6.4 productDescription product description string
6.5 sellPrice top up sell price string
6.6 transactionStatus transaction status string "REQUEST", "PENDING",
“SUCCESS”,”FAILED”,
“REQUEST_FAILED”,
“TRANSACTION_FAILED”
6.7 transactionDate order date datetime Format yyyy-MM-dd’T’
HH:mm:ss
6.8 referenceID top up billing string
reference ID

Example Request

"userID" : "UserAPI",
"accessToken":"1d50f5625ca4314511eaad659a0fc139",
"referenceID":"9|20160123162406",
"agentReferenceID":"",
}

Example Response

"detail":

"productCode":"3|HIL5",

"MSISDN":"085748543623",

"SN":"0031000714844541",

"productDescription":"IM3 REGULER 5000",


"sellPrice":6200.00,

"transactionStatus":"REQUEST",

"transactionDate":"2016-01-23T16:24:04.807",

"referenceID":":"9|20160123162406"

},

"respTime":"2016-01-27T11:20:12.08298+07:00",

"userID":"UserAPI",

"accessToken":"1d50f5625ca4314511eaad659a0fc139",

"status":"SUCCESS",

"respMessage":"SUCCESS"

}
PPOB

 Get PPOB Product Group List


Url : https://139.255.78.145/h2h/PPOB/ProductGroup

Request

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain access to string
all API operation

Response

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain string
access to all API
operation
3 status Response status string SUCCESS or FAILED
4 respMessage Detail description of string
status
5 respTime Time of response sent datetime Format yyyy-MM-dd’T’
HH:mm:ss
6 productGroups List of product group Collection of string

Example Request

"userID" : "UserAPI",

"accessToken":"177e320333d395c50794e2332682a98d"

Example Response

{
"productGroups":
[
"MULTI FINANCE",
"PDAM",
"PLN",
"PULSA PASCABAYAR",
"TAGIHAN TV (KABEL & SATELIT)",
"TELKOM",
],
"respTime":"2016-01-19T11:15:43.6235513+07:00",
"userID":"UserAPI",
"accessToken":"177e320333d395c50794e2332682a98d",
"status":"SUCCESS",
"respMessage":"SUCCESS"
}

 Get PPOB Product List


Url : https://139.255.78.145/h2h/PPOB/ProductGroup
an open payment product is a product whose nominal payment is in accordance with what the
user wants, in contrast to the type of not open payment, whose payment is in accordance
with the nominal bill at the time of the inquiry process

Request

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain access to string
all API operation
3 productGroup Product group string

Response

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain string
access to all API
operation
3 status Response status string SUCCESS or FAILED
4 respMessage Detail description of string
status
5 respTime Time of response sent datetime Format yyyy-MM-dd’T’
HH:mm:ss
6 productList List of provider Collection of
TopupProduct
6.1 code Product code string
6.2 group Product group string
6.3 name Product name string
6.4 isActive Product status active bool If product isActive true,
that product can be
ordered
6.5 isOpenPayment Product is open payment bool If is open payment then
this product must be paid
through
PPOB/OpenPayment

Example Request

"userID" : "UserAPI",

"accessToken":"177e320333d395c50794e2332682a98d",

"productGroup":"MULTI FINANCE",

Example Response

"productList":

"code":"BAF",

"name":"Bussan Auto Finance (BAF)",

"group":"MULTI FINANCE",

"isActive":true,

"isOpenPayment":false

},
{

"code":"WOM",

"name":"Wahana Ottomitra Multiartha (WOM)",

"group":"MULTI FINANCE",

"isActive":true,

"isOpenPayment":false

},

"code":"MCF",

"name":"Mega Central Finance (MCF)",

"group":"MULTI FINANCE",

"isActive":true,

"isOpenPayment":false

},

"code":"MAF",

"name":"Mega Auto Finance (MAF)",

"group":"MULTI FINANCE",

"isActive":true,

"isOpenPayment":false

},

"code":"ADIRA",

"name":"Adira Finance",

"group":"MULTI FINANCE",

"isActive":true,

"isOpenPayment":false
}

],

"respTime":"2016-01-19T11:19:03.0779594+07:00",

"userID":"UserAPI",

"accessToken":"177e320333d395c50794e2332682a98d",

"status":"SUCCESS",

"respMessage":"SUCCESS"

 Set Inquiry PPOB


Url : https://139.255.78.145/h2h/PPOB/Inquiry
*if the product which want to be inquired is open payment type then the value other than bill
reference will be null or empty

Request

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain access to string
all API operation
3 productCode Product code string
4 customerID Customer ID string
5 customerMSISDN Customer MSISDN string

Response

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain string
access to all API
operation
3 status Response status string SUCCESS or FAILED
4 respMessage Detail description of string
status
5 respTime Time of response sent datetime Format yyyy-MM-dd’T’
HH:mm:ss
6 productCode product code string
7 billingReferenceID transaction billing string
refference ID
8 customerID customer ID string
9 customerMSISDN customer MSISDN string
10 customerName customer name string
11 period billing period string
12 policeNumber billing police number string specially for finance
(vehicle installment)
13 lastPaidPeriod period of lastest string
installment
14 tenor the number of tenor string
15 lastPaidDueDate payment due date string
16 usageUnit usage unit string
17 penalty amount of penalty decimal
18 payment total payment that decimal
should be paid by agent
19 minPayment minimum limit to be decimal
paid
20 maxPayment maximum limit to be decimal
paid
21 additional Message additional message string
22 productGroup PPOB product group
23 billing total billing decimal
24 sellPrice cut off amount from decimal
agent's balance
25 adminBank bank adminstration fee decimal
26 profit agent's profit decimal

Example Request

"userID" : "UserAPI",

"accessToken":"0a6e9f6f021cc003fb1e3e973b71550c",

"productCode":"BAF",

"customerID":"416010064xxx",

"customerMSISDN":"085730546xxx"
}

Example Response

"productCode":"BAF",

"billingReferenceID":"d37-f3fdf7d117b",

"customerID":"416010064xxx",

"customerMSISDN":"085730546xxx",

"customerName":"WELLY",

"period":null,

"policeNumber":"L 5723 XX",

"lastPaidPeriod":"024",

"tenor":"035",

"lastPaidDueDate":"20160201",

"usageUnit":null,

"penalty":21700.0,

"payment":546000.0,

"minPayment":544000.0,

"maxPayment":1628000.0,

"additionalMessage":null,

"productGroup":"MULTI FINANCE",

"billing":544000.0,

"sellPrice":543950.0,

"adminBank":2000.0,

"profit":2050.0,

"respTime":"2016-01-26T16:14:37.8850792+07:00",

"userID":"UserAPI",
"accessToken":"0a6e9f6f021cc003fb1e3e973b71550c",

"status":"SUCCESS",

"respMessage":"SUCCESS"

 Set Payment PPOB


Url : https://139.255.78.145/h2h/PPOB/Payment
*note: transaction status is divided into 4 types : “REQUEST”, “PENDING”, “SUCCESS” and
“FAILED”. REQUEST : the transaction is being requested from the provider. PENDING :
transactions being processed by the provider. FAILED : transaction failed. SUCCESS :
transaction processed successfully.
*please after execution of payment, any response obtained either successful response or
failed response, must proceed with TransactionDetail execution to know the latest status of
transaction.
*only available for not open payment product

Request

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain access to string
all API operation
3 billingReferenceID Product code string

Response

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain string
access to all API
operation
3 status Response status string SUCCESS or FAILED
4 respMessage Detail description of string
status
5 respTime Time of response datetime Format yyyy-MM-dd’T’ HH:mm:ss
sent
6 productCode product code string
7 billingReferenceID transaction billing string
refference ID
8 customerID customer ID string
9 customerName customer name string
10 period billing period string
11 additionalMessage additional message string

Example Request

"userID" : "UserAPI",

"accessToken":"0a6e9f6f021cc003fb1e3e973b71550c",

"billingReferenceID":"e43-c4-34ec3aa0"

Example Response

"additonalMessage":null,

"productCode":"PLN",

"customerID":"511810393xxx",

"customerName":"KASI",

"period":"201601",

"billingReferenceID":"e43-c4-34ec3aa0",

"respTime":"2016-01-26T15:59:52.5544412+07:00",

"userID":"UserAPI",

"accessToken":"0a6e9f6f021cc003fb1e3e973b71550c",

"status":"SUCCESS",

"respMessage":"SUCCESS"

}
 Set Open Payment PPOB
Url : https://139.255.78.145/h2h/PPOB/OpenPayment
*note: transaction status is divided into 4 types : “REQUEST”, “PENDING”, “SUCCESS” and
“FAILED”. REQUEST : the transaction is being requested from the provider. PENDING :
transactions being processed by the provider. FAILED : transaction failed. SUCCESS :
transaction processed successfully.
*please after execution of payment, any response obtained either successful response or
failed response, must proceed with TransactionDetail execution to know the latest status of
transaction.
*only available for not open payment product

Request

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain access string
to all API operation
3 billingReferenceID Product code string
4 productCode Product code string
5 customerID Customer ID string
6 customerMSISDN Customer MSISDN string
7 agentPayment Nominal payment decimal

Response

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain string
access to all API
operation
3 status Response status string SUCCESS or FAILED
4 respMessage Detail description of string
status
5 respTime Time of response datetime Format yyyy-MM-dd’T’ HH:mm:ss
sent
6 productCode product code string
7 billingReferenceID transaction billing string
refference ID
8 customerID customer ID string
9 customerName customer name string
10 period billing period string
11 additionalMessage additional message string
12 sellPrice cut off amount from decimal
agent's balance
13 cashBackProfit the profit value decimal
given to the agent's
balance in cashback

Example Request

"userID" : "UserAPI",

"accessToken":"f7ff891218b4f2be0584e9b5e5e5a9f8",

"productCode":"BNI",

"customerID":"800700047539",

"customerMSISDN":"085655308669",

"billingReferenceID":"20180623092113",

"agentPayment":100000

Example Response

"additionalMessage":null,

"productCode":"BNI",

"customerID":"800700047539",

"customerName":"800700047539",

"period":"",

"billingReferenceID":"20180623092113",

"sellPrice":100100.00,
"cashBackProfit":370.00,

"respTime":"2018-06-23T09:22:03.8312164+07:00",

"userID":"UserAPI",

"accessToken":"f7ff891218b4f2be0584e9b5e5e5a9f8",

"status":"SUCCESS",

"respMessage":"SUCCESS"

 Get List PPOB Transaction


Url : https://139.255.78.145/h2h/PPOB/TransactionList
*note: transaction status is divided into 4 types : “REQUEST”, “PENDING”, “SUCCESS” and
“FAILED”. REQUEST : the transaction is being requested from the provider. PENDING :
transactions being processed by the provider. FAILED : transaction failed. SUCCESS :
transaction processed successfully.

Request

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain string
access to all API operation
3 startDate date start filter datetime Format yyyy-MM-dd
4 endDate date end filter datetime Format yyyy-MM-dd

Response

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain string
access to all API
operation
3 status Response status string SUCCESS or FAILED
4 respMessage Detail description of string
status
5 respTime Time of response sent datetime Format yyyy-MM-dd’T’
HH:mm:ss
6 list list of ppob Collection of
transaction PPOBTransaction
6.1 transactionDate PPOB transaction date datetime Format yyyy-MM-dd’T’
HH:mm:ss
6.2 productCode PPOB product code string
6.3 productDescription PPOB product string
description
6.4 customerID customer ID string
6.5 customerName customer name string
6.6 period billing period string
6.7 sellPrice cut off amount from decimal
agent's balance
6.8 totalPayment the amount should be decimal
paid by agent
6.9 transactionStatus transaction status string "REQUEST",
"PENDING",
“SUCCESS”,”FAILED”
6.10 billingReferenceID transaction billing string
reference ID
6.11 cashBackProfit the profit value given decimal Filled in open payment
to the agent's balance transaction
in cashback

Example Request

"userID" : "UserAPI",
"accessToken":"200a4a2b3dc73117021c627e051c6d2b",
"startDate":"2016-01-01",
"endDate":"2016-01-31"
}

Example Response

"list":

{
"transactionDate":"2016-01-26T13:05:37.96",

"productCode":"PLN",

"productDescription":"PLN",

"customerID":"511810393xxx",

"customerName":"KASI",

"periode":"201601",

"sellPrice":120198.00,

"totalPayment":118698.00,

"transactionStatus":"SUCCESS",

"billingReferenceID":"e43-c4-34ec3aa0",

"cashBackProfit":0

},

"transactionDate":"2016-01-26T16:14:00.157",

"productCode":"BAF",

"productDescription":"Bussan Auto Finance (BAF)",

"customerID":"416010064xxx",

"customerName":"WELLY ",

"periode":"",

"sellPrice":543950.00,

"totalPayment":544000.00,

"transactionStatus":"SUCCESS",

"billingReferenceID":"d37-f3fdf7d117b",

"cashBackProfit":0

],

"respTime":"2016-01-27T09:23:14.7916139+07:00",
"userID":"UserAPI",

"accessToken":"200a4a2b3dc73117021c627e051c6d2b",

"status":"SUCCESS",

"respMessage":"SUCCESS"

 Get PPOB Transaction Detail


Url : http:// 139.255.78.145/h2h/PPOB/TransactionDetail
*note: transaction status is divided into 4 types : “REQUEST”, “PENDING”, “SUCCESS” and
“FAILED”. REQUEST : the transaction is being requested from the provider. PENDING :
transactions being processed by the provider. FAILED : transaction failed. SUCCESS :
transaction processed successfully.

Request

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain string
access to all API operation
3 customerID Customer ID string
4 billingReferenceID billing reference ID string

Response

No Name Description Type Additional information


1 userID API User ID string
2 accessToken Access token to gain string
access to all API
operation
3 status Response status string SUCCESS or FAILED
4 respMessage Detail description of string
status
5 respTime Time of response sent datetime Format yyyy-MM-dd’T’
HH:mm:ss
6 detail detail information of PPOBTransaction
PPOB transaction
6.1 transactionDate PPOB transaction date datetime Format yyyy-MM-dd’T’
HH:mm:ss
6.2 productCode PPOB product code string
6.3 productDescription PPOB product string
description
6.4 customerID customer ID string
6.5 customerName customer name string
6.6 period billing period string
6.7 sellPrice cut off amount from decimal
agent's balance
6.8 totalPayment the amount should be decimal
paid by agent
6.9 transactionStatus transaction status string "REQUEST",
"PENDING",
“SUCCESS”,”FAILED”
6.10 billingReferenceID transaction billing string
reference ID
6.11 cashBackProfit the profit value given decimal Filled in open payment
to the agent's balance transaction
in cashback

Example Request

"userID" : "UserAPI",
"accessToken":"11a9554baeffed2e9c394eb017af9486",
"customerID":"511810393873",
"billingReferenceID":"e43-c4-34ec3aa0"
}

Example Response

"detail":

"transactionDate":"2016-01-26T13:05:37.96",

"productCode":"PLN",

"productDescription":"PLN",

"customerID":"511810393xxx",

"customerName":"KASI",
"periode":"201601",

"sellPrice":120198.00,

"totalPayment":118698.00,

"transactionStatus":"SUCCESS",

"billingReferenceID":"e43-c4-34ec3aa0",

"cashBackProfit":0

},

"respTime":"2016-01-27T09:46:45.8383212+07:00",

"userID":"UserAPI",

"accessToken":"11a9554baeffed2e9c394eb017af9486",

"status":"SUCCESS",

"respMessage":"SUCCESS"

}
Error Descriptions

No Name Description
1 wrong format request or null request do not match with format given or request
mandatory data property that should be filled, has set with null or
empty value. Property format not appropriate with
format given, can create this error.
2 member authentication Wrong access token or session login has been
failed expired.
3 topup failed Top up order process failed
4 PPOB failed PPOB inquiry or payment process failed
5 PPOB product inactive Product status not active, can not be inquired or paid
6 topup voucher inactive Product status not active, can not be ordered
7 invalid voucher reference ID Wrong voucher reference ID is not listed in the
system
8 Same Order is being In topoup same msisdn, sequence and productType
Processed in same day is prohibited, in ppob same customerID,
productCode in same day is prohibited
9 PPOB dan TopUp Can’t use ppob and topup all fitur in 23:30 - 01:00
Maintenance at 23:30 - 01:00 WIB
WIB
10 Disable Topup Transaction Agent authorization for topup fitur has been disabled
11 Disable PPOB Transaction Agent authorization for ppob fitur has been disabled

Vous aimerez peut-être aussi