Skip to main content

Get Counterparty Account by ID

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

Retrieve detailed information about a specific counterparty account by providing the counterparty ID and account ID.

Request​

Path Parameters

    id stringrequired

    Unique identifier (UUID) of the counterparty that owns the account.

    account_id stringrequired

    Unique identifier (UUID) of the account to retrieve.

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​

Counterparty account returned successfully.

Schema
    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...