Accounts

Create a private account

Changed on

Creates a private CLABE for the client. Private accounts receive money by default. Set sender_receiver_type = true at creation time only when the private account must also send Money Out; this setting cannot be changed later.

post/v1/clients/{clientId}/private_accounts

Request

Path parameters

clientIdstring uuid required
Example:c2d1d1e3-3340-4170-980e-e9269bbbc551

Unique identifier of the client.

Request body

bank_idstring uuid required

Bank UUID where the private account will be created.

owner_idstring uuid required

UUID of the client that will own the private account.

client_bank_adapter_idstring uuid required

Bank adapter configuration UUID used to create the account.

client_idstring uuid required

Client UUID associated with the private account.

account_idstring uuid required

Parent or backing account UUID used for the private account.

sender_receiver_typeboolean

When true, the private account can send Money Out as well as receive money. This value can only be set at creation time and cannot be changed later.

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 required

Fincore private account UUID.

bankIdstring uuid required

Bank UUID associated with the private account.

clientIdstring uuid required

Client UUID associated with the private account.

clientBankAdapterIdstring uuid required

Bank adapter configuration UUID used by this private account.

accountIdstring uuid required

Core account UUID backing the private account.

instrumentIdstring uuid required

Instrument UUID linked to this private account.

ownerIdstring uuid required

UUID of the client or Business Unit that owns the private account.

ownerType'CLIENT' | 'BUSINESS' | 'CUSTOMER' required

Type of entity that owns the private account.

accountNumberstring required

Internal account number assigned by the bank adapter.

clabeNumberstring required

CLABE assigned to the private account.

availableBalancestring required

Available balance as a decimal string with two decimals.

accountType'CENTRALIZING_ACCOUNT' | 'DISPERSION_ACCOUNT' | 'PRIVATE_ACCOUNT' | 'SAVINGS_ACCOUNT' | 'CHECKING_ACCOUNT' required
accountStatus'ACTIVE' | 'BLOCKED' | 'SUSPENDED' | 'CANCELLED' required
bankAdapterstring required

Bank adapter that operates the private account.

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"
  },
  "bankAdapter": "SIES"
}

Changes

    • warning

      added the new ACTIVE enum value to the response property for the response status

    • warning

      added the new BLOCKED enum value to the response property for the response status

    • warning

      added the new BUSINESS enum value to the response property for the response status

    • warning

      added the new CANCELLED enum value to the response property for the response status

    • warning

      added the new CENTRALIZING_ACCOUNT enum value to the response property for the response status

    • warning

      added the new CHECKING_ACCOUNT enum value to the response property for the response status

    • warning

      added the new CLIENT enum value to the response property for the response status

    • warning

      added the new CUSTOMER enum value to the response property for the response status

    • warning

      added the new DISPERSION_ACCOUNT enum value to the response property for the response status

    • warning

      added the new PRIVATE_ACCOUNT enum value to the response property for the response status

    • warning

      added the new SAVINGS_ACCOUNT enum value to the response property for the response status

    • warning

      added the new SUSPENDED enum value to the response property for the response status

    • info

      api tag Accounts added

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status