List payments.

GET

/v1/payments

curl --request GET \
  --url 'https://api.ridleypay.com/v1/payments?filter%5Bstatus%5D=PAID&filter%5Bcustomer_email%5D=jane%40example.com&filter%5Bcreated_after%5D=2026-01-01&filter%5Bcreated_before%5D=2026-12-31&sort=-created_at&page%5Bsize%5D=25&page%5Bnumber%5D=1' \
  --header 'Authorization: Bearer <token>'

Returns a paginated list of payments for the authenticated source. Supports filtering by status, date range, and customer email.

Authorizations

• default

Parameters

Query Parameters

filter[status]

Filter by payment status.

string

Filter by payment status.

Example

PAID

filter[customer_email]

Filter by customer email.

string

Filter by customer email.

Example

jane@example.com

filter[created_after]

Filter payments created after this date (ISO 8601).

string

Filter payments created after this date (ISO 8601).

Example

2026-01-01

filter[created_before]

Filter payments created before this date (ISO 8601).

string

Filter payments created before this date (ISO 8601).

Example

2026-12-31

sort

Sort by field. Prefix with - for descending. Allowed: created_at, amount, status.

string

Sort by field. Prefix with - for descending. Allowed: created_at, amount, status.

Example

-created_at

page[size]

Number of results per page (max 100).

integer

Number of results per page (max 100).

Example

25

page[number]

Page number.

integer

Page number.

Example

1

Responses

200

Payments list

Media typeapplication/json

object

data

Array<object>

object

id

string

type

string

attributes

object

reference

string

amount

string

currency

string

status

string

paid

boolean

links

object

first

string

last

string

meta

object

current_page

integer

last_page

integer

per_page

integer

total

integer

Example

{
  "data": [
    {
      "id": "1",
      "type": "payments",
      "attributes": {
        "reference": "WOO-123",
        "amount": "99.99",
        "currency": "JMD",
        "status": "PAID",
        "paid": true
      }
    }
  ],
  "links": {
    "first": "https://pay.example.com/api/v1/payments?page%5Bnumber%5D=1",
    "last": "https://pay.example.com/api/v1/payments?page%5Bnumber%5D=1"
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 25,
    "total": 1
  }
}