Enroll one

This endpoint enrolls a Payroll on the corresponding bank.

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

The id of the payroll

Body Params

Requires the selection of the bank key to use.

Requires the sender's information.

Whether authorization_method (plus its token or device_id) is
needed to enroll depends on the bank: Banco de Chile requires it for
online payrolls only — a deferred one (online: false) enrolls
without any second factor — and Scotiabank always requires a token.
The rest of the supported banks enroll without one. See the
authorization_method field for the full per-bank, per-transition
table. (For more information on bank devices, please contact us.)

string

Optional selector for the bank key (crawler credential) to enroll the
payroll with. When omitted, Cardda uses the highest-priority approved
bank key of the sending account for your user (ordered by priority asc,
then most recent). Provide it only to pick a specific key.

uuid

Ignored on this endpoint — the sending account is always read off the
payroll itself. Documented because existing clients still send it.

string
enum

Second factor to authorize the operation with. Which value is valid — and
whether the field is needed at all — depends on the sending bank and on the
payroll transition you are calling
, so send the one your bank uses for that
step.

Cardda pre-validates the combination before touching the bank; one it does not
accept is rejected with 422 {"message": "Invalid authorization parameters"}.

Bankenrollpreauthorizeauthorize
Banco de Chiledigipass + token (6–12 digits) or device + device_idnot required at all when the payroll is deferred (online: false)digipass + token (6–12 digits) or device + device_iddigipass + token (6–12 digits) or device + device_id
BCInot requirednot requiredmultipass + token (6–12 digits)
Santandernot requirednot requiredsantander_pass (no token needed) or token + token (6–12 digits)
Banco BICEnot requirednot requiredbice_pass (no token needed) or token + token (6–12 digits)
Itaúnot requirednot requirednot required
Scotiabanktoken + token (6–12 digits)token + token (6–12 digits)token + token (6–12 digits)
Banco Security, Banco Internacionalnot requirednot available — the payroll flow ends at enrollmentnot available
BCP (Perú)not available — payrolls are not supported on this banknot availablenot available

"Not required" means the pre-validation passes with the field absent; sending
it anyway is harmless. "Not available" means the endpoint answers that same
422 for every combination.

itau_pass stays in the enum for backward compatibility: it only carries
meaning on the standalone transfer endpoints
(POST /v1/banking/bank_accounts/{bank_account_id}/authorize), never on a
payroll.

Allowed:
string

One-time password from the bank's second factor, when the bank requires one.

string

Device to be used for authorization

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

401

Unauthorized

422

Payroll not available for enrollment

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