Overview

Payment Requests — Base: /v1/payment-requests

A payment request is the aggregate the merchant uses to collect payment. Every payment request has a type discriminator that shapes it:

• PAYMENT_LINK → Payment Links: a hosted, shareable payment page, reusable, that can receive one or many payments.

• INVOICE → Invoices: a bill issued to a specific customer (items, quantity, taxes, due date, PO, memo) that generates a checkout invoice when the customer pays it.

• SUBSCRIPTION → type reserved for recurring charges.

All types share the same query and lifecycle operations on /payment-requests (list/filter, get, pay, activate, deactivate, archive, complete, delete, coupons). Creation and update are type-specific and live in each subfolder.

Filter by type with GET /payment-requests?type=PAYMENT_LINK|INVOICE|SUBSCRIPTION.

Subfolders

• Payment Links (PAYMENT_LINK) — create/update payment links.

• Invoices (INVOICE) — create/update/send invoices and download their PDF.

• General operations — type-agnostic operations (lifecycle + query).

⚠️ Don’t confuse them: an invoice (payment request of type INVOICE, here) is the bill that is issued. A checkout invoice (the Checkout Invoice folder, /v1/invoice) is the Lightning/on-chain charge generated when someone pays.

Scopes: Merchant.payment_link.{read,create,update,delete} (all types use the payment_link scope).