Authorize one

post

https://api.cardda.com/v1/banking/bank_payrolls/{bank_payroll_id}/authorize

Authorizes a Bank Payroll

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Authorization method and key

bank_key_id

string

Optional selector for the bank key (crawler credential) to authorize 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.

authorization_method

object

token

string

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

device_id

string

Device to be used for authorization

sender_id

uuid

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

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

422

Payroll not available for authorization

Language

Credentials

Bearer

Loading…

Response

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

application/json

200Authorize

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