API Reference

List Payments

get
https://mapi.boomfi.xyz/v1/payments

The List Payments endpoint allows you to retrieve a list of all payment transactions associated with your organization. It is a valuable tool for tracking and reviewing your organization’s payment history, ensuring that you have an overview of all financial activities within the BoomFi platform.

📘

Note

Use pagination parameters to efficiently navigate through a large volume of payments.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Retrieve a list of payments from a particular customer.

string

Retrieve a list of payments from a particular paylink.

string

Retrieve a list of payments from a particular plan.

string

Retrieve payments after this timestamp.

string

Retrieve payments before this timestamp.

integer
1 to 100

The maximum number of payments to retrieve (default=100, maximum=100).

integer
≥ 1

The page number of results to retrieve.

string

Retrieve payments since this timestamp.

string
enum

Sort order for payments (asc=ascending, desc=descending).

Allowed:
string

Retrieve payments until this timestamp.

Responses

Updated 3 months ago

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

Updated 3 months ago

Did this page help you?