---
title: "Fetch a payment link"
method: GET
path: "/v1/payment_links/{payment_link_id}"
tags: ["Payment links"]
---

# Fetch a payment link

`GET /v1/payment_links/{payment_link_id}`

Fetch a payment link

**Required scope: `business/orders:read`**

## Path parameters

- `payment_link_id` string, required — The unique identifier of the payment link.

## Response `200`

Successful Response

- PaymentLink
  - `id` string, required — The unique identifier of the payment link.
  - `url` string, required — The payment link.
  - `customer_reference` string, required — The customer's name or reference that will appear on the payment page.
  - `customer_description` string, nullable, required — An optional description that will appear on the payment page.
  - `status` 'cancelled' | 'paid' | 'pending', required — A payment link transitions through various states throughout its lifecycle. A payment link is always created in a `pending` state. From there, it will move to a terminal state which will be one of either `paid` or `cancelled`. The following transitions are possible: - pending -> paid - pending -> cancelled
  - `order_id` string, required — A reference to the original order.
  - `created_at` string, date-time, required — The payment link creation date and time in ISO 8601 format.
  - `updated_at` string, date-time, nullable, required — The date and time the payment link was last modified in ISO 8601 format.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `429` — Too Many Requests

---

[API](https://skmtc.net/yoco/apis/yoco-api.md) · [All operations](https://skmtc.net/yoco/apis/yoco-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yoco/yoco-api/versions/1ee03e82bc45/schema)