v1

latestOpenAPI 3.1.02026-07-24233206489.1 KB

Payment Links

Get Payment Link Details

Retrieves a payment link by ID.

get/v1/payment_links/{id}

Path parameters

idstring required

Example:link_12345

Payment link ID.

Query parameters

status'active' | 'archived'

Filter by status.

mode'live' | 'test'

Filter by mode.

Headers

Authorizationstring required

Example:Basic base64(sk_live:)

The API key for authentication. Use Basic base64(sk_live:).

Response

Payment link retrieved successfully.

Example response

{
  "data": {
    "id": "link_12345",
    "amount": 10000,
    "currency": "PHP",
    "description": "Test Payment Links",
    "livemode": true,
    "remarks": "Test remarks",
    "status": "active",
    "url": "https://pm.link/example/aBcDe",
    "reference_number": "aBcDe",
    "metadata": {},
    "restrictions": {
      "completed_sessions": {
        "count": 1,
        "limit": 1
      }
    },
    "created_at": "2026-03-10T00:00:00Z",
    "updated_at": "2026-03-10T00:00:00Z"
  }
}