CAcardda
Convenio

List Convenios

Returns every payment agreement ("convenio") configured on a bank account, ordered by codigo. Readable by any member of the company that owns the account. This endpoint is not paginated — it returns the full list.

get/v1/banking/bank_accounts/{bank_account_id}/convenios

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/banking/bank_accounts/{bank_account_id}/convenios
  • Auth
    HTTP bearer

Path parameters

bank_account_idstring required

The id of the bank account

Parameters

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

Response

List of convenios for the account.

idstring uuid required
bank_account_idstring uuid required
codigostring required

Convenio code as registered at the bank.

descripcionstring nullable
habilitado_servibancaboolean
minimo_dias_pagointeger
pensionesboolean
defaultboolean

Whether this is the account's default convenio (at most one per account).

created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "codigo": "12345",
    "descripcion": "Convenio recaudación arriendos"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.