Skip to main content

Get All Client Accounts

GET 
/v1/crossborder/clients/:client_id/accounts

Retrieve a list of all bank accounts associated with a specific crossborder client. Optional filter parameters can be used to refine your search.

Request​

Path Parameters

    client_id uuidrequired

    Client ID.

Query Parameters

    page number

    Default value: 1

    Page number.

    size number

    Possible values: <= 100

    Default value: 20

    Page size. Max size is 100.

    sort string

    Possible values: [created_at, account_number]

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

    currency_symbol string

    Possible values: [USD, BRL, EUR, MXN, ARS, COP, CLP, PEN, ECU, UYU, PYG, USDC, USDT]

    Filter by currency symbol.

Header Parameters

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid string

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

Responses​

Client accounts returned successfully.

Schema
    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    Client accounts data.

  • Array [
    • id stringrequired

    Account ID.

    user_id stringrequired

    User ID.

    client_id stringrequired

    Client ID.

    country objectrequired

    Country code.

    currency_symbol objectrequired

    Currency symbol.

    account_type objectrequired

    Account type.

    account_number stringrequired

    Account number.

    branch string

    Branch number.

    bank_name stringrequired

    Bank name.

    bank_code stringrequired

    Bank code.

    bank_code_type objectrequired

    Bank code type.

    status stringrequired

    Possible values: [ACTIVE, INACTIVE, PENDING]

    Account status.

    created_at date-timerequired

    Account created date.

    updated_at date-timerequired

    Account updated date.

  • ]
Loading...