Sign in

v1

latestOpenAPI 3.0.32026-07-268955212.1 KB
bank-payments

Bulk create bank payments

Creates multiple bank payments for the company in a single request. Up to 100 payments can be created per request.

The operation is atomic — if any payment fails validation, no payments are created.

Scope: bank-payments:write

post/companies/{companyId}/bank-payments/bulk

Request body

Example request

{
  "payments": [
    {
      "id": "835ba700-b306-4bd9-8447-59207b6b0002",
      "status": "readyToSign",
      "createdDateTime": "2023-10-01T08:15:00Z",
      "amount": 1000,
      "paymentDate": "2023-10-01",
      "ownNote": "Payment for invoice #12345",
      "recipientRef": {
        "kind": "transfer",
        "recipientName": "Property Management Co",
        "recipientReference": "RENT-2025-08",
        "clearingNumber": "8000",
        "accountNumber": "1234567890"
      }
    }
  ]
}

Response

All payments created successfully.

idstring uuid

Unique identifier of the payment

status'readyToSign' | 'onTheWay' | 'scheduled' | 'paid' | 'rejected' | 'cancelled' | 'error'

Current status of the payment

createdDateTimestring date-time

Date and time when the payment was created

amountnumber double required

Amount of the payment

paymentDatestring date required

Date of the payment

ownNotestring

Own note for the payment

Example response

[
  {
    "id": "835ba700-b306-4bd9-8447-59207b6b0002",
    "status": "readyToSign",
    "createdDateTime": "2023-10-01T08:15:00Z",
    "amount": 1000,
    "paymentDate": "2023-10-01",
    "ownNote": "Payment for invoice #12345",
    "recipientRef": {
      "kind": "transfer",
      "recipientName": "Property Management Co",
      "recipientReference": "RENT-2025-08",
      "clearingNumber": "8000",
      "accountNumber": "1234567890"
    }
  }
]