Retrieve PayIds

get

https://api.test.payadvantage.com.au/v3/pay_ids

Get a list of Pay IDs. For more information, please see https://docs.payadvantage.com.au/docs/payid-payments

Query Params

page

integer

≥ 0

Defaults to 0

Responses are paged to return a limited amount of records. This parameter is used to retrieve a specific page number.

per_page

integer

0 to 1000

Defaults to 100

The number of records per page to retrieve.

sort

array of strings

A comma seperated list of fields to sort by. Fields prefixed with a "-" will sort in descending order.
The fields include: DateCreated,-DateCreated,Amount,-Amount

sort

datecreated

date-time

length between 8 and 33

Returns pay id records by the date when the pay id was created. datecreatedto and datecreatedfrom allow you to submit a range of dates.

datecreatedfrom

date-time

length between 8 and 33

Returns pay id records by the date when the pay id was created. datecreatedto and datecreatedfrom allow you to submit a range of dates.

datecreatedto

date-time

length between 8 and 33

Returns pay id records by the date when the pay id was created. datecreatedto and datecreatedfrom allow you to submit a range of dates.

dateexpires

date-time

length between 8 and 33

Returns pay id records by expiry date. dateexpiresto and dateexpiresfrom allow you to submit a range of dates.

dateexpiresfrom

date-time

length between 8 and 33

Returns pay id records by expiry date. dateexpiresto and dateexpiresfrom allow you to submit a range of dates.

dateexpiresto

date-time

length between 8 and 33

Returns pay id records by expiry date. dateexpiresto and dateexpiresfrom allow you to submit a range of dates.

description

string

length between 2 and 200

Filter pay ids by description.

amount

number

Returns pay id records by amount range.

amountfrom

number

Returns pay id records by amount range.

amountto

number

Returns pay id records by amount range.

payid

string

length ≥ 5

Filter by pay id

customer.code

string

Filter by customer code

Responses

200PayIds matching the search criteria

400Bad request

401User is not authorized

403The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource, or may need an account of some sort

404The requested resource could not be found

422The request was well-formed but was unable to be followed due to semantic errors

429Request limit exceeded

500Internal server error

504Gateway timeout