Sign in
Bank account

Retrieve one

Returns a bank accounts given it's id

get/v1/banking/bank_accounts/{bank_account_id}

Path parameters

bank_account_idstring required

The id of the bank account

Parameters

#/paths/~1v1~1banking~1bank_keys/get/parameters/0 — unresolved $ref

Response

Body of the searched bank account.

idstring uuid required
balanceinteger nullable
holder_idstring uuid nullable

UUID of the Person (company or counterpart) that owns the account.

bank_idstring

Bank identifier, e.g. cl_banco_de_chile, mx_stp, us_mercury.

typestring

STI subclass, bank-specific (e.g. Banking::Cl::BancoDeChile::Account).

numberstring required
rutstring required
emailstring
namestring
account_type'corriente' | 'vista' | 'ahorro' | 'clabe' nullable

Chilean account types are the following:

  • 'corriente'
  • 'vista'
  • 'ahorro'

Mexican account types are the following:

  • 'clabe'

For more details check the guide.

created_atstring date-time
updated_atstring date-time

Example response

{
  "bank_id": "cl_banco_de_chile",
  "type": "Banking::Cl::BancoDeChile::Account",
  "number": "0011223344",
  "rut": "77989372K",
  "email": "pagos@cardda.com",
  "name": "pagos cardda",
  "bank_errors": [
    {
      "banking_entity_type": "Banking::BankEntity"
    }
  ]
}

Changes