HIhifi
External Account

List all external accounts

Changed on

List all external accounts associated with a user. Supports cursor-based pagination.

get/v2/users/{userId}/external-accounts

Request

  • Base URL
    https://production.hifibridge.com
  • URL
    https://production.hifibridge.com/v2/users/{userId}/external-accounts
  • Auth
    HTTP bearer

Path parameters

userIdstring required

ID of the user

Query parameters

limitstring

default to 10, maximum to 100

createdBeforestring date

ISO format: YYYY-MM-DD

createdAfterstring date

ISO format: YYYY-MM-DD

Response

Success

countinteger

Number of accounts returned

nextCursorstring nullable

Cursor for the next page of results (null if no more results)

Example response

{
  "accounts": [
    {
      "id": "583eb259-e78b-4f0c-a4b5-a8957876fa6f",
      "userId": "77848151-d8cd-545a-8d45-62d31c30019d",
      "requestId": "550e8400-e29b-41d4-a716-446655440000",
      "direction": "payout",
      "status": "active",
      "country": "USA",
      "currency": "USD",
      "rail": "ach",
      "accountHolder": {
        "type": "individual",
        "name": "John Doe",
        "email": "john@example.com",
        "phone": "+14155551234",
        "address": {
          "addressLine1": "123 Main Street",
          "addressLine2": "Suite 100",
          "city": "New York",
          "stateProvinceRegion": "NY",
          "postalCode": "10001",
          "country": "USA"
        }
      },
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "count": 10,
  "nextCursor": "2024-01-15T10:30:00.000Z"
}

Changes