Skip to main content

Create Counterparty External Wallet

POST 
/v1/crossborder/counterparties/:id/wallets

Create a new external wallet for a crossborder counterparty. The wallet will be associated with the specified counterparty and will be created with PENDING status. Requires wallet address, network, currency symbol, and provider information.

Request​

Path Parameters

    id stringrequired

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

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    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 stringrequired

    Wallet name.

    address stringrequired

    Wallet address.

    network stringrequired

    Network.

    currency_symbol objectrequired

    Currency symbol.

    provider stringrequired

    Provider.

Responses​

Counterparty wallet created 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...