Enroll one

post

https://api.cardda.com/v1/banking/bank_recipients/{bank_recipient_id}/enroll

This endpoint is meant to be used when a bank recipient fails to be enrolled or was deleted in the bank and returns to a 'draft' or 'deleted' status with a null transition, so this endpoint can be used to re enroll that same recipient which will update the null transition once again to 'enroll'.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

bank_recipient_id

string

required

The id of the bank recipient

Body Params

Optional enrollment parameters. Requiredness depends on the recipient's bank
(derive it from the concrete bank, not from the sibling create action):

Banco de Chile: both token and device_id are required on
enroll (the server calls params.require([:token, :device_id])).
Other banks: no body is required.

bank_key_id

uuid

Optional selector for the bank key. When omitted, the highest-priority
approved bank key of the owning account for your user is used.

authorization_method

string

enum

Authorization method — Banco de Chile only. Defaults to digipass.

Allowed:

token

string

One-time password. Required for Banco de Chile on enroll —
sent together with device_id (both are required as a pair;
they are not alternatives).

device_id

uuid

Bank device UUID for Cardda Device users. Required for Banco de
Chile on enroll — sent together with token (both are
required as a pair; device_id does not replace token).

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

201Enrolled bank recipient — re-enrollment enqueued

404Not found — no bank_recipient 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).

422Recipient not available for enrollment — its status is not draft/deleted, or it already has a transition in progress.