Skip to main content

Get All Counterparty Accounts

GET 
/v1/crossborder/counterparties/:id/accounts

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

Request​

Path Parameters

    id stringrequired

    Unique identifier (UUID) of the counterparty to list accounts for.

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, MXN, ARS, COP, CLP, PEN, ECU, UYU, PYG]

    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

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses​

Counterparty 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

    Counterparty accounts data.

  • Array [
    • id stringrequired

    Unique identifier (UUID) of the account.

    user_id stringrequired

    Unique identifier (UUID) of the user.

    counterparty_id stringrequired

    Unique identifier (UUID) of the counterparty.

    country objectrequired

    Country code.

    currency_symbol objectrequired

    Currency symbol.

    account_type objectrequired

    Account type.

    account_number stringrequired

    Bank account number.

    branch string

    Branch number.

    bank_name stringrequired

    Bank name.

    bank_code stringrequired

    Bank code.

    bank_code_type objectrequired

    Bank code type.

    status string

    Possible values: [ACTIVE, INACTIVE, PENDING]

    Account status.

    created_at date-timerequired

    Account created date.

    updated_at date-timerequired

    Account updated date.

  • ]
Loading...