---
title: "Get payment link details by ID"
method: GET
path: "/api/v1/payment-links/{id}"
tags: ["Payment Links"]
---

# Get payment link details by ID

`GET /api/v1/payment-links/{id}`

Get payment link details by ID

## Path parameters

- `id` string, uuid, required — Payment link ID

## Response `200`

Success

- PaymentLinkDetailResponse
  - `success` boolean, required — Indicates if the request was successful
  - `data` object, required
    - `id` string, uuid, required
    - `merchant` object, required
      - `id` string, uuid, required
      - `brand_name` string, required
    - `amount` string, required — Amount in decimal format (e.g. "10.00")
    - `currency` string, required — Currency code (ISO 4217)
    - `payment_reference` string, required
    - `order_id` string, nullable, required
    - `status` 'active' | 'used' | 'expired' | 'cancelled', required — Payment link status
    - `link_type` 'single_use' | 'reusable', required
    - `views_count` integer, required
    - `first_viewed_at` string, date-time, nullable, required
    - `expires_at` string, date-time, required
    - `created_at` string, date-time, required
    - `transaction_id` string, uuid, nullable, required
    - `locale` string, required
    - `metadata` object, nullable, required
    - `payment_link_url` string, uri, nullable, required
    - `redirect_urls` object, nullable, required
      - `success_url` string, uri, required — URL to redirect customer to after successful payment (HTTPS required in production)
      - `failure_url` string, uri, required — URL to redirect customer to after failed payment (HTTPS required in production)

## Other responses

- `401` — Unauthorized
- `404` — Not Found

## Changes

- **2026-06-16** `b372e7d5563d` — 1 breaking, 18 info
  - the `data` response's property type/format changed from ``/`` to `object`/`` for status `200`
  - removed `#/components/schemas/paymentLink_ListItem, subschema #2` from the `data` response property `allOf` list for the response status `200`
  - added the required property `data/amount` to the response with the `200` status
  - added the required property `data/created_at` to the response with the `200` status
  - …15 more
- **2026-02-28** `ecd256fe0106` — 1 info
  - endpoint added
- **2025-11-02** `919eb7a392aa` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/banqzinc/apis/quidkey-api/changes/api/v1/payment-links/:id/get.md)

---

[API](https://skmtc.dev/banqzinc/apis/quidkey-api.md) · [All operations](https://skmtc.dev/banqzinc/apis/quidkey-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/banqzinc/quidkey-api/revisions/f86d2bdbcb08/schema)