Balance Inquiry¶

This operation is to search the balance of consumer.

Implemented by: EDC Payment Gateway · Called by: Partner bank

Operation¶

Description	Value
URL	`https://edc-sit-api.oone.bz/pg-bank-api/balance/inquiry/v3`
Method	`POST`

Headers¶

Key	Value	Remark
Accept	application/json
Content-Type	application/json
Authorization	Bearer	Will provide privately

Request Payload¶

Field	Type	Required	Remark
`biller_code`	`string`	Yes	Biller prefix code
`consumer_code`	`string`	Yes	Consumer code
`currency`	`string`	No	Currency code (ISO 4217) `KHR` `USD`

Example Request Payload¶

{
    "biller_code": "EDC",
    "consumer_code": "80581211",
    "currency": ""
}

Response Payload¶

Field	Type	Remark
`code`	`string`	Response code
`message`	`string`	Response message in English
`message_kh`	`string`	Response message in Khmer
`data`	`json`	Data object

Response Payload for "data"¶

Field	Type	Remark
`biller_code`	`string`	Biller prefix code
`biller_name`	`string`	Biller name
`company_code`	`string`	Company code
`company_name`	`string`	Company name
`consumer_code`	`string`	Consumer code
`consumer_name`	`string`	Consumer name
`consumer_name_latin`	`string`	Consumer name in Latin
`currency`	`string`	Currency code (ISO 4217)
`total_amount`	`decimal`	Total amount to pay
`bill_amount`	`decimal`	Bill amount
`convenience_fee_amount`	`decimal`	Transaction fee will pay by consumer
`sponsor_fee_amount`	`decimal`	Transaction fee will pay by biller
`min_amount`	`decimal`	Minimum amount which consumer can pay (-1 is unlimited)
`max_amount`	`decimal`	Maximum amount which consumer can pay (-1 is unlimited)
`payment_token`	`string`	Hashed token auto generated by Payment Gateway
`last_bill_date`	`string`	Last bill date
`last_due_date`	`string`	Last due date
`description_kh`	`string`	Description in Khmer to show in bank app
`description_en`	`string`	Description in English to show in bank app

Example Response Payload¶

{
    "code": "000",
    "message": "",
    "message_kh": "",
    "data": {
        "biller_code": "EDC",
        "biller_name": "Electricite Due Cambodge",
        "company_code": "EDC-BTB",
        "company_name": "អគ្គិសនីបាត់ដំបង",
        "consumer_code": "80581211",
        "consumer_name": "លោក ជា សំណាង",
        "consumer_name_latin": "Mr. Chea Samnang",
        "currency": "KHR",
        "total_amount": 100000.00,
        "bill_amount": 100000.00,
        "convenience_fee_amount": 0.00,
        "sponsor_fee_amount": 0.00,
        "min_amount": 100000.00,
        "max_amount": -1,
        "payment_token": "4be8fc1f50834aacb5c46005501cda8b...",
        "last_bill_date": "2021-12-01T09:25:30",
        "last_due_date": "2021-12-15T23:59:59",
        "description_kh": "វិក្កយបត្រលោកអ្នកហួសសុពលភាព អាចប្រឈមនឹងការផ្អាកផ្គត់ផ្គង់អគ្គិសនី។",
        "description_en": "Your electricity supply can be suspended if your bill is overdue."
    }
}