Terus Laris API (1.0.0)

Download OpenAPI specification:Download

Terus Laris API Specifications

Product Type Description

Indico Product Category Description

Category	Inquiry	Order	Get Order Status	Callback
Game TopUp
Game Voucher
PLN Voucher
Data Rewards

Category Billing	Inquiry	Order	Get Order Status	Callback	Get Area
PLN
BPJS
Indihome
PLN
PDAM
PBB

Inquiry

The "Inquiry Order API" simplifies the process of obtaining order IDs for game top-up denominations, providing a convenient and efficient way to manage transactions in gaming systems

Create Inquiry

header Parameters

api-key	string Example: wqSA8jxynOvHk-7RHbhYefVjtdvmn7Dyc5XDp2BlcSafnd0TOzqD7-xJ-gEfP-uIu3k=
application-id	string Example: 5d2c8513-9423-4df7-bedf-df71fe84ad11

Request Body schema: application/json

indico_product_id	string
callback_url	string
	Array of objects (CreateInquiryOrderRequestDetails)

Responses

Request samples

Payload

Content type

application/json

{"indico_product_id": "mobilelegend10",
"callback_url": "https://1pvi9radmj.execute-api.ap-southeast-3.amazonaws.com/dev/test-api",
"data": [{"order_count": 1,
"details": {"user_id": "1029384",
"zone_id": "111"
}
}
]
}

Response samples

202
400
403
404
504

Content type

application/json

Example

success

{"status_code": "INDOK1",
"status_desc": "Inquiry Successfully Created",
"status": "Success",
"order_id": "10727b64-0fb1-4791-b54c-2ef24228ea11",
"order_details": [{"order_count": 1,
"details": [{"description": "MOBILE LEGEND 10 DIAMOND",
"status": "Success",
"status_desc": "Content has been fulfilled",
"user_id": "10299384",
"zone_id": "111"
}
]
}
]
}

Order

The Order Transaction API facilitates the initiation of transactions for various products available in our system. It offers a straightforward method to place orders and obtain order IDs, which are essential for tracking and managing transactions. While the order ID is mandatory for game top-up transactions, it is optional for other products.

Create Order

header Parameters

api-key	string Example: wqSA8jxynOvHk-7RHbhYefVjtdvmn7Dyc5XDp2BlcSafnd0TOzqD7-xJ-gEfP-uIu3k=
application-id	string Example: 5d2c8513-9423-4df7-bedf-df71fe84ad11

Request Body schema: application/json

client_transaction_id	string
indico_product_id	string
callback_url	string
order_id	string
	Array of objects (CreateOrderDetails)

Responses

Request samples

Payload

Content type

application/json

{"client_transaction_id": 202302191200590000000,
"indico_product_id": "VE0011PPLN01",
"callback_url": "https://1pvi9radmj.execute-api.ap-southeast-3.amazonaws.com/dev/test-api",
"data": [{"order_count": 1,
"details": {"user_id": "123456789"
}
}
]
}

Response samples

202
400
403
404
504

Content type

application/json

{"status_code": "IND000",
"status_desc": "Order Successfully Created",
"status": "Success",
"order_id": "8dfe61cf-9280-415e-aa25-c5c156ae64ce"
}

Get Order

path Parameters

orderId

required

integer <int64>

ID of order

header Parameters

api-key	string Example: rNrc3pI8dfC7u1Qw40zqhMi2vY5oFsK2Cyq0DCYORtRlK_GH71T3BWTW_c82Tsqd6-8=
Content-Type	string Example: application/json
application-id	string Example: 36d5cd5a-1ca7-42ff-898d-d5f50fd530b4

Responses

Response samples

200
403
404

Content type

application/json

Example

direct top up

{"status_code": "INDS000",
"status_desc": "Content has been fulfilled",
"status": "Success",
"order_id": "ff4c8492-350b-4996-9c39-1a1c4310909b",
"indico_product_id": "DG0011MLBB01",
"order_details": [{"order_count": 1,
"details": [{"description": "Mobile Legends 5 Diamonds",
"status": "Success",
"status_desc": "Content has been fulfilled",
"user_id": "123456789",
"zone_id": "1111"
}
]
}
]
}

Callback

Client needs to provide this API callback. This endpoint will be used as "callback_url" in Inquiry and Order request to Indico

Callback

Request Body schema: application/json

