- Accounts
- Get Statement: Histories
Accounts
Get Statement: Histories
This feature is designed to retrieve detailed information about a list of virtual accounts associated with the main account.
Information
| Method | Path | Format | Authentication |
|---|---|---|---|
| GET | /api/v1.0/va-transactions/{account_id} | 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{…} |
Parameter Structure
| Field | Value | Type | Mandatory | Length | Description | Example |
|---|---|---|---|---|---|---|
| start_date | - | Date | Mandatory | - | Start date with format YYYY-MM-DD | 2024-04-01 |
| end_date | - | Date | Mandatory | - | End date with format YYYY-MM-DD | 2024-04-30 |
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 | |||
| > transaction_id | Numeric | Mandatory | Transaction id | 3645345 | |
| > account | Object | ||||
| >> name | Alphabetic | ||||
| >> id | Numeric | ||||
| > bank_code | Alphabetic | Mandatory | Code of bank like: BRI, BNI, DANAMON, etc | BRI | |
| > va_number | Numeric | Mandatory | Virtual account bank number | 5588804221231232 | |
| > status | Alphabetic | Mandatory | Transaction status. Value filled by paid, pending, unpaid | paid | |
| > amount | Object | Mandatory | Amount of transaction | 99000 | |
| >> value | Decimal | ||||
| >> currency | Alphabetic | ||||
| > fees | Array | ||||
| >> name | Alphabetic | ||||
| >> amount | Decimal | ||||
| >> currency | Alphabetic | ||||
| > total_amount | Decimal | ||||
| >> value | Decimal | ||||
| >> currency | Alphabetic | ||||
| > post_timestamp | Timestamp | Mandatory | Date requested with Unix Timestamp millisecond format | 1714122259 | |
| > processed_timestamp | Timestamp | Date finished with Unix Timestamp millisecond format | |||
| > balance_after | Numeric | Mandatory | |||
| >> value | Numeric | Mandatory | Balance account after transaction | 99000 | |
| >> currency | Alphabetic | Mandatory | 3 | Currency | IDR |
| > additional_info | Object | ||||
| >> start_date | Date | Search start date with format YYYY-MM-DD | |||
| >> end_date | Date | Search start date with format YYYY-MM-DD | |||
| > pagination | Object | ||||
| >> count | |||||
| >> total | |||||
| >> perPage | |||||
| >> currentPage | |||||
| >> totalPages | |||||
| >> links |
Response Example
Success: Here’s an example of a successful response.
{
"status": 200,
"success": true,
"data": [
{
"transaction_id": "645345445",
"account": {
"name": "Julian Pratama",
"id": "465454"
},
"bank_code": "BRI",
"va_number": "5588804221231232",
"status": "paid",
"notes": "lorem ipsum",
"amount": {
"value": "11000.00",
"currency": "IDR"
},
"fees": [
{
"name": "Service Fee",
"amount": "2000.00",
"currency": "IDR"
}
],
"total_amount": {
"value": "13000.00",
"currency": "IDR"
},
"post_timestamp": "1714618220440",
"processed_timestamp": "1714618220440",
"balance_after": {
"value": "11000.00",
"currency": "IDR"
}
}
],
"additional_info": {
"start_date": "2024-04-01",
"end_date": "2024-04-30"
},
"pagination": {
"count": 1,
"total": 1,
"perPage": 10,
"currentPage": 1,
"totalPages": 1,
"links": {}
}
}Error: This is an example of an unsuccessful request.
{
"status": 401,
"success": false,
"error": {
"code": 401,
"message": "Unauthorized partner, please sign in"
}
}