List payment sessions

API reference

Request

Returns payment sessions, newest first. Each item is the same snapshot as Retrieve a payment session, without failure_reason.

Which sessions you see: a fund sees the sessions it owns. A distributor sees the sessions credited to it, across every fund it has a relationship with.

Page size: per_page defaults to 20 and is capped at 25, because each item is a full snapshot. A larger value is not an error: it returns 25 items and page_meta.per_page is 25. This endpoint does not accept before or after.

Security

JWT

Query

statusstring

Return only sessions with this final status. Only completed and failed can be filtered on; any other value returns 400. Each item's status still uses the full set of values described on the snapshot.

Enum:"completed""failed"

scheme_codestring

Return only sessions for this AMC scheme: the scheme the investor chose, or, before they choose, the scheme of the prefilled plan. Case-insensitive. A code that matches no scheme returns an empty page, not an error.

Example:scheme_code=SCH001

per_pageinteger, [ 1 .. 25 ]

Number of sessions per page. Values above 25 are treated as 25.

Default:20

pageinteger

Page number for pagination. Starts from 1. Get the next page number from the next field in the response.

Default:1

curl -i -X GET \
  'https://api.glomopay.com/api/v1/payment-sessions?status=completed&scheme_code=SCH001&per_page=20&page=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Payment sessions matching the filters.

Bodyapplication/json

dataArray of objects(PaymentSessionSnapshot)

page_metaobject(PageMeta)

Response

{
  "data": [
    { … }
  ],
  "page_meta": {
    "current": 1,
    "previous": null,
    "next": 2,
    "per_page": 1,
    "pages": 14,
    "count": 14
  }
}