status_code	string
status_desc	string
order_status	string
order_id	string
indico_product_id	string
	Array of objects (OrderDetails)
timestamp	string

Responses

Request samples

Payload

Content type

application/json

{"status_code": "INDS000",
"status_desc": "Content has been fulfilled",
"status": "Success",
"order_id": "ff4c8492-350b-4996-9c39-1a1c4310909b",
"indico_product_id": "DG0011MLBB01",
"order_details": [{"order_count": 1,
"details": [{"description": "MOBILE LEGEND 10 DIAMOND",
"status": "Success",
"status_desc": "Content has been fulfilled",
"user_id": "10299384",
"zone_id": "111"
}
]
}
]
}

Response samples

200

Content type

application/json

{ }

Product

The Get Product API enables clients to retrieve information about the availability of products within our system for a specific client. This API offers a convenient method for clients to query and obtain details about the products that are accessible to them.

Get Products

header Parameters

api-key	string Example: rNrc3pI8dfC7u1Qw40zqhMi2vY5oFsK2Cyq0DCYORtRlK_GH71T3BWTW_c82Tsqd6-8=
Content-Type	string Example: application/json
application-id	string Example: 36d5cd5a-1ca7-42ff-898d-d5f50fd530b4

Responses

Response samples

200
403
404

Content type

application/json

{"products": [{"indico_product_id": "VE0011PPLN03",
"description": "PLN Prabayar 100.000",
"price": 0,
"group": "VOUCHER CODE",
"category": "Electricity",
"subcat": 1,
"code": "PLN",
"details": [{"description": "PLN Prabayar 100.000",
"type": "D",
"field": ["user_id"
]
}
]
},
{"indico_product_id": "DG0011MLBB01",
"description": "MOBILE LEGEND 10 DIAMOND",
"price": 0,
"group": "DTU",
"category": "GAME",
"subcat": 1,
"code": "MOBILE LEGEND",
"details": [{"description": "MOBILE LEGEND 10 DIAMOND",
"type": "D",
"field": ["user_id",
"zone_id"
]
}
]
}
]
}

Wallet

The Wallet Balance API allows users to retrieve the current balance of their deposit account within our system. This API provides a straightforward method for users to check their available funds, enabling them to manage their finances more effectively.

Get Balance

header Parameters

api-key	string Example: rNrc3pI8dfC7u1Qw40zqhMi2vY5oFsK2Cyq0DCYORtRlK_GH71T3BWTW_c82Tsqd6-8=
Content-Type	string Example: application/json
application-id	string Example: 36d5cd5a-1ca7-42ff-898d-d5f50fd530b4

Responses

Response samples

200
403
404

Content type

application/json

{"client": "wallet-test",
"wallet": 997811930,
"last_attempt": "2023-09-25T07:32:50.000Z"
}

Billing

The Billing API provides a convenient way to manage billing operations for users. It allows users to retrieve billing information, including payment methods, payment status, and billing callback.

get area

Responses

Response samples

200

Content type

application/json

{"data": [{"area_code": "AREA0574",
"area_name": "Kabupaten Berau Pajak Non PBB",
"city": "Kabupaten Berau Pajak Non PBB",
"availability": {"pdam": false,
"pbb": true
}
},
{"area_code": "AREA0500",
"area_name": "Kota Palembang ATS",
"city": "Kota Palembang ATS",
"availability": {"pdam": true,
"pbb": false
}
}
]
}

Inquiry

Request Body schema: application/json

client_transaction_id required	string
callback_url required	string
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"client_transaction_id": "string",
"callback_url": "string",
"params": [{"product_id": "string",
"param": {"account_id": "string"
}
}
]
}

Response samples

200

Content type

application/json

{"transaction_id": "2405021426380808303",
"transaction_time": "2024-09-28T11:15:08.758978614+07:00",
"status": "Inquiry Success",
"status_code": "200",
"message": "Inquiry succeeded.",
"results": [{"status": "Success",
"status_code": "IND000",
"message": "Billing Info: Success",
"invoice_id": "28092404PBB1031176",
"product_id": "TESTBLPBB10",
"account_id": "329801092375999901",
"total_amount": 206857,
"service_charge": 3000,
"account_detail": {"name": "TESTING PBB",
"area_code": "AREA0426",
"area_name": "Kota Cimahi",
"participants": 0
},
"invoice_details": [{"amount": 203857,
"penalty": 0,
"period": "092019",
"first_meter": 0,
"last_meter": 0,
"due_date": "28102024",
"tariff_code": "",
"capacity": 0
}
]
}
]
}

