Skip to main content

Create Counterparty Account

POST 
/v1/crossborder/counterparties/:id/accounts

Create a new bank account for a crossborder counterparty. The account will be associated with the specified counterparty ID.

Request​

Path Parameters

    id stringrequired

    Unique identifier (UUID) of the counterparty that will own this bank account.

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
    country objectrequired

    Country code.

    currency_symbol objectrequired

    Currency symbol.

    account_type objectrequired

    Account type.

    account_number stringrequired

    Bank account number.

    branch string

    Branch number. Maximum 20 characters.

    bank_name stringrequired

    Bank name. Maximum 200 characters.

    bank_code stringrequired

    Bank code. Maximum 20 characters.

    bank_code_type objectrequired

    Bank code type.

Responses​

Counterparty account created successfully.

Schema
    id stringrequired

    Unique identifier (UUID) of the created 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...