v1

latestOpenAPI 3.0.32026-07-26618696.8 KB
Payment Collection

List Invoices

Retrive and filter invoices

get/api/v1/invoices/

Query parameters

accountstring
api_refstring
pageinteger

A page number within the paginated result set.

provider_refstring
record_idstring

Invoice ID

state'CANCELED' | 'COMPLETE' | 'FAILED' | 'PARTIAL' | 'PENDING' | 'PROCESSING' | 'RETRY'
  • PENDING - PENDING
  • PROCESSING - PROCESSING
  • FAILED - FAILED
  • CANCELED - CANCELED
  • PARTIAL - PARTIAL
  • COMPLETE - COMPLETE
  • RETRY - RETRY
wallet_idstring

Wallet ID

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"
}