---
title: "Retrieve all payments created by an API client"
method: GET
path: "/payments"
tags: ["payments"]
---

# Retrieve all payments created by an API client

`GET /payments`

## Request

- Base URL: `https://identity.moneyhub.co.uk`
- URL: `https://identity.moneyhub.co.uk/payments`
- Auth: API key in header `Authorization`

Requires **payment:read** scope.

## Query parameters

- `limit` integer
- `offset` integer
- `userId` string
- `payeeId` string, uuid
- `startDate` string, date
- `endDate` string, date

## Response `200`

Successful Payment Response

- object
  - `data` Payment[]
    - `id` string, uuid, required: The id of the payment
    - `bankId` string: The id of the bank
    - `amount` integer, required: Payment amount in minor units of the currency, eg. pennies for GBP.
    - `payeeId` string, uuid, required: Payee id
    - `payeeType` 'api-payee' | 'mh-user-account', required: Type of payee
    - `payerId` string: Payer Id
    - `payerRef` string, required: Reference to display on payer's statement
    - `payerType` 'mh-user-account' | 'api-payer': Payer Type
    - `payerName` string: Payer name
    - `payerEmail` string, email: Payer email
    - `currency` string, required: Currency code
    - `isReversible` boolean, required: Determines if payment is refundable
    - `status` 'inProgress' | 'pending' | 'completed' | 'cancelled' | 'rejected' | 'abandoned' | 'error:paymentSubmission' | 'error:redirect' | 'error:tokenGrant', required: The status of the payment
    - `providerStatus` string: The status of the payment
    - `reversedPaymentId` string, uuid: The ID of the payment that was reversed by this payment
    - `paymentSubmissionId` string: Original payment submission id from financial institution
    - `charges` object[], required: List of payment charges
      - `bearer` 'BorneByCreditor' | 'BorneByDebtor' | 'FollowingServiceLevel' | 'Shared': Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
      - `type` 'CHAPSOut' | 'BalanceTransferOut' | 'MoneyTransferOut': Charge type, in a coded form.
      - `amount` integer: Charge amount in minor units of the currency, eg. pennies for GBP.
      - `currency` string: Currency code
    - `initiatedAt` string, date-time, required: The date that the payment was initiated
    - `finalisedAt` string, date-time: The date that the payment was finalised
    - `statusUpdateDateTime` string, date-time: The date that the payment status was last updated
    - `expectedSettlementDateTime` string, date-time: The date that the settlement of the payment is expected
    - `endToEndId` string: Unique identifier relevant to the transaction - Allowed characters (a-zA-Z0-9 :-).
    - `payFileConsent` object
      - `id` string, required: The id of the pay file consent
      - `fileHash` string, required: Hash of the payment file
      - `fileType` string, required: Type of the payment file
      - `numberOfTransactions` string, required: The number of transactions within the file
      - `controlSum` number, required: The total amount of the transactions within the file
      - `fileReference` string, required: Reference or name of the payment file
  - `meta` Meta
    - `limit` integer
    - `offset` integer
    - `total` integer

## Other responses

- `401`: Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
- `403`: Unsuccessful Response - Forbidden - Invalid scopes

## Changes

- **2026-11-03** `e004d9ee1fdb`: 4 warning
  - removed the optional property `id` from the response with the `401` status
  - removed the optional property `id` from the response with the `403` status
  - removed the optional property `userId` from the response with the `401` status
  - removed the optional property `userId` from the response with the `403` status

[Operation history](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-identity-service/changes/payments/get.md)

---

[API](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-identity-service.md) - [All operations](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-identity-service/llms.txt) - [OpenAPI document](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-identity-service/revisions/e004d9ee1fdb?raw)