---
title: "Get payments"
method: GET
path: "/v3/payment-links/{id}/payments"
tags: ["Payment links"]
---

# Get payments

`GET /v3/payment-links/{id}/payments`

## Request

- Base URL: `https://api.truelayer-sandbox.com`
- URL: `https://api.truelayer-sandbox.com/v3/payment-links/{id}/payments`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://auth.truelayer.com/connect/token` scopes: `payments`

List all the payments associated with the payment link.
This API must be called using a backend bearer token.

## Path parameters

- `id` string, required: Unique ID for the Payment Link

## Query parameters

- `cursor` string: Cursor used for pagination purposes that represents the first item of the page. Returned as `next_cursor` in the response payload of endpoints supporting pagination. Not required to access the first page of items.
- `limit` integer: Maximum number of items included in the returned window. Should be greater than 0 and less than 50. If not set, a default of 25 is considered.

## Response `200`

Payments list

- GetPaymentLinkPayments
  - `items` PaymentLinkPayment[], required
    - union
      - PaymentLinkPaymentPending
        - `id` string, required: Unique ID for the Payment
        - `status` 'pending', required
        - `created_at` string, datetime, required: The date and time the payment was created at.
      - PaymentLinkPaymentSucceeded
        - `id` string, required: Unique ID for the Payment
        - `status` 'succeeded', required
        - `created_at` string, datetime, required: The date and time the payment was created at.
      - PaymentLinkPaymentFailed
        - `id` string, required: Unique ID for the Payment
        - `status` 'failed', required
        - `created_at` string, datetime, required: The date and time the payment was created at.
  - `pagination` Pagination: Pagination object. Optional next cursor to use as query parameters to fetch the page next to the one fetched.
    - `next_cursor` string: Cursor to be used as `cursor` query parameter to fetch the _next page_ in pagination-ready endpoints.

## Other responses

- `400`: Invalid Parameters
- `401`: Unauthenticated
- `403`: Forbidden
- `404`: Payment Link Not Found
- `429`: Rate Limit Exceeded
- `500`: Unknown Error

---

[API](https://skmtc.dev/truelayer/apis/payments-api-v3.md) - [All operations](https://skmtc.dev/truelayer/apis/payments-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/truelayer/apis/payments-api-v3/revisions/a7c585fc9b84?raw)