Skip to main content
GET
List payments

Authorizations

Authorization
string
header
required

Send your API key as Authorization: ApiKey pc_<your-key>. The API also accepts the key without the ApiKey prefix. API keys authenticate requests to /api/partner/v1/*. Contact GroGov support to rotate your key or deactivate your API account. Rotation invalidates the previous key. Account deactivation blocks both API keys and access tokens.

Query Parameters

limit
integer
default:25

Page size: how many payments to return per page.

Required range: 1 <= x <= 100
status
enum<string>

Only payments with this status (the status field on each payment).

Available options:
succeeded,
failed,
voided,
refunded,
partially_refunded,
unknown
cursor
string

Opaque cursor from the previous page's nextCursor. Repeat the same filters with it.

portalId
string<uuid>
from
string<date-time>

Filter by createdAt >= from.

to
string<date-time>

Filter by createdAt <= to.

Response

200 - application/json

Payments, newest first

success
boolean
Example:

true

data
object