Payment

Request Body schema: application/json

client_transaction_id required	string
callback_url required	string
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"client_transaction_id": "string",
"callback_url": "string",
"params": [{"product_id": "string",
"invoice_id": "string",
"param": {"account_id": "string"
}
}
]
}

Response samples

200
403

Content type

application/json

{"transaction_id": "2405021426380808567",
"transaction_time": "2024-11-26T10:04:43.327115518+07:00",
"status": "Payment InProgress",
"status_code": "100",
"message": "Payment is in progress.",
"results": [{"status": "Payment InProgress",
"status_code": "100",
"message": "Payment is in progress.",
"invoice_id": "26112410PSTN032409",
"product_id": "TELKOMPSTN002",
"account_id": "",
"total_amount": 0,
"service_charge": 0,
"account_detail": {"name": "",
"area_code": "",
"area_name": "",
"participants": 0
},
"invoice_details": null
}
]
}

Callback

Request Body schema: application/json

transaction_id required	string
transaction_time required	string
status required	string
status_code required	string
message required	string
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"transaction_id": "string",
"transaction_time": "string",
"status": "string",
"status_code": "string",
"message": "string",
"results": [{"status": "string",
"status_code": "string",
"message": "string",
"invoice_id": "string",
"product_id": "string",
"account_id": "string",
"total_amount": 0,
"service_charge": 0,
"account_detail": {"name": "string",
"area_code": "string",
"area_name": "string",
"participants": 0
},
"invoice_details": [{"amount": 0,
"penalty": 0,
"period": "string",
"first_meter": 0,
"last_meter": 0,
"due_date": "string",
"tariff_code": "string",
"capacity": 0
}
]
}
]
}

Response samples

200

Content type

application/json

{"transaction_id": "2405021426380808303",
"transaction_time": "2024-09-28T11:15:08.758978614+07:00",
"status": "Inquiry Success",
"status_code": "200",
"message": "Inquiry succeeded.",
"results": [{"status": "Success",
"status_code": "IND000",
"message": "Billing Info: Success",
"invoice_id": "28092404PBB1031176",
"product_id": "TESTBLPBB10",
"account_id": "329801092375999901",
"total_amount": 206857,
"service_charge": 3000,
"account_detail": {"name": "TESTING PBB",
"area_code": "AREA0426",
"area_name": "Kota Cimahi",
"participants": 0
},
"invoice_details": [{"amount": 203857,
"penalty": 0,
"period": "092019",
"first_meter": 0,
"last_meter": 0,
"due_date": "28102024",
"tariff_code": "",
"capacity": 0
}
]
}
]
}

Error Code Description

Error Code TerusLaris API

Status	Status Code	Status Description
Success	IND000	Order Successfully Created
Success	INDOK0	Success
Partial Success	INDI102	Bundling Content is partially received
Pending	INDP101	Temporary waiting responds from Supplier or Client
Failed	INDF101	Fulfillment failed
Failed	INDF102	System Error
Failed	INDF103	Payment error : Supplier fail to deduct balance
Cancelled	IND001	Invalid Request Body
Cancelled	IND002	Product not found
Cancelled	IND003	Internal Server Error
Cancelled	IND004	User is not authorized to access this resource with an explicit deny
Cancelled	IND005	User Parameter is invalid
Cancelled	IND006	Payment error : Indico unable to deduct client balance
Cancelled	IND007	Out of stock for Inventory Digital Code
Cancelled	IND008	Invalid Product Type
Cancelled	IND009	Phone Number cant be empty
Cancelled	IND011	Voucher not found
Cancelled	IND012	Order not found
Cancelled	IND013	Voucher is expired
Cancelled	IND014	Invalid Phone Number
Cancelled	IND015	Email cannot be empty
Cancelled	IND016	Invalid email format
Cancelled	IND017	Voucher cannot be empty
Cancelled	INDS000	Content has been fulfilled
Cancelled	IND010	Voucher has been redeemed
Cancelled	IND018	Fulfilment not found
Cancelled	IND019	Supplier Error Code not found
Cancelled	IND020	Fulfillment failed