HomeAPI Reference
API Reference
API Reference
API Reference

List payments

get
https://api.stg.getontop.com/bill-orchestrator/v1/payment-records

Returns your payments, newest first. Each payment record lists the bills it paid in bill_ids and its invoices in items.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 0
Defaults to 0

Page number, starting at 0.

integer
≥ 1

Page size.

Free-text search, for example a payroll name.

date

Start of the payment date range, YYYY-MM-DD.

date

End of the payment date range, YYYY-MM-DD.

string

Payment method code. See payment_method_type_codes on the Ontop Balance endpoints for the values.

status
array of strings

Payment status, in uppercase. Repeat the parameter to filter by several (status=SUCCEEDED&status=FAILED).

status
Responses

Updated about 12 hours ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 12 hours ago

Did this page help you?