---
title: "Get Payment Link Details"
method: GET
path: "/v1/payment_links/{id}"
tags: ["Payment Links"]
---

# Get Payment Link Details

`GET /v1/payment_links/{id}`

Retrieves a payment link by ID.

## Path parameters

- `id` string, required

## Query parameters

- `status` 'active' | 'archived'
- `mode` 'live' | 'test'

## Headers

- `Authorization` string, required

## Response `200`

Payment link retrieved successfully.

- object
  - `data` object
    - `id` string, required
    - `amount` integer, required
    - `currency` string, required
    - `description` string
    - `livemode` boolean, required
    - `remarks` string
    - `status` string, required
    - `url` string, required
    - `reference_number` string, required
    - `metadata` object, required
    - `restrictions` object
      - `completed_sessions` object
        - `count` integer
        - `limit` integer
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

## Other responses

- `401` — Unauthorized.
- `404` — Payment link not found.
- `500` — Internal server error.

---

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