v1

latestOpenAPI 3.1.02026-07-263436159.3 KB

GraphQL

Execute a GraphQL query

Send a read-only GraphQL query to retrieve your payins, payouts, claims, movement balances, report balances, or aggregations. Provide a JSON body with a query string and optional variables and operationName. Results are automatically scoped to the merchant resolved from your credentials.

post/graphql

Request body

querystring required

The GraphQL query document. This API supports queries only.

variablesobject nullable

A map of variable names to values referenced by the query.

operationNamestring nullable

The name of the operation to execute when the document defines more than one.

Response

The GraphQL response envelope. A successful query returns a data object. Field-level or governance failures are returned in the errors array; GraphQL transport errors are also delivered here with HTTP 200.

dataobject nullable

The query result. Its shape mirrors the fields you requested (for example payins, reportBalances, or aggregations).