Create Client Account

POST /v1/crossborder/clients/:client_id/accounts

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

Request

Path Parameters

client_id uuidrequired

Client 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-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-lang string

Possible values: [pt-BR, en-US]

Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

x-wallet-uuid string

Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

application/json

Body

required

country stringrequired

Possible values: [AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW]

Country code.

currency_symbol stringrequired

Possible values: [USD, BRL, EUR, MXN, ARS, COP, CLP, PEN, ECU, UYU, PYG, USDC, USDT]

Currency symbol.

account_type stringrequired

Possible values: [CHECKING, SAVINGS]

Account type.

account_number stringrequired

Account number.

account_name string

Friendly account name.

nickname string

Friendly nickname for the account.

branch string

Branch number.

bank_name stringrequired

Bank name.

bank_code stringrequired

Bank code.

bank_code_type stringrequired

Possible values: [ABA, BIC, FEBRABAN, IBAN, CLABE, CBU, BSB, IFSC, SORT_CODE, TRANSIT_NUMBER]

Bank code type.

clearing_code string

Bank clearing code.

Responses

Client account created successfully.

application/json

Schema
Example (from schema)

Schema

id stringrequired

Account ID.

user_id stringrequired

User ID.

client_id stringrequired