CAcardda
Bank payroll

Authorize all payroll recipients

Authorizes all recipients associated with the payroll not previously authorized. To do this, the payroll's status must be pending_validation.

post/v1/banking/bank_payrolls/{bank_payroll_id}/validate

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/banking/bank_payrolls/{bank_payroll_id}/validate
  • Auth
    HTTP bearer

Parameters

#/paths/~1v1~1banking~1bank_keys/get/parameters/0 (unresolved $ref)
#/paths/~1v1~1banking~1bank_payrolls~1%7Bbank_payroll_id%7D/get/parameters/1 (unresolved $ref)

Request body

bank_key_idstring required

The id of the bank key to be used.

tokenstring

Token (one-time password) for authorizing the recipient. When authorizing a single recipient (POST /bank_recipients/{id}/authorize) send either token or verification_code — whichever the bank requires. When validating all of a payroll's recipients (POST /bank_payrolls/{id}/validate) both token and verification_code are required.

verification_codestring

The verification code sent to your email when the recipient was added. See the note on token for when it is required.

owner_idstring uuid

The id of the bank account involved (single-recipient authorize path).

sender_idstring uuid

The id of the sending bank account (payroll recipient-validation path).

Example request

{
  "bank_key_id": "47b93e3d-36a6-423a-acbe-c23b5484c3ed",
  "token": "123456",
  "verification_code": "9876543"
}

Response

The payroll with its recipient validation in progress

idstring uuid required

Unique identifier for the payroll

sender_idstring uuid required

ID of the bank account that will send the payments

status'draft' | 'enrolled' | 'enroll_failed' | 'pending_validation' | 'preauthorized' | 'approved' | 'declined' | 'deleted' required

Current status of the payroll

transition'enroll' | 'preauthorize' | 'authorize' | 'delete' nullable required

Current transition being processed for the payroll

namestring required

Name of the payroll

external_idstring nullable

External identifier assigned by the bank. Null until the bank accepts the payroll.

bank_idstring

Identifier of the bank where the payroll will be processed

holder_idstring uuid

ID of the company that owns this payroll

raw_dataobject nullable

Raw data from the bank system, can contain any data structure

payment_datestring date nullable

Date when the payment is scheduled to be processed

categorystring

Category of the payroll (e.g., suppliers, employees)

onlineboolean

Indicates whether the payroll will be paid the same day (true) or is deferred (false)

number_of_transactionsinteger nullable

Count of line items in the batch.

totalinteger nullable

Sum of amount across all line items, in minor units.

receiptboolean

Whether a downloadable receipt exists. Pull it from GET /v1/banking/bank_payrolls/{id}/receipt/url.

bank_errorsItems[] (unresolved $ref)

List of errors returned by the bank for this payroll

created_atstring date-time

Timestamp when the payroll was created

updated_atstring date-time

Timestamp when the payroll was last updated

Changes

No recorded changes to this operation across all 1 revision of this API.