v1

latestOpenAPI 3.0.32026-07-268955212.1 KB
bank-payments

Create a bank payment

Creates a new bank payment for the company. Payment will be created in the Bokio system. In order to submit the transaction to the bank, the signatory for the account needs to login to the Bokio application and sign the payment with their BankID. This is different from the transactions imported through a connected bank in Bokio.

Scope: bank-payments:write

post/companies/{companyId}/bank-payments

Request body

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 request

{
  "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

Payment created

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"
  }
}