Sign in
Bank payroll

Create a bank payroll

Creates an empty bank payroll in draft state. The request body takes a name, the sender_id (UUID of the source bank_account), the online flag (true for same-day payrolls, false for deferred), and an optional payment_date (required when online is false). Line items are not part of this request — attach them by creating each transaction via POST /v1/banking/bank_transactions with the new payroll's id passed as bank_payroll_id. Once the line items are in place, walk the lifecycle: validate → preauthorize → authorize. See Tutorial: Emit a payroll and reconcile it.

post/v1/banking/bank_payrolls/

Parameters

#/paths/~1v1~1banking~1bank_keys/get/parameters/0 — unresolved $ref

Request body

namestring required
sender_idstring uuid required

The id of the bank account involved

onlineboolean required

If true, the payroll will enroll as "En línea", else it will enroll as "Diferida".

payment_datestring

The date on which the payroll will be paid. This is necessary for payrolls that are enrolled as "Diferida".

Example request

{
  "name": "Test Payroll",
  "online": true,
  "payment_date": "2025-01-01"
}

Response

New bank payroll

idstring uuid required
sender_idstring uuid required
namestring required
status'draft' | 'enrolled' | 'enroll_failed' | 'pending_validation' | 'preauthorized' | 'approved' | 'declined' | 'deleted' required
transition'enroll' | 'preauthorize' | 'authorize' | 'delete' nullable required
created_atstring date-time
updated_atstring date-time

Example response

{
  "name": "Test Payroll",
  "status": "draft",
  "transition": "enroll"
}

Changes

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