Skip to navigation
CargoExtra Gateway API CopyBilling AdminPayment History

List Payment Histories

View as Markdown

Lists online invoice payment histories across customers.

Query filters: page, limit, sortBy, sortOrder, all, invoice, customer, currency, status, date range.

Response fields: data[], pagination, with payment history fields described in User Billing.

Possible errors:

  • 400: Missing One or More Required Parameters - required body/query fields were not supplied.
  • 401: Unauthorized - token is missing, expired, invalid, or the account/token pair was not found.
  • 403: Access denied - gateway traffic guard/rate policy blocked the request.
  • 429: Too many requests - gateway rate limit exceeded.
  • 500: Unexpected Error - unhandled gateway or downstream service failure.

Query parameters

pageintegerOptional

Query parameter supported by the gateway/downstream service.

limitintegerOptional

Query parameter supported by the gateway/downstream service.

sortBystringOptional

Query parameter supported by the gateway/downstream service.

sortOrderstringOptional

Query parameter supported by the gateway/downstream service.

customerstringOptional

Query parameter supported by the gateway/downstream service.

invoicestringOptional

Query parameter supported by the gateway/downstream service.

currencystringOptional

Query parameter supported by the gateway/downstream service.

statusstringOptional

Query parameter supported by the gateway/downstream service.

Response

OK
key_0integer
key_1string
key_2double
key_3string
key_4boolean

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error