Get List Accounts

Information

Method	Path	Format	Authentication
GET	`/api/v1.0/accounts`	json	OAuth 2.0 with Access Token

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	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{…}

Body Structure

Field	Value	Type	Mandatory	Length	Description	Example
page	{pageNumber}	Numeric	Optional			2

Body Example

{
  "page": 2
}

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	Numeric	Mandatory		Sub account ID	23643
> name	Alphanumeric	Mandatory		Full name of the account holder	John
> email	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, inactive, pending, rejected	active
pagination	Object	Conditional		Pagination information
> count	Numeric	Mandatory		Number of items in response	2
> total	Numeric	Mandatory		Total number of items available	100
> perPage	Numeric	Mandatory		Items per page	10
> currentPage	Numeric	Mandatory		Current page number	1
> totalPages	Numeric	Mandatory		Total number of pages	3
> links	Object	Mandatory		Links for navigation

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", 
    }
  ],
  "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"
    }
}