v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Accounts

List Connected Accounts

Returns a paginated list of sub-accounts linked to your master account. The list is empty if no sub-accounts have been created. See Connected Accounts for the master/sub-account model and the x-on-behalf-of pattern.

get/v1/accounts

Query parameters

page_sizeinteger required
Example:10

The maximum number of items to return per page. This number can be between 1 - 100

page_numberinteger required
Example:1

The page number to retrieve the next set of items. The number has to be greater than 1.

Response

OK - Successfully retrieved a list of accounts.

total_pagesinteger

The total pages of available items.

total_itemsinteger

The total counts of available items.

Example response

{
  "total_pages": 10,
  "total_items": 105,
  "data": [
    {
      "account_id": "f5bb6498-552e-40a5-b14b-616aa04ac1c1",
      "short_reference_id": "P220406-LLCVLRM",
      "business_code": [
        "BANKING"
      ],
      "email": "example@company.com",
      "account_name": "UQPAY PTE LTD.",
      "status": "PROCESSING",
      "verification_status": "UNDER_REVIEW",
      "country": "SG",
      "contact_details": {
        "email": "example@company.com",
        "phone": "+6588880000"
      },
      "business_details": {
        "legal_entity_name": "ソフトバンクインターナショナル株式会社",
        "legal_entity_name_english": "UQPAY PTE LTD.",
        "incorporation_date": "2013-04-15",
        "registration_number": "201901754K",
        "business_structure": "SOLE_PROPRIETOR",
        "product_description": "Design and produce high-tech wireless headphones.",
        "merchant_category_code": "5733",
        "estimated_worker_count": "BS001",
        "monthly_estimated_revenue": {
          "amount": "TM001",
          "currency": "SGD"
        },
        "account_purpose": [
          "PAYOUT"
        ],
        "identifier": {
          "number": "XXX-XX-XXXX"
        },
        "website_url": "https://yourcompany.com"
      }
    }
  ]
}