Remove one

patch

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

Returns an enrolled bank payroll to draft

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

bank_payroll_id

string

required

The id of the payroll

Body Params

request body description

bank_key_id

string

required

The id of the bank key to be used.

sender_id

uuid

required

The id of the bank account involved

authorization_method

string

enum

Authorization method — only relevant for Banco de Chile online payrolls.

Allowed:

token

string

One-time password — only relevant for Banco de Chile online payrolls.

device_id

string

Device to be used for authorization — only relevant for Banco de Chile online payrolls.

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 removal

Language

Credentials

Bearer

Loading…

Response

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

application/json

200Bank payroll as draft

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).