---
title: "Gets a paged list of payments that belong to the specified invoice"
method: GET
path: "/v1/finance/invoices/{invoiceId}/payments"
tags: ["Invoices"]
---

# Gets a paged list of payments that belong to the specified invoice

`GET /v1/finance/invoices/{invoiceId}/payments`

## Request

- Base URL: `https://api.bigchange.com`
- URL: `https://api.bigchange.com/v1/finance/invoices/{invoiceId}/payments`
- Auth: HTTP bearer

Retrieve a paged list of payments for an invoice (required scope finance:read)

## Path parameters

- `invoiceId` integer, required

## Query parameters

- `pageNumber` integer
- `pageSize` integer

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- PagedResponseReadInvoicePaymentModel: A paged collection of items
  - `items` ReadInvoicePaymentModel[]: The items returned for the requested page
    - `id` integer: The unique identifier of the invoice payment
    - `invoiceId` integer: The unique identifier of the invoice this payment is applied to
    - `paidAt` string, date-time: The date and time the payment was made (UTC)
    - `amount` number, double: The payment amount
    - `vatAmount` number, double: The VAT amount applied to the payment
    - `reference` string, nullable: The payment reference
    - `method` 'Unknown' | 'other' | 'cheque' | 'bacs' | 'cash' | 'card' | 'accountingSys' | 'judoPayment' | 'judoPreAuth' | 'blueSnapPayment' | 'blueSnapPreAuth' | 'stripePayment' | 'stripePreAuth': The payment method used to settle an invoice<p>Possible values:</p><ul><li><b>unknown</b>: Unknown payment method</li><li><b>other</b>: Other payment method</li><li><b>cheque</b>: Cheque payment</li><li><b>bacs</b>: BACS bank transfer</li><li><b>cash</b>: Cash payment</li><li><b>card</b>: Card payment</li><li><b>accountingSys</b>: Accounting system payment</li><li><b>judoPayment</b>: JudoPay payment</li><li><b>judoPreAuth</b>: JudoPay pre-authorisation</li><li><b>blueSnapPayment</b>: BlueSnap payment</li><li><b>blueSnapPreAuth</b>: BlueSnap pre-authorisation</li><li><b>stripePayment</b>: Stripe payment</li><li><b>stripePreAuth</b>: Stripe pre-authorisation</li></ul>
    - `onlineReference` string, nullable: The payment gateway's own reference (e.g. a Stripe PaymentIntent id)
  - `pageNumber` integer: The page number of the response where 1 is the first page
  - `pageSize` integer: The number of items requested for the current page
  - `pageItemCount` integer: The number of items returned in the current page

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

## Changes

- **2026-09-03** `553de7d50a1c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bigchange/apis/bigchange-dx/changes/v1/finance/invoices/:invoiceId/payments/get.md)

---

[API](https://skmtc.dev/bigchange/apis/bigchange-dx.md) - [All operations](https://skmtc.dev/bigchange/apis/bigchange-dx/llms.txt) - [OpenAPI document](https://skmtc.dev/bigchange/apis/bigchange-dx/revisions/b262bfdb1dd0?raw)
