Sign in
latestOpenAPI 3.0.02026-07-2422987517.5 KB

ff1aeb3fda8b

Bank payroll

Enroll one

This endpoint enrolls a Payroll on the corresponding bank.

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

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.

sender_idstring uuid required

The id of the bank account involved

authorization_method'digipass' | 'device'

Authorization method to be used.

tokenstring
device_idstring

Device to be used for authorization

Example request

{
  "bank_key_id": "47b93e3d-36a6-423a-acbe-c23b5484c3ed",
  "device_id": "1ba260d1-c110-4c23-a11f-01a89ac8f2ff"
}

Response

Enrolled bank payroll

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