CAcardda
Convenio

Sync Convenios

Triggers an asynchronous job that re-fetches the account's convenios from the bank. Returns immediately once the job is enqueued.

Requires a bank_key_id selecting the approved bank key (crawler credential) whose manager links to this account. Available to members of the account's company.

post/v1/banking/bank_accounts/{bank_account_id}/convenios/sync

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/banking/bank_accounts/{bank_account_id}/convenios/sync
  • 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)

Request body

bank_key_idstring uuid required

UUID of the approved bank key whose manager links to this account.

Example request

{
  "bank_key_id": "47b93e3d-36a6-423a-acbe-c23b5484c3ed"
}

Response

The sync job was enqueued.

messagestring

Example response

{
  "message": "Sync started"
}

Changes

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