v1

latestOpenAPI 3.1.02026-08-06173665.4 KB

Create a private account

Endpoint to create a private account for a client.

post/v1/clients/{clientId}/private_accounts

Path parameters

clientIdstring uuid required

Example:c2d1d1e3-3340-4170-980e-e9269bbbc551

Unique identifier of the client.

Request body

bank_idstring uuid required

owner_idstring uuid required

client_bank_adapter_idstring uuid required

client_idstring uuid required

account_idstring uuid required

Example request

{
  "bank_id": "9d84b03a-28d1-4898-a69c-38824239e2b1",
  "owner_id": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
  "client_bank_adapter_id": "5b3a1b67-ab59-4cc1-8fc6-1d558b32b237",
  "client_id": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
  "account_id": "24a726ac-180d-48df-82bc-711f2788a46f"
}

Response

Private account created successfully.

idstring uuid

bankIdstring uuid

clientIdstring uuid

clientBankAdapterIdstring uuid

accountIdstring uuid

instrumentIdstring uuid

ownerIdstring uuid

ownerTypestring

accountNumberstring

clabeNumberstring

availableBalancestring

accountTypestring

accountStatusstring

bankAdapterstring

Example response

{
  "id": "750ab428-b401-4b58-8a95-502bcb7b1bf8",
  "bankId": "9d84b03a-28d1-4898-a69c-38824239e2b1",
  "clientId": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
  "clientBankAdapterId": "5b3a1b67-ab59-4cc1-8fc6-1d558b32b237",
  "accountId": "24a726ac-180d-48df-82bc-711f2788a46f",
  "instrumentId": "ab502fce-1162-42f3-99d6-972989a06049",
  "ownerId": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
  "ownerType": "CLIENT",
  "accountNumber": "000001233635",
  "clabeNumber": "734180000001233635",
  "availableBalance": "0.00",
  "accountType": "PRIVATE_ACCOUNT",
  "accountStatus": "ACTIVE",
  "audit": {
    "createdAt": "2025-04-12 11:00:56.264527-06:00",
    "updatedAt": "2025-04-12 11:00:56.264527-06:00",
    "deletedAt": "None",
    "blockedAt": "None",
    "activatedAt": "None",
    "suspendedAt": "None"
  },
  "bankAdapter": "SIES"
}