Sign in

v1

latestOpenAPI 3.0.32026-07-26618696.8 KB
Payment Requests

List Payment requests

PayRequests API

get/api/v1/payment-requests/

Query parameters

archivedboolean
checkout__amountnumber
checkout__currencystring
checkout__emailstring
pageinteger

A page number within the paginated result set.

reminder_sentboolean
sent_status'CLICKED' | 'DELIVERED' | 'FAILED' | 'OPENED' | 'PENDING' | 'SENT'
  • PENDING - Pending
  • SENT - Request sent
  • DELIVERED - Email delivered
  • OPENED - Email opened
  • CLICKED - Paylink clicked
  • FAILED - Failed

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}