v1

latestOpenAPI 3.0.12026-07-24128351404.9 KB

Business Account

Get Business Accounts

Returns a list of business accounts under the current user, including their linked bank accounts.

get/open-api/v3/business/accounts

Query parameters

idstring uuid

The UUID of the Business Account entity.

accountIdstring uuid required

The UUID of the Account.

currency'CNH' | 'USD' | 'HKD' | 'GBP' | 'EUR' | 'AUD' | 'AED' | 'ILS' | 'CAD' | 'SGD' | 'MYR' | 'JPY' | 'IDR'

Currency code.

limitstring number

Limits the number of items to be returned.

pagestring number

The page to be returned, counting from 1 as the first page.

Response

codestring

Error code

messagestring

Error message

Example response

{
  "code": "400001",
  "message": "Invalid parameter",
  "data": {
    "list": [
      {
        "id": "cae9efe2-b577-4632-8c57-8822ddb8542a",
        "accountId": "cae9efe2-b577-4632-8c57-8822ddb8542a",
        "createTime": "1755498145103",
        "nickname": "My Business Account",
        "purpose": "General Business Operations",
        "currency": "USD",
        "balanceId": "b1a2c3d4-e5f6-7890-abcd-ef1234567890",
        "bankAccounts": [
          {
            "accountId": "cae9efe2-b577-4632-8c57-8822ddb8542a",
            "createTime": "1755498145103",
            "accountName": "John Doe",
            "accountNo": "123456789",
            "currency": "USD",
            "bankName": "Bank of Examples",
            "bankAddress": {
              "addressLine1": "123 Main St",
              "addressLine2": "Apt 4B",
              "city": "New York",
              "country": "US",
              "postalCode": "10001"
            },
            "swift": "BOFAUS3N",
            "routingNumber": "026009593",
            "routingType": "ABA",
            "branchName": "Downtown Branch",
            "branchCode": "123456",
            "status": "ACTIVE"
          }
        ]
      }
    ]
  }
}