List of Payments

get

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

🔒
Required scope: money-movement:read
The API credential calling this endpoint must be granted the money-movement category with read or read & write access.
Scopes are assigned to the credential when it is created or edited in Pliant, not requested when obtaining the access token.
A credential without this scope receives 403 Forbidden with the error code INSUFFICIENT_PERMISSION.

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

organizationId

uuid

required

The ID of the organization to get the payments for.

cardAccountId

uuid

The ID of the card account to get the payments for. Payments keep the card account id they were booked on. If a card account was superseded, filtering by the superseded id returns the payments booked before the switch and filtering by its successor (supersededBy) returns the ones booked after. Query both ids to get a complete list across the switch.

type

string

enum

The type of the payments to filter by.

Allowed:

status

string

enum

The status of the payments to filter by.

fromDate

date-time | null

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

toDate

date-time | null

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

byDateField

string | null

enum

Defaults to createdAt

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

Allowed:

limit

integer

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

page

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.

sortBy

string

enum

The field to sort by.

Allowed:

sortDirection

string

enum

The direction to sort by.

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

200Ok

400Bad Request. The API consumer sent a malformed request which could not be processed.

401Unauthorized. The API consumer is not authorized to access the requested resource.

403Forbidden. The API consumer is not allowed to access the requested resource.

429Too Many Requests. The API consumer has sent too many requests in a given amount of time. Please check our API guidelines.

500Internal Server Error. The request was not completed due to an internal error.