N3n3xt
Payments

List Payments

Retrieve a list of all payments made by the authenticated user.

get/payments

Request

Query parameters

statusstring

Comma-separated list of payment statuses to filter by. Available statuses: queued, requested, initiated, lockbox, released, partial, cancelled, declined, completed, failed. Example: "completed,lockbox" (optional).

walletIdstring

Filter payments by specific wallet ID. Must be a valid UUID format (optional).

startDatestring

Filter payments created after this date (ISO 8601 format) (optional).

endDatestring

Filter payments created before this date (ISO 8601 format) (optional).

amountGreaterThanstring

Filter payments with transaction amount greater than or equal to this value (optional).

amountLessThanstring

Filter payments with transaction amount less than or equal to this value (optional).

senderBusinessIdstring

Filter payments with sender business ID (optional).

recipientBusinessIdstring

Filter payments with recipient business ID (optional).

businessIdstring

Filter payments where sender or recipient matches business ID (optional).. This is a legacy filter that is no longer supported.

descriptionstring

Filter payments by description (case-insensitive partial match) (optional).

orderBy'createdAt' | 'updatedAt'

Sort payments by a field. Available fields: createdAt, updatedAt. (optional).

order'asc' | 'desc'

Sort direction. Available values: asc, desc. Example: "asc" (optional).

limitnumber double

Positive integer page size. Default: 100. Max: 200. 0 is rejected.

offsetnumber double

Non-negative integer page offset. Default: 0.

Response

The list of payments was retrieved successfully.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.