PaybytokenDocs
Payment Requests
API reference · Payment Requests

Retrieve and list Payment Requests

Read current receivable state with account-scoped filters and cursor pagination.

GET /api/v1/payment_requests/:id

const request = await paybytoken.paymentRequests.get('preq_test_123')

GET /api/v1/payment_requests

const page = await paybytoken.paymentRequests.list({
  status: 'open',
  customer_email: 'alex@example.com',
  limit: 25,
})

Use starting_after for the next page or ending_before to move backward; do not send both. Results are scoped to the authenticated merchant account and current test/live mode.

The retrieved state is authoritative. Public-page visits, redirects, screenshots, and email status are not proof of payment.

API Workbench

Full Explorer

Open in new tab