---
title: "Get payments by user"
method: GET
path: "/payments"
---

# Get payments by user

`GET /payments`

## Query parameters

- `limit` number
- `sort` 1 | -1
- `nextPage` string

## Response `200`

Response

- object
  - `nextPage` string, nullable — Represents the total number of items that exists after full pagination
  - `items` Payment[]
    - `id` string — A unique identifier for the payment
    - `userId` string — A unique identifier for the user
    - `isBusiness` boolean — If true this payment will be only of business type
    - `language` string — The language to use in the consent journey, if not set the user will be able to choose the language
    - `providerId` string — A unique identifier for the provider
    - `providerIds` string[]
    - `merchantId` string — A unique identifier for the merchant
    - `orgId` string — A unique identifier for the organization
    - `psuId` string — The national id or passport number of the person who is paying
    - `psuIdType` string
    - `psuCorporateId` string — The corporate id of the debtor
    - `psuCorporateIdType` string
    - `service` 'masav' | 'fp' | 'zahav' — The type of the payment service
    - `product` string
    - `amount` number — The amount of the payment
    - `currency` string — The currency of the payment
    - `status` 'ACCC' | 'ACSC' | 'ACSP' | 'ACTC' | 'ACWC' | 'RCVD' | 'RJCT' | 'CANC' | 'ACFC' | 'PATC' | 'PART' | 'PENDING' | 'ERROR' | 'INIT' — The status of the payment
    - `creditorAccountType` 'bban' | 'iban' — The type of the acount number of the creditor
    - `creditorAccountNumber` string — The account number of the creditor
    - `debtorAccountType` 'bban' | 'iban' — The type of the acount number of the debtor
    - `debtorAccountNumber` string — The account number of the debtor
    - `creditorName` string — The name of the creditor
    - `description` string — The description of the payment
    - `error` object
      - `message` string — Error message
      - `type` string — Error type
    - `isFake` boolean — Indicates whether the payment is connected to a sandbox provider
    - `authorizationMessage` string
    - `scaStatus` string
    - `psuMessage` string
    - `directPayOnly` boolean — Indicates whether the payment is a direct payment without an open banking consent
    - `isIframe` boolean — Indicates whether the payment journey will be displayed inside an iframe
    - `allowBusiness` boolean — Indicates whether the payment allows business accounts
    - `redirectUrl` string — The URL to which the user will be redirected after the payment is completed
    - `providerIdentifier` string — A unique identifier for the provider
    - `createdAt` string, date-time — The timestamp in UTC when the payment was created
    - `updatedAt` string, date-time — The timestamp in UTC when the payment was updated
    - `startDate` string, date — The first applicable day of execution for periodic payments
    - `endDate` string, date — The last applicable day of execution for periodic payments (optional)
    - `frequency` 'Daily' | 'Weekly' | 'EveryTwoWeeks' | 'Monthly' | 'EveryTwoMonths' | 'Quarterly' | 'SemiAnnual' | 'Annual' | 'MonthlyVariable' — The frequency of recurring payments
    - `executionRule` 'following' | 'preceding' — Execution rule for periodic payments when payment date falls on weekend/holiday
    - `dayOfExecution` string — Day of month for execution (1-31) for periodic payments
    - `monthsOfExecution` string[] — Array of months (1-12) for execution. Only valid when frequency is 'MonthlyVariable'
    - `bulkPayments` object[] — Array of individual payments in a bulk payment (only for bulk-payments product)
      - `amount` number — The amount of this individual payment
      - `currency` string — The currency of this individual payment
      - `creditorAccountType` 'iban' | 'bban' — The type of creditor account
      - `creditorAccountNumber` string — The creditor account number
      - `creditorName` string — The creditor name
      - `description` string — Description for this individual payment
      - `merchantId` string — Optional merchant ID for this individual payment
    - `batchBookingPreferred` boolean — If true, the PSU prefers only one booking entry for bulk payments
    - `paymentInformationId` string — Identification assigned by the merchant for the bulk payment
    - `requestedExecutionDate` string, date — Requested execution date for the payment
    - `requestedExecutionTime` string, date-time — Requested execution time for the payment
    - `requestStatus` 'PENDING' | 'RCVD' | 'ACCP' | 'ACWC' | 'RJCT' — RTP request status (only present for request-to-pay payments)
    - `requestReasonCode` string — Reason code for RTP rejection (only present for request-to-pay payments)
    - `requestAcceptedAmount` number — Accepted amount if different from requested (only present for request-to-pay payments)
    - `requestDebtorDecisionDateTime` string, date-time — Date/time when the debtor made a decision (only present for request-to-pay payments)
    - `requestExpiryDateTime` string, date-time — RTP expiry date/time (only present for request-to-pay payments)

## Other responses

- `400` — orgId was not provided
- `401` — Unauthorized access - Invalid access token
- `403` — Forbidden - Access token missing the required permissions to perform this action
- `404` — Route or entities were not found
- `500` — Internal server error

---

[API](https://skmtc.net/open-finance/apis/auth.md) · [All operations](https://skmtc.net/open-finance/apis/auth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/open-finance/auth/versions/b4d401b65c3d/schema)