API reference

Every endpoint your server uses, with the key it needs. All requests send Authorization: Bearer sk_test_… or sk_live_…, and only see data from that key’s mode.

Payment links

Request	What it does
`POST /v1/payment_links`	Create a link. Returns `id`, `url_slug` and `checkout_url`.
`GET /v1/payment_links`	List links with views, payments, volume and conversion_rate.
`GET /v1/payment_links/:id`	Read one link.
`PATCH /v1/payment_links/:id`	Update fields, or send `"active": false` to turn it off.
`POST /v1/payment_links/:id/resend_webhook`	Send the latest result for that link to your webhook again.
`POST /v1/pay_by_bank`	Create a pay by bank link (US bank account, USD). Send `bank` so the customer only clicks Pay.
`GET /v1/pay_by_bank/links`	List pay by bank links.
`GET /v1/pay_by_bank/payments`	Pay by bank payment history and statuses.
`POST /v1/payment_links` with `"kind": "onramp"`	Create a pay by onramp link (USD or EUR). The customer pays by card or bank in a crypto onramp.
`GET /v1/payment_links?kind=onramp`	List pay by onramp links.
`GET /v1/onramp/status`	Whether pay by onramp is enabled for your account in this mode.

Field details are on Pay by link.

Payments (read)

Hosted checkout and S2S create payment attempts. Use these endpoints to list and inspect them in your integration or the merchant portal — there is no public create/confirm API.

Request	What it does
`GET /v1/payments`	List payment attempts. See Pagination below. Add `?channel=onramp` for pay by onramp payments only.
`GET /v1/payments/:id`	Read one payment (`pi_…` or `ch_…`), including charge and last_payment_error.
`GET /v1/payments/:id/webhook_deliveries`	Every webhook attempt for that payment.

Card details are entered on hosted checkout or via server-to-server. Create payment links with POST /v1/payment_links.

Server-to-server

Card data from your server only. See Server-to-server.

Request	What it does
`POST /v1/s2s/payments`	One charge. ParuPay sets 2D (captured) or 3D (ACS URL) from the card.
`GET /v1/s2s/payments/:id`	Read the payment, three_d_secure, and charge.

Charges and refunds

A charge (ch_…) is created when a payment is captured. It holds the card brand, last 4 digits, platform_fee and net_amount.

Request	What it does
`GET /v1/charges`	List captured charges, newest first. Optional `?limit=` (default 50).
`GET /v1/charges/:id`	Read one charge.
`POST /v1/charges/:id/refunds`	Refund all or part of a charge.
`POST /v1/charges/:id/resend_webhook`	Send that charge’s webhook again.

POST /v1/charges/ch_…/refunds
{ "amount": 500, "reason": "Customer returned one item" }

Leave out amount to refund the remaining balance. Several partial refunds are allowed until they add up to the charge amount; the charge status becomes refunded when it is fully refunded. Each refund sends charge.refunded.

Webhooks

Register and manage endpoints in the merchant portal under Integrations — there is no public API to create or update webhook URLs. See Webhooks for the payload, signature check, and delivery rules. Resend a failed delivery with POST /v1/charges/:id/resend_webhook or POST /v1/payment_links/:id/resend_webhook, and inspect attempts with GET /v1/payments/:id/webhook_deliveries.

Pagination

GET /v1/payments takes page (from 1), page_size (1–100, default 20), status and a search term q. It returns:

{
  "items": [ { "id": "pi_…", "status": "succeeded", "…" : "…" } ],
  "page": 1,
  "page_size": 20,
  "total": 134,
  "page_count": 7,
  "summary": { "succeeded_volume": 482500, "open_count": 12, "status_counts": { } }
}

Errors

Errors use standard HTTP status codes and a JSON body with a message:

{ "detail": "Refund amount exceeds charge amount" }

Status	Meaning
400	The request was understood but cannot be done, for example a refund larger than the charge.
401	Missing or invalid secret key.
403	The key cannot access this object.
404	Not found in this mode. Sandbox keys never see live objects, and the reverse.
422	A field is missing or has the wrong type. `detail` lists each field.

Start

Accept payments

Developers

Payment links

Payments (read)

Server-to-server

Charges and refunds

Webhooks

Errors