- Accounts
- Get Detail Accounts
Accounts
Get Detail Accounts
This feature is designed to provide detailed information regarding the details of a virtual account. It allows users to retrieve and view comprehensive data on a specific virtual account.
Information
| Method | Path | Format | Authentication |
|---|---|---|---|
| GET | /api/v1.0/statements/{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{…} |
Response Details
This section outlines the structure and format of the data returned by the API when querying for details of a virtual account. The response is provided in JSON format and contains essential information such as the HTTP status code, success status, and the actual data pertaining to the virtual account.
Response Structure
| Field | Type | Mandatory | Length | Description | Example |
|---|---|---|---|---|---|
| status | Numeric | Mandatory | 3 | HTTP Status Code | 200 |
| success | Boolean | Mandatory | 1 | Indicates success status | true |
| data | Array Object | Conditional | Array of sub account objects | ||
| > id | Numeric | Mandatory | Sub account ID | 23643 | |
| > name | Alphanumeric | Mandatory | Full name of the account holder | John | |
| Alphanumeric | Mandatory | Email address of the account | john.doe@gmail.com | ||
| > phone | Numeric | Mandatory | Phone number associated | 628339243232 | |
| > status | Enum | Mandatory | Account status values | active |
Response Example
Success: Here’s an example of a successful response.
{
"status": 200,
"success": true,
"data": [
{
"id": "436546545",
"name": "Julian Albertus Pratama",
"email": "julian.pratama@example.com",
"phone": "62682293427611",
"status": "active", // active, inactive
}
],
"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"
}
}