Authorize Bank Account's recipients

post

https://api.cardda.com/v1/banking/bank_accounts/{bank_account_id}/authorize_recipients

Some banks allow authorization of several recipients.

❗️
Allowed banks
The following banks allow the authorization of several recipients:

Banco de Chile

Banco BCI
If you authorize recipients from another bank, you will receive an error.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

bank_account_id

string

required

The id of the bank account

Body Params

Requires the selection of the bank key to use.

Requires the authorization method to use, which depends on the bank, with its corresponding token or device_id (for more information on bank devices, please contact us).

The following banks require the selection of recipients to be authorized:

Banco de Chile

bank_key_id

string

required

The id of the bank key to be used.

authorization_method

string

enum

required

Authorization method to be used.

Allowed:

token

string

device_id

string

Device to be used for authorization

verification_code

string

Verification code — required for Banco BCI.

recipients_ids

array of strings

recipients_ids

Headers

company-id

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

401

Unauthorized

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Bank Recipients being authorized

404Not found — no bank_account with that id is visible to your company. The lookup is company-scoped, so an id that exists but belongs to another company also answers 404 (not 401).

412Precondition failed — either the account's bank does not support recipient authorization (only Banco de Chile and Banco BCI do), or the request exceeds the maximum number of recipients that can be authorized at once.