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

# Get payment link

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

## Request

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

Retrieves payment link details.

This API must be called using a backend bearer token.

## Path parameters

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

## Response `200`

Payment Link

- union
  - PaymentLinkEnabled: An enabled payment link. This is the first status for a payment link.
    - `id` string, required: Unique ID for the Payment Link
    - `type` 'single_payment', required: The type of the Payment link
    - `status` 'enabled', required
  - PaymentLinkDisabling: A payment link that can't be used anymore. The link will likely transition to disabled soon. A link reaching this status is condition based. Not every link will reach this status. This status would come after enabled, and before disabled.
    - `id` string, required: Unique ID for the Payment Link
    - `type` 'single_payment', required: The type of the Payment link
    - `status` 'disabling', required
  - PaymentLinkDisabled: A disabled payment link. This is the final status for a payment link. No more payments can be made.
    - `id` string, required: Unique ID for the Payment Link
    - `type` 'single_payment', required: The type of the Payment link
    - `status` 'disabled', required
    - `disabled_reason` string, required: The reason the payment link is disabled. Example values to expect: - `expired` - `fulfilled` Clients should handle unexpected values gracefully.

## Other responses

- `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)