API Reference
Changelog UpdatesAPI StatusSupport

List of Payments

get
https://partner-api.getpliant.com/api/payments

Returns a list of payments with metadata. Payments happen according to the payment frequency of the organization. They include and consider all relevant transactions and other payments during the specified period. You can use the limit, page, sortBy and sortDirection parameters to filter and sort the results.

Query Params
uuid
required

The ID of the organization to get the payments for.

uuid

The ID of the card account to get the payments for.

string
enum

The type of the payments to filter by.

Allowed:
string
enum

The status of the payments to filter by.

date-time | null

The date from which to return payments, zero-offset UTC time. The date boundary is inclusive. Meaning we compare with >=.

date-time | null

The date until which to return payments, zero-offset UTC time. The date boundary is inclusive. Meaning we compare with <=.

string | null
enum
Defaults to createdAt

Desired date field to be filtered by if fromDate or toDate present.

Allowed:
integer

The maximum number of items to return per page. The default value if not provided is 100, the maximum allowed value is 1000.

integer

The page number to return, starting with 0, this counts up to the total number of pages. The total number of pages is determined by the total number of records divided by the limit.

string
enum

The field to sort by.

Allowed:
string
enum

The direction to sort by.

Allowed:
Responses

Updated 13 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 13 days ago