SiDOMPUL - Open API Specification v1.3 221122
SiDOMPUL - Open API Specification v1.3 221122
SiDOMPUL
API Specification – Open API
PT XL Axiata TBK
XL Axiata Tower, Kav 11 Kav X-2 5, Jl. H. R. Rasuna Said No.5, RT.7/RW.2
Kuningan, East Kuningan, Setiabudi, Jakarta Selatan - Jakarta 12950 Indonesia
1
Revision History
2
SiDompul Low API Service Documentation | Confidential
Copyright Notice
COPYRIGHT© 2022 XL Axiata. This document is unpublished and the foregoing notice is affixed to protect XL Axiata
in the event of inadvertent publication. All rights reserved. No part of this document may be reproduced in any form,
including photocopying or transmission electronically to any computer, without prior written consent of XL Axiata.
The information contained in this document is confidential and proprietary to XL Axiata and may not be used or
disclosed except as expressly authorized in writing by XL Axiata. Copyright protection includes material generated
from our software programs displayed on the screen, such as icons, screen displays, and the like.
Trademarks
All brand and product names are trademarks or registered trademarks of their respective holders and are hereby
acknowledged. Technologies described herein are either covered by existing patents or patent applications are in
progress.
Confidentiality
The information in this document is subject to change without notice. This document contains information that is
confidential and proprietary to XL Axiata and its affiliates and may not be copied, published, or disclosed to others,
or used for any purposes other than review, without written authorization of an officer of XL Axiata. Submission of
this document does not represent a commitment to implement any portion of this specification in the products of
the submitters.
Content Warranty
The information in this document is subject to change without notice. THIS DOCUMENT IS PROVIDED “AS IS” AND
XL AXIATA MAKES NO WARRANTY, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO ALL
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. XL Axiata shall not be liable for errors
contained herein or for incidental or consequential damages in connection with the furnishing, performance or use
of this material.
Export
This document and related technical data, are subject to INA export control laws, including without limitation the
INA Export Administration Act and its associated regulations, and may be subject to export or import regulations of
other countries. You agree not to export or re-export this document in any form in violation of the applicable export
or import laws of the United States or any foreign jurisdiction. For more information, please contact:
PT XL Axiata TBK, Axiata Tower Kav 11 Kav X-2 5, Jl. H. R. Rasuna Said No.5, RT.7/RW.2 Kuningan, East Kuningan,
Setiabudi, Jakarta Selatan - Jakarta 12950 Indonesia
3
SiDompul Low API Service Documentation | Confidential
Table of Contents
1. Introduction ................................................................................................................................. 5
1.1 About this document .................................................................................................................. 5
1.2 Intended audience...................................................................................................................... 5
2. API Specification........................................................................................................................... 6
2.1 Authorization .............................................................................................................................. 6
2.1.1 Get Token ............................................................................................................................... 6
2.2 Security ....................................................................................................................................... 7
2.2.1 Encrypt ................................................................................................................................... 7
2.3 Transaction ................................................................................................................................. 8
2.3.1 Purchase Package ................................................................................................................... 8
2.3.2 Transaction History ................................................................................................................ 9
2.3.3 Reload W2P .......................................................................................................................... 10
2.3.4 Get Dompul Balance............................................................................................................. 11
2.3.5 Get Pulsa Balance ................................................................................................................. 12
2.3.6 Get List Product Code........................................................................................................... 13
2.3.7 Purchase Package Deduct Pulsa ........................................................................................... 14
2.3.8 AWG Get Stock ..................................................................................................................... 15
2.3.9 AWG Get Info Transaction ................................................................................................... 17
2.3.10 AWG Inject Stock ............................................................................................................. 19
2.3.11 XWG Get Stock ................................................................................................................. 21
2.3.12 XWG Get Info Transaction ............................................................................................... 23
2.3.13 XWG Inject Stock.............................................................................................................. 25
3. High Level Diagram ..................................................................................................................... 27
4. General Response Code .............................................................................................................. 28
4
SiDompul Low API Service Documentation | Confidential
1. Introduction
1.1 About this document
Digital DomPul is a MUST HAVE but seeing at current competitive landscape, need a STRONG value
proposition to give RO a REASON-TO-USE. Digitalization on traditional 151 UMB and SMS is a must
to begin the service journey to hybrid/native Cloud. The important thing after development is a
technical documentation regarding the service. It’s required for enhancement purpose and
operational matter. The purpose of this document is to describe detail technical specification of
digital Dompul Services. Its a complete description of the services based on requirement and design
assessment.
1.2 Intended audience
This document addresses RO Player / Server to develop end to end digital dompul platform.
5
SiDompul Low API Service Documentation | Confidential
2. API Specification
2.1 Authorization
For requests that require authentication, the token must be communicated in a header:
Authorization: <BEARER_TYPE> <ACCESS_TOKEN>
URL https://gateway.egw.xl.co.id/token
METHOD POST
Content-Type application/x-www-form-urlencoded
Sample Request
curl -L -X POST 'https://gateway.egw.xl.co.id/token' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=<client_id>' \
--data-urlencode 'client_secret=<client_secret>'
Response 200
{
"access_token": "b60ba81c-498a-3a0b-89ba-f09e463b21e5",
"scope": "am_application_scope axp_dynamic_scope_1657772063332",
"token_type": "Bearer",
"expires_in": 3600
}
Element Type sample Desc
access_token string b60ba81c-498a-3a0b-89ba Access Token
scope string am_application_scope Scope
token_type string Bearer Token Type
expires_in number 3600 Token expiration in seconds
6
SiDompul Low API Service Documentation | Confidential
2.2 Security
2.2.1 Encrypt
URL https://gateway.egw.xl.co.id/sidompul/openapi/v1/post-encrypt
METHOD POST
Content-Type application/json
Authorization Bearer
apiid API-ID
apikey API-KEY
language ID
Request Body
{
"data": "1233"
}
Response 200
{
"statusCode": 200,
"statusMessage": "OK",
"statusDescription": "Request succeeded without error",
"result": {
"errorCode": "00",
"errorMessage": "Sukses",
"data": "vcHSKNpbzbU0wQQep31OAg=="
}
}
Response 400
{
"statusCode": 404,
"statusMessage": "Not Found",
"statusDescription": "The requested resource was not found on the
server",
"result": {
"errorCode": "28",
"errorMessage": "Payload token tidak valid"
}
}
7
SiDompul Low API Service Documentation | Confidential
2.3 Transaction
URL https://gateway.egw.xl.co.id/sidompul/openapi/v1/post-package
METHOD POST
Content-Type application/json
Authorization Bearer
apiid API-ID
apikey API-KEY
language ID
Request Body
{
"msisdn": "6287787237069",
"pin": "vcHSKNpbzbU0wQQep31OAg==",
"productCode": "XTRA_EDUKASI"
}
Response 200
{
"statusCode": 200,
"statusMessage": "OK",
"statusDescription": "Request succeeded without error",
"result": {
"errorCode": "00",
"errorMessage": "Sukses",
"data": {
"description": "Transaksi sedang di proses"
}
}
}
8
SiDompul Low API Service Documentation | Confidential
2.3.2 Transaction History
URL https://gateway.egw.xl.co.id/sidompul/openapi/v1/get-transaction-
history?startdate={{startdate}}&enddate={{enddate}}
METHOD GET
Content-Type application/json
Authorization Bearer
apiid API-ID
apikey API-KEY
language ID
Response 200
{
"statusCode":200,
"statusMessage":"OK",
"statusDescription":"Request succeeded without error",
"result":{
"errorCode":"00",
"errorMessage":"Sukses",
"data":[
{
"service_type":"fulfillment",
"serial_number":"TK_DSUNFF5",
"status":"success",
"product":"Free Fire 5 Diamonds + 100MB",
"amount":"1000.0",
"date":"2022-10-07 15:08:57.000",
"dest_number":"6287734910051",
"next_bal":"",
"payment_method":"DOMPUL"
}
]
}
}
9
SiDompul Low API Service Documentation | Confidential
2.3.3 Reload W2P
URL https://gateway.egw.xl.co.id/sidompul/openapi/v1/post-w2p
METHOD POST
Content-Type application/json
Authorization Bearer
apiid API-ID
apikey API-KEY
language ID
Request Body
{
"msisdn": "6287787237069",
"pin": "IZVOgzZy5g0QVhAc3FAo3Q==",
"denom": 25000
}
Response 200
{
"statusCode": 200,
"statusMessage": "OK",
"statusDescription": "Request succeeded without error",
"result": {
"errorCode": "00",
"errorMessage": "Sukses",
"data": {
"transactionId": "TKXL2607e47f67",
"remainingBalance": "25238147",
"msisdn": "6287787237069",
"denomination": 25000,
"description": "Transaksi dgn No. TKXL2607e47f67 berhasil
utk pengisian pulsa ke 6287723633334 sebesar 10000 . Sisa Dompet Pulsa
Anda skrg: 25238147"
}
}
}
10
SiDompul Low API Service Documentation | Confidential
2.3.4 Get Dompul Balance
URL https://gateway.egw.xl.co.id/sidompul/openapi/v1/get-dompul-balance
METHOD GET
Content-Type application/json
Authorization Bearer
apiid API-ID
apikey API-KEY
language ID
Response 200
{
"statusCode": 200,
"statusMessage": "OK",
"statusDescription": "Request succeeded without error",
"result": {
"errorCode": "00",
"errorMessage": "Sukses",
"data": 12627
}
}
11
SiDompul Low API Service Documentation | Confidential
2.3.5 Get Pulsa Balance
URL https://gateway.egw.xl.co.id/sidompul/openapi/v1/get-pulsa-balance
METHOD GET
Content-Type application/json
Authorization Bearer
apiid API-ID
apikey API-KEY
language ID
Response 200
{
"statusCode": 200,
"statusMessage": "OK",
"statusDescription": "Request succeeded without error",
"result": {
"errorCode": "00",
"errorMessage": "Sukses",
"data": 2344
}
}
12
SiDompul Low API Service Documentation | Confidential
2.3.6 Get List Product Code
URL https://gateway.egw.xl.co.id/sidompul/openapi/v1/get-product-list
METHOD GET
Content-Type application/json
Authorization Bearer
apiid API-ID
apikey API-KEY
language ID
Response 200
{
"statusCode": 200,
"statusMessage": "OK",
"statusDescription": "Request succeeded without error",
"result": {
"errorCode": "00",
"errorMessage": "Sukses",
"data": [
{
"productCode": "XC_FLEX_S",
"productName": "Xtra Combo Flex S",
"price": 13703
},
{
"productCode": "XC_FLEX_SPLUS",
"productName": "Xtra Combo Flex S+",
"price": 24800
}
]
}
}
13
SiDompul Low API Service Documentation | Confidential
2.3.7 Purchase Package Deduct Pulsa
URL https://gateway.egw.xl.co.id/sidompul/openapi/v1/post-package-pulsa
METHOD POST
Content-Type application/json
Authorization Bearer
apiid API-ID
apikey API-KEY
language ID
Request Body
{
"msisdn": "6287787237069",
"pin": "vcHSKNpbzbU0wQQep31OAg==",
"productCode": "XTRA_EDUKASI"
}
Response 200
{
"statusCode": 200,
"statusMessage": "OK",
"statusDescription": "Request succeeded without error",
"result": {
"errorCode": "00",
"errorMessage": "Sukses",
"data": {
"description": "Transaksi sedang di proses"
}
}
}
14
SiDompul Low API Service Documentation | Confidential
2.3.8 AWG Get Stock
URL https://gateway.egw.xl.co.id/sidompul/openapi/v1/get-awg-
stock?roType={{type}}
METHOD GET
Content-Type application/json
Authorization Bearer
apiid API-ID
apikey API-KEY
language ID
15
SiDompul Low API Service Documentation | Confidential
Response 200
{
"statusCode": 200,
"statusMessage": "OK",
"statusDescription": "Request succeeded without error",
"result": {
"errorCode": "00",
"errorMessage": "Sukses",
"data": [
{
"vId":
"WpgGlV%2B2B7EqYJG2tsRVad8YFP2lLBEYr6q5SEqvE0TZcec0c4YkXkSnj0YX4TdrGK%
2BjWN7VPFB1Jya94eI9zdgqKK03uNRlp688D%2FuJg8qBnxNsDWPgNs403KEOCYuks%2BW
CzmnqrFSp8PMPhH9Fiw%3D%3D",
"voucherTypeCode": "AX-RM580808TK-TSP",
"description": "Bronet 24Jam 1GB Nat/ 1.5GB BB2.5/ 2GB
BOY/ 3GB BBOY 7hr",
"effectiveDate": "07-01-2022",
"expirationDate": "27-09-2022",
"voucherBalance": 1,
"voucherPrice": 6000,
"allowType": "TRS",
"vouExpDate": "20-01-2023"
}
]
}
}
16
SiDompul Low API Service Documentation | Confidential
2.3.9 AWG Get Info Transaction
URL https://gateway.egw.xl.co.id/sidompul/openapi/v1/get-awg-transaction-
info?beginDate={{beginDate}}&endDate={{endDate}}&servicetype={{servicetype
}}
METHOD GET
Content-Type application/json
Authorization Bearer
apiid API-ID
apikey API-KEY
language ID
17
SiDompul Low API Service Documentation | Confidential
BUYSTOCK: Buy Stock from
Mini Grosir
Response 200
{
"statusCode":200,
"statusMessage":"OK",
"statusDescription":"Request succeeded without error",
"result":{
"errorCode":"00",
"errorMessage":"Sukses",
"data":[
{
"masterTrxId":"TEMBAKTXL170178221115185833304",
"status":"SUKSES",
"description":"AIGO Paket Edu Confrence 5GB 5hr",
"voucherPrice":1000,
"priceNormal":2900,
"createdDtm":"2022-11-15",
"voucherTypeCode":"AX-RM548858EDU-V",
"sourceMsisdn":"6287884074078",
"destinationMsisdn":"6283891550392",
"type":"SELLVOUCHER-SATUAN"
},
{
"masterTrxId":"ISIU170178221111135743435",
"status":"GAGAL",
"destinationMsisdn":"1026220002320751",
"voucherPrice":2400,
"createdDtm":"2022-11-11",
"description":"AIGO SS 1.5GB BB2.5/1.5GB BOY/2GB BBOY,
5hr",
"priceNormal":6300,
"voucherTypeCode":"AX-RM593928SSE-V",
"sourceMsisdn":"6287884074078",
"type":"PHYSICALVOUCHER-BULK"
}
]
}
}
18
SiDompul Low API Service Documentation | Confidential
2.3.10 AWG Inject Stock
URL https://gateway.egw.xl.co.id/sidompul/openapi/v1/post-awg-tembak
METHOD POST
Content-Type application/json
Authorization Bearer
apiid API-ID
apikey API-KEY
language ID
Request Body
{
"target": [
"6287787237069"
],
"pin": "9+COegKn4IuRupDjfPF95Q==",
"vId":
"tpB4CBhS1Xr9x6dt5M0F2Bplt3xFlDOnV40Lq37irClNaAdaRolmbf5VK3mMFbo2f6c13
co%2F8OQ6vZGy8CQI0xQ%2BWLomyTTfPXLD1MuwUJl2VEGiOx4qKkZTmJzitDyU",
"command": "tembak-paket-ir",
"allowType": "TRS"
}
19
SiDompul Low API Service Documentation | Confidential
Response 200
{
"statusCode": 200,
"statusMessage": "OK",
"statusDescription": "Request succeeded without error",
"result": {
"errorCode": "00",
"errorMessage": "Success",
"data": "ISIU47726210129052939581"
}
}
20
SiDompul Low API Service Documentation | Confidential
2.3.11 XWG Get Stock
URL https://gateway.egw.xl.co.id/sidompul/openapi/v1/get-xwg-
stock?roType={{type}}
METHOD GET
Content-Type application/json
Authorization Bearer
apiid API-ID
apikey API-KEY
language ID
21
SiDompul Low API Service Documentation | Confidential
Response 200
{
"statusCode": 200,
"statusMessage": "OK",
"statusDescription": "Request succeeded without error",
"result": {
"errorCode": "00",
"errorMessage": "Sukses",
"data": [
{
"voucherTypeCode": "XL-WGXHSAE560658R",
"description": "Xtra Hotrod Special 1.5GB, 7hr",
"effectiveDate": "22-10-2021",
"expirationDate": "27-01-2022",
"voucherBalance": 1,
"voucherPrice": 1000,
"vId":
"bobW3PVW71WzTCWOcwhxtlK5YpZ1PNb8mhzHi5RdWF33W4ljNv3xjbrw0ZvlyKw2KY89k
4%2Fq5%2B9AmIIvOoMuamHTikGQzQdp8HAdF5ey4%2Bc%3D",
"allowType": "RZE",
"vouExpDate": "14-01-2023"
}
]
}
}
22
SiDompul Low API Service Documentation | Confidential
2.3.12 XWG Get Info Transaction
URL https://gateway.egw.xl.co.id/sidompul/openapi/v1/get-xwg-transaction-
info?beginDate={{beginDate}}&endDate={{endDate}}&servicetype={{servicetype
}}
METHOD GET
Content-Type application/json
Authorization Bearer
apiid API-ID
apikey API-KEY
language ID
23
SiDompul Low API Service Documentation | Confidential
PHYSICALVOUCHER-BULK:
Inject Voucher
TRANSFER-IN: Receive
Transfer Stock
BUYSTOCK: Buy Stock from
Mini Grosir
TRFBALANCE: Transfer
Balance to Parent
TEMBAKSTOK: Inject Stock
Parent
EXTENDSTOCK: Extend
expired stock WG
Response 200
{
"statusCode": 200,
"statusMessage": "OK",
"statusDescription": "Request succeeded without error",
"result": {
"errorCode": "00",
"errorMessage": "Sukses",
"data": [
{
"masterTrxId": "TEMBAK101162221110053340600",
"voucherPrice": 100,
"status": "SUKSES",
"createdDtm": "2022-11-10",
"description": "Xtra Combo 2GB+4GB Double Youtube,
30hr",
"priceNormal": 29000,
"voucherTypeCode": "XL-WGXCDYA398328R",
"sourceMsisdn": "6287884074078",
"destinationMsisdn": "6285959200333",
"type": "SELLVOUCHER-SATUAN"
},
{
"masterTrxId": "ISI101162221111140458319",
"status": "SUKSES",
"destinationMsisdn": "1011640000921102",
"voucherPrice": 19070,
"createdDtm": "2022-11-11",
"description": "Xtra Combo Special 8GB, 30hr",
"priceNormal": 19070,
"voucherTypeCode": "XL-WGXCSAC556048R",
"sourceMsisdn": "6287884074078",
"type": "PHYSICALVOUCHER-BULK"
}
]
}
}
24
SiDompul Low API Service Documentation | Confidential
2.3.13 XWG Inject Stock
URL https://gateway.egw.xl.co.id/sidompul/openapi/v1/post-xwg-tembak
METHOD POST
Content-Type application/json
Authorization Bearer
apiid API-ID
apikey API-KEY
language ID
Request Body
{
"target":[
"6287884074088"
],
"pin":"6vIrZSvEN9TRPJbCO1ht1A==",
"vId":"tpB4CBhS1Xr9x6dt5M0F2Bplt3xFlDOnV40Lq37irClNaAdaRolmbf5VK3mMFbo
2f6c13co%2F8OQ6vZGy8CQI0xQ%2BWLomyTTfPXLD1MuwUJl2VEGiOx4qKkZTmJzitDyU"
,
"command":"sell-voucher",
"allowType":"TRE"
}
25
SiDompul Low API Service Documentation | Confidential
Response 200
{
"statusCode": 200,
"statusMessage": "OK",
"statusDescription": "Request succeeded without error",
"result": {
"errorCode": "00",
"errorMessage": "Success",
"data": "ISIU47726210129052939581"
}
}
26
SiDompul Low API Service Documentation | Confidential
3. High Level Diagram
27
SiDompul Low API Service Documentation | Confidential
4. General Response Code
PT XL Axiata TBK
XL Axiata Tower, Kav 11 Kav X-2 5, Jl. H. R. Rasuna Said No.5, RT.7/RW.2
Kuningan, East Kuningan, Setiabudi, Jakarta Selatan - Jakarta 12950 Indonesia
28
SiDompul Low API Service Documentation | Confidential