Sign in

v1

latestOpenAPI 3.1.02026-07-24233206489.1 KB
Payment Links

Create Payment Link

Creates a new payment link.

post/v1/payment_links

Headers

Authorizationstring required
Example:Basic base64(sk_live:)

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

Request body

amountinteger required

Amount in the smallest currency unit (e.g. 10000 = PHP 100.00). Minimum 100, maximum 999999999.

currencystring required

Three-letter ISO currency code (uppercase).

descriptionstring required

Description of the payment link.

remarksstring

Remarks attached to the payment link.

metadataobject

Additional metadata (string values).

Example request

{
  "amount": 10000,
  "currency": "PHP",
  "description": "Test Payment Links",
  "remarks": "Test remarks",
  "metadata": {},
  "restriction": {
    "completed_sessions": {
      "limit": 1
    }
  }
}

Response

Payment link created 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": {
        "limit": 1
      }
    },
    "created_at": "2026-03-10T00:00:00Z",
    "updated_at": "2026-03-10T00:00:00Z"
  }
}