Pay by link - ONE9PAY Docs

A payment link is a fixed amount and title. Your backend creates it. You share checkout_url, or redirect the customer there from your own checkout button.

Sandbox and live

Key	Who processes the payment
`sk_test_`	The ParuPay sandbox, for every merchant. Pay with the testing cards.
`sk_live_`	ParuPay live processing, once your account is approved. Real cards only.

Create

POST /v1/payment_links with Authorization: Bearer sk_….

{
  "amount": 1000,
  "currency": "usd",
  "title": "Order 1042",
  "description": "Daypack",
  "customer_name": "Northline Buyer",
  "customer_email": "buyer@example.com",
  "customer_phone": "+971500000000",
  "metadata": {
    "order_id": "1042",
    "return_url": "https://shop.example/orders/1042",
    "cancel_url": "https://shop.example/cart"
  }
}

Field	Required	Notes
`amount`	Yes	Minor units of the currency, greater than 0. 1000 is 10.00 USD; 3-decimal currencies such as KWD use 1000 for 1.000.
`currency`	No	Lowercase ISO code such as usd or aed. Stored on the link and every payment from it, and charged exactly as set.
`title`	Yes	Shown on hosted checkout.
`description`	No	Shown under the title.
`customer_name`, `customer_phone`	No	Stored on the link. The hosted pay page does not collect them again.
`customer_email`	Yes for 3-D Secure	Required so checkout can email the one-time password. The pay page has no email field.
`metadata`	No	String key/value pairs, up to 50, keys up to 40 characters, values up to 500. Put your `order_id` here.
`metadata.return_url`	No	Where checkout sends the customer after paying.
`metadata.cancel_url`	No	Where checkout sends the customer when they cancel.

Response

{
  "id": "plink_…",
  "url_slug": "…",
  "checkout_url": "https://pay.parupay.com/…"
}

Field	Use it for
`id`	Payment link id, prefixed `plink_`. Store it on your order.
`url_slug`	Public checkout path.
`checkout_url`	The URL you open for the customer.

Set customer_email when you create the link. Hosted 3-D Secure emails the one-time password to that address; the pay page does not ask for email. Only order_id from metadata is sent back on webhooks.

Read

Request	What it does
`GET /v1/payment_links`	All payment links for your merchant, newest first. Includes views, payments, volume and conversion_rate.
`GET /v1/payment_links/:id`	One payment link by id (`plink_…`).

Create and read links in Try the API. Status values for payments from a link are in Payment statuses.