- Accounts
- List
Accounts
List
This feature is designed to provide detailed information regarding the list of virtual accounts. It allows users to retrieve and view comprehensive data on all virtual accounts associated with their main account.
Information
| Method | Path | Format | Authentication |
|---|---|---|---|
| GET | /api/v1.0/accounts | json | OAuth 2.0 with Access Token |
Request Details
This API endpoint is used to retrieve detailed information about a list of virtual accounts associated with the main account. It allows users to query for virtual account details based on specified criteria. The endpoint supports HTTP GET method and requires OAuth 2.0 authentication with an Access Token.
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 | Indicates success status | true |
| data | Array Object | Conditional | Array of sub account objects | ||
| > id | Alphanumeric | Mandatory | Sub account ID | 01K946KF851RK7FX075GJHBVKF | |
| > name | Alphanumeric | Mandatory | Full name of the account holder | John | |
| Alphanumeric | Mandatory | Email address of the account | john.doe@gmail.com | ||
| > phone | Alphanumeric | Mandatory | Phone number associated | 081234567890 | |
| > status | Enum | Mandatory | Account status values: active, inactive, pending, rejected | active | |
| pagination | Object | Conditional | Pagination information | ||
| > count | Numeric | Mandatory | Number of items in response | 5 | |
| > total | Numeric | Mandatory | Total number of items available | 5 | |
| > perPage | Numeric | Mandatory | Items per page | 25 | |
| > currentPage | Numeric | Mandatory | Current page number | 1 | |
| > totalPages | Numeric | Mandatory | Total number of pages | 1 | |
| > links | Object | Mandatory | Links for navigation |
Response Example
Success: Here’s an example of a successful response.
{
"status": 200,
"success": true,
"data": [
{
"id": "01K946KF851RK7FX075GJHBVKF",
"name": "rwa",
"email": "admin@gmail.com",
"phone": "081234567890",
"status": "active"
},
{
"id": "01K7ZTFRF7TC0XB1PFHC9CM80N",
"name": "pentest 1",
"email": "pentest1@gmail.com",
"phone": "082125202019",
"status": "active"
},
{
"id": "01K7E5DGZCT5E225QGF4P2EE0P",
"name": "Testing",
"email": "julianpratam02@gmail.com",
"phone": "082125202019",
"status": "active"
},
{
"id": "01K73TA9R0FWBG6B60Q916QMHD",
"name": "Julian Pratama",
"email": "julian.pratama@singapay.id",
"phone": "082125202019",
"status": "active"
},
{
"id": "01K5ZT4NH8AZFFB3A52W4DN8MY",
"name": "Adnan",
"email": "adnan@singapay.id",
"phone": "082199722404",
"status": "active"
}
],
"pagination": {
"count": 5,
"total": 5,
"perPage": 25,
"currentPage": 1,
"totalPages": 1,
"links": {}
}
}