PaybytokenDocs
Payment Requests
API reference · Payment Requests

Payments, deliveries and timeline

Inspect every collection allocation, email attempt and lifecycle transition for one request.

Payment allocations

GET /api/v1/payment_requests/:id/payments

const payments = await paybytoken.paymentRequests.listPayments(request.id, {
  limit: 25,
})

Each row records amount_requested, amount_received, amount_applied, and amount_unapplied. Underpayments can leave the request open. Excess or late confirmed funds remain visible as unapplied instead of silently changing the receivable.

Delivery history

GET /api/v1/payment_requests/:id/deliveries

Filter by pending, processing, sent, failed, or canceled. Delivery history is operational state and never changes the financial status of the request.

Unified timeline

GET /api/v1/payment_requests/:id/timeline

const timeline = await paybytoken.paymentRequests.timeline(request.id, {
  limit: 100,
})

The newest-first timeline combines request transitions, allocation events, and email attempts. Use stable entry IDs for rendering. The underlying resources remain the source of truth.

On this page

API Workbench

Full Explorer

Open in new tab