
Disbursement
This endpoint is used to retrieve a list of disbursements for an account.
| Method | Path | Format | Authentication |
|---|---|---|---|
| GET | /api/v1.0/disbursement/{account_id} | json | OAuth 2.0 with Access Token |
| 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{…} |
| Field | Type | Mandatory | Length | Description | Example |
|---|---|---|---|---|---|
| status | Numeric | Mandatory | 3 | HTTP Status Code | 200 |
| success | Boolean | Mandatory | - | true for success, false for failure. | true |
| data | Array Object | Conditional | - | - | - |
| > transaction_id | String | Mandatory | - | Transaction id | 1312220251024134833219 |
| > status | Alphabetic | Mandatory | - | Transaction status. Value will be success, failed, pending | success |
| > bank | Object | - | - | - | - |
| >> code | Alphabetic | Mandatory | - | Bank code like BRI, BNI, DANAMON | BRI |
| >> account_number | String | Mandatory | - | Beneficiary Bank account number | 7623781263816 |
| >> account_name | Alphabetic | Mandatory | - | Beneficiary Bank account name | Cengkal Marpaung |
| > gross_amount | Object | Mandatory | - | The total amount before any fees are deducted. | - |
| >> value | String | Mandatory | - | Transaction amount | 50000.00 |
| >> currency | Alphabetic | Mandatory | 3 | Currency code (ISO 4217) | IDR |
| > fee | Object | Mandatory | - | Fee details for the transaction. | - |
| >> name | Alphabetic | Mandatory | - | Transaction fee name | Transfer Fee |
| >> value | String | Mandatory | - | Transaction fee amount | 3000 |
| >> currency | Alphabetic | Mandatory | 3 | Currency code (ISO 4217) | IDR |
| > net_amount | Object | Mandatory | - | The amount received by the beneficiary after fees. | - |
| >> value | String | Mandatory | - | Net transaction amount | 47000.00 |
| >> currency | Alphabetic | Mandatory | 3 | Currency code (ISO 4217) | IDR |
| > post_timestamp | String | Mandatory | - | Date requested (Unix timestamp in milliseconds) | 1761288513000 |
| > processed_timestamp | String | Mandatory | - | Date finished (Unix timestamp in milliseconds) | 1761288513000 |
| > balance_after | Object | Mandatory | - | The remaining balance in the account after transaction. | - |
| >> value | String | Mandatory | - | Balance amount | 56000.00 |
| >> currency | Alphabetic | Mandatory | 3 | Currency code (ISO 4217) | IDR |
| > notes | String | Conditional | - | Additional notes for the transaction. Can be null. | from Travelan |
| pagination | Object | Conditional | - | - | - |
| > count | Numeric | Mandatory | - | Data quantity | 2 |
| > total | Numeric | Mandatory | - | Total of all data | 100 |
| > perPage | Numeric | Mandatory | - | Total data per page | 10 |
| > currentPage | Numeric | Mandatory | - | Current page | 1 |
| > totalPages | Numeric | Mandatory | - | Total page | 3 |
| > links | Object | Mandatory | - | Next or previous links | - |
Success: Here’s an example of a successful response.
{
"status": 200,
"success": true,
"data": [
{
"transaction_id": "1312220251024134833219",
"status": "success",
"bank": {
"code": "Maybank",
"account_name": "Cengkal Marpaung",
"account_number": "7623781263816"
},
"gross_amount": {
"currency": "IDR",
"value": "50000.00"
},
"fee": {
"name": "Transfer Fee",
"value": "3000",
"currency": "IDR"
},
"net_amount": {
"currency": "IDR",
"value": "47000.00"
},
"post_timestamp": "1761288513000",
"processed_timestamp": "1761288513000",
"balance_after": {
"value": "56000.00",
"currency": "IDR"
},
"notes": "from Travelan"
},
{
"transaction_id": "1312220251009154707246",
"status": "success",
"bank": {
"code": "BRI",
"account_name": "Fa Simbolon Anggraini (Persero) Tbk",
"account_number": "12393021903131"
},
"gross_amount": {
"currency": "IDR",
"value": "100000.00"
},
"fee": {
"name": "Transfer Fee",
"value": "3000",
"currency": "IDR"
},
"net_amount": {
"currency": "IDR",
"value": "97000.00"
},
"post_timestamp": "1759999627000",
"processed_timestamp": "1759999627000",
"balance_after": {
"value": "103000.00",
"currency": "IDR"
},
"notes": null
}
],
"pagination": {
"count": 2,
"total": 2,
"perPage": 25,
"currentPage": 1,
"totalPages": 1,
"links": {}
}
}