Retrieve or export all payment links

get

https://sandbox-l.ppay.io/api/payments

Retrieve a paginated list or export a CSV of all payment links. To export to CSV, change the request header's Accept value to text/csv.

For more information, see the documentation, and for sample calls, see the public Postman collection.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

merchant

string

The unique merchant ID to scope the list to. Required if you're exporting payment links to CSV.

offset

integer

Defaults to 0

The offset from which to read data.

perPage

integer

Defaults to 50

The amount of items to retrieve.

filters[startDate]

date-time

Retrieve all payment links from the start date onwards.

filters[endDate]

date-time

Retrieve all payment links until the end date.

filters[status]

string

enum

The payment link status to filter on.

Allowed:

filters[amountValue]

number

The amount to filter by.

filters[amountOperator]

string

enum

How to use the amountValue for filtering.

Allowed:

filters[sendingOptions]

string

enum

The sending option to filter on.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Payment links successfully retrieved.

401Request lacks valid authentication.