---
title: "Get bank payments"
method: GET
path: "/companies/{companyId}/bank-payments"
tags: ["bank-payments"]
---

# Get bank payments

`GET /companies/{companyId}/bank-payments`

## Request

- Base URL: `https://api.bokio.se/v1`
- URL: `https://api.bokio.se/v1/companies/{companyId}/bank-payments`
- Auth: HTTP bearer

Get all bank payments for the company that were created by the integration.
**Scope:** `bank-payments:read-limited`

## Query parameters

- `page` integer
- `pageSize` integer
- `query` string

## Response `200`

Bank payments found

- object
  - `totalItems` integer
  - `totalPages` integer
  - `currentPage` integer
  - `items` BankPayment[]
    - `id` string, uuid: Unique identifier of the payment
    - `status` 'readyToSign' | 'onTheWay' | 'scheduled' | 'paid' | 'rejected' | 'cancelled' | 'error': Current status of the payment
    - `createdDateTime` string, date-time: Date and time when the payment was created
    - `amount` number, double, required: Amount of the payment
    - `paymentDate` string, date, required: Date of the payment
    - `ownNote` string: Own note for the payment
    - `recipientRef` union, required: Payment recipient information
      - BankgiroRecipient
        - `kind` 'bankgiro', required
        - `recipientName` string, required: Name of the payment recipient
        - `bankgiroNumber` string, required: Bankgiro number (required for Bankgiro payments)
        - `ocr` string: OCR reference for the payment. Either `ocr` or `message` must be provided, but not both.
        - `message` string: Message for the payment. Either `message` or `ocr` must be provided, but not both.
      - TransferRecipient
        - `kind` 'transfer', required
        - `recipientName` string, required: Name of the payment recipient
        - `recipientReference` string: Reference for the payment recipient
        - `clearingNumber` string, required: Clearing number (required for Transfer payments)
        - `accountNumber` string, required: Account number (required for Transfer payments)

## Other responses

- `400`: Invalid query filter

---

[API](https://skmtc.dev/bokio/apis/company-api.md) - [All operations](https://skmtc.dev/bokio/apis/company-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bokio/apis/company-api/revisions/9395020f3da2?raw)