- Balance Inquiry
- Detail Merchant
Balance Inquiry
Detail Merchant
The 'Disbursements Transfer' section details the process of transferring funds to beneficiaries within the Singapay Payment Gateway. This includes initiating and managing disbursement transactions, verifying transfer statuses, and ensuring that payments are executed efficiently and accurately. Users can access information on how to process disbursements, monitor transaction progress, and resolve any issues related to fund transfers.
Information
| Method | Path | Format | Authentication |
|---|---|---|---|
| GET | /api/v1.0/balance-inquiry | json | OAuth 2.0 with Access Token |
Request Details
Headers Structure
| Field | Value | Type | Mandatory | Length | Description | Example |
|---|---|---|---|---|---|---|
| X-PARTNER-ID | api_key | Alphanumeric | Mandatory | API key obtained from the merchant dashboard. | b3ed7d4b-a96c-6c08-b3c7-12c3124242d9 | |
| Accept | application/json | Alphabetic | Mandatory | Specifies JSON as the expected response format. | application/json | |
| Authorization | Bearer {bearerToken} | Alphanumeric | Mandatory | Bearer token obtained from the get access token endpoint. | Bearer eyJ0eXAiOiJKV1{…} |
Response Details
Response Structure
| Field | Type | Mandatory | Length | Description | Example |
|---|---|---|---|---|---|
| status | Numeric | Mandatory | 3 | HTTP Status Code | 200 |
| success | Boolean | Mandatory | 1 | 2xx is true. 4xx-500 is false. | true |
| data | Array Object | Conditional | - | - | - |
| > pending_balance | Object | Mandatory | - | The amount of savings that cannot be used | - |
| >> value | Numeric | Mandatory | - | Amount of pending balance | 9000000 |
| >> currency | Alphabetic | Mandatory | - | Currency type | IDR |
| > available_balance | Object | Mandatory | - | Account balance that can be used for transactions | - |
| >> value | Numeric | Mandatory | - | Amount of available balance | 9000000 |
| >> currency | Alphabetic | Mandatory | - | Currency type | IDR |
| > balance | Object | Mandatory | - | Available_balance + pending_balance | - |
| >> value | Numeric | Mandatory | - | Total balance | 9000000 |
| >> currency | Alphabetic | Mandatory | - | Currency type | IDR |
Response Example
Success: Here’s an example of a successful response.
{
"status": 200,
"success": true,
"data": {
"pending_balance": {
"value": "110000.00",
"currency": "IDR"
},
"available_balance": {
"value": "100000.00",
"currency": "IDR"
},
"balance": {
"value": "1110000.00",
"currency": "IDR"
}
}
}Error: This is an example of an unsuccessful request.
{
"status": 401,
"success": false,
"error": {
"code": 401,
"message": "Unauthorized partner, please sign in"
}
}