v1

latestOpenAPI 3.0.02026-07-26429484.7 KB
Payment Resource

Get all Payments across all Batches

get/{customer}/payments

Path parameters

customerstring required

customer

Query parameters

idsstring

Enter a single payment Id or multiple ids (separated by a comma) to return the required payment(s). Example:id=payment1, payment2, payment3

statusstring

Enter a single payment status or multiple payment statuses (separated by a comma) to return all payments with the requested status(es) Example:status=created, processing, released

fieldsstring

Enter a single payment field or multiple payment fields (separated by a comma) to display a subset of the payment field(s). Example:fields=id, paymentReference

sortBystring

Enter a sorting criteria. Example:id or createdOn. Default sorting criteria is by createdOn and in descending order.

dateFromstring

Enter a date (YYYY-MM-DD) to return payment(s) which were created ‘From’ this date. When filtering by dates, the range limit is 2 years

dateTostring

Enter a date (YYYY-MM-DD) to return payment(s) which were created “To’ this date. When filtering by dates, the range limit is 2 years

pageSizeinteger

Enter the number of records that will be displayed on a page. Max Limit is 1000. Defaults to 1000 records if not specified

pageNumberinteger

Enter the page number that the query will return. Defaults to 1 if not specified

verboseboolean

Enables the return of full payment records during the search if “true” is specified. Default value is “false” and will return a condensed version of the payment record.

Response

200 OK When Verbose is False

totalPagesinteger
currentPageinteger
totalCountinteger
hasPreviousboolean
hasNextboolean