API Reference

Sync Convenios

post
https://api.cardda.com/v1/banking/bank_accounts//convenios/sync

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The id of the bank account

Body Params
uuid
required

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

Headers
uuid
required

UUID of the company on whose behalf the request is made. Send it on banking
requests to identify the acting company. Note that user-scoped list endpoints
(e.g. the recipients/transactions indexes) resolve results across all companies
the authenticated user is a member of, rather than strictly from this header.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

Responses

Updated 4 days ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 days ago

Did this page help you?