Get Accounts for an Organization End User

GET /v1/end-users/organizations//accounts — Returns all virtual accounts for an organization end user. Requires end-users:read scope.

Returns a paginated list of virtual accounts belonging to a specific organization end user. Accounts are only present once the organization has been successfully onboarded with at least one bank partner. Use the optional query parameters to search by account name, account number, or a general free-text term. The returned accounts can be used as the source or destination in payment operations.

​

Endpoint

GET /v1/end-users/organizations/{id}/accounts

Required scope: com.diameterpay.api/end-users.read

​

Request Headers

Authorization · string · required

Bearer token obtained from your OAuth 2.0 token endpoint. Format: Bearer {access_token}

​

Path Parameters

id · string · required

UUID v4 of the organization end user whose accounts you want to list.

​

Query Parameters

page · integer

Page number to return. Defaults to 1.

limit · integer

Number of records per page. Defaults to 10. Maximum is 100.

accountName · string

Exact-match filter on the account’s display name.

accountNumber · string

Exact-match filter on the account number.

freeSearch · string

General free-text search across multiple account fields such as account name, account number, and currency.

​

Response

Returns 200 OK with a paginated response envelope containing an array of virtual account objects.

data · array

Array of virtual account objects belonging to this organization.

Show account object fields

id · string

UUID v4 of the virtual account.

accountName · string

Display name of the account.

accountNumber · string

Account number assigned by the bank partner.

currency · string

ISO 4217 currency code (e.g. USD, EUR).

balance · string

Current available balance as a decimal string (e.g. "250000.00").

bankPartner · string

The bank partner that issued this account (e.g. PORTAGE, SLOVAK_SAVINGS_BANK).

status · string

Current account status (e.g. ACTIVE, INACTIVE, SUSPENDED).

endUserId · string

UUID v4 of the organization end user this account belongs to.

productId · string

UUID of the product associated with this account.

createdAt · string

ISO 8601 timestamp of when the account was created.

updatedAt · string

ISO 8601 timestamp of the most recent update.

pagination · object

Pagination metadata.

Show pagination fields

page · integer

The current page number.

limit · integer

Number of records returned per page.

totalItems · integer

Total number of accounts matching the filter criteria.

totalPages · integer

Total number of pages available given the current limit.

hasNextPage · boolean

true if there is at least one more page of results.

hasPreviousPage · boolean

true if this is not the first page.

​

Example Request

curl --request GET \
  --url 'https://api.sandbox.diameterpay.com/v1/end-users/organizations/3fa85f64-5717-4562-b3fc-2c963f66afa6/accounts?page=1&limit=10' \
  --header 'Authorization: Bearer {access_token}'

​

Filtering by Account Number

curl --request GET \
  --url 'https://api.sandbox.diameterpay.com/v1/end-users/organizations/3fa85f64-5717-4562-b3fc-2c963f66afa6/accounts?accountNumber=9876543210' \
  --header 'Authorization: Bearer {access_token}'

​

Example Response

{
  "data": [
    {
      "id": "1c2d3e4f-5a6b-7c8d-9e0f-a1b2c3d4e5f6",
      "accountName": "Acme Operating Account",
      "accountNumber": "9876543210",
      "currency": "USD",
      "balance": "250000.00",
      "bankPartner": "PORTAGE",
      "status": "ACTIVE",
      "endUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "productId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "createdAt": "2024-06-01T14:40:00.000Z",
      "updatedAt": "2024-06-01T14:40:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "totalItems": 1,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPreviousPage": false
  }
}