Skip to main content

Update Counterparty External Wallet

PATCH 
/v1/crossborder/counterparties/:id/wallets/:client_wallet_id

Update an existing external wallet for a crossborder counterparty. Only the provided fields (name, network, currency symbol, or provider) will be updated. The wallet address and status cannot be updated through this endpoint. Requires both counterparty ID and client wallet ID.

Request​

Path Parameters

    id stringrequired

    Counterparty ID.

    client_wallet_id stringrequired

    Client Wallet ID.

Header Parameters

    x-include-replay-protection-schema string

    The replay-protection-schema allows the user to choose between 3 options:

    • If there's no value: The default protection checks that the values in this request are equal: { method, params, path, query, body, userId }. This means that if a request repeats the same values, it will be blocked.
    • 'nonce': The nonce and { method, params, path, query, body, userId } value are checked. When the protection schema is this, requests will be OK if this nonce value is different in each request.
    • 'x-transaction-uuid': The transactionId and { method, params, path, query, body, userId } value are checked. Requests will be OK if this x-transaction-uuid value is different in each request.
    • 'x-transaction-uuid&nonce' or 'nonce&x-transaction-uuid': The nonce, transactionId value and { method, params, path, query, body, userId } are checked, i.e. if requests are repeated the same value in both fields, they will be blocked. But if any field has a different value, the request is OK.

    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.

Body

required
    name string

    Wallet name.

    network string

    Network.

    currency_symbol object

    Currency symbol.

    provider string

    Provider.

Responses​

Counterparty wallet updated successfully.

Schema
    id stringrequired

    Wallet ID.

    user_id stringrequired

    User ID.

    counterparty_id stringrequired

    Counterparty ID.

    name stringrequired

    Wallet name.

    address stringrequired

    Wallet address.

    network stringrequired

    Network.

    currency_symbol objectrequired

    Currency symbol.

    provider stringrequired

    Provider.

    status stringrequired

    Possible values: [ACTIVE, INACTIVE, PENDING, BLOCKED]

    Wallet status.

    created_at date-timerequired

    Wallet created date.

    updated_at date-timerequired

    Wallet updated date.

Loading...