API Reference
Support

Execute a GraphQL query

post
https://api.payretailers.com/data-api/graphql

Single GraphQL endpoint serving all query operations: payins, payouts, claims, aggregations, ping, and currentMerchantId.

This is a read-only API. Only GraphQL query operations are supported; mutations are not available.

Your credentials are validated on every request. Your Shop ID is resolved to a merchant account, and all queries are automatically scoped to your data.

Body Params
string
required

The GraphQL query string.

variables
object | null

Variables for the GraphQL query.

string | null

Name of the operation to execute when the query contains multiple operations.

Headers
string

Optional request correlation ID for tracing. If not provided, the API auto-generates one. Returned in the response header and included in all error extensions.

string
enum
Defaults to false

Include X-Pii-Access: true to access unmasked PII fields (customer email, personal ID, phone, name, address, etc.). When omitted or false, PII fields are returned masked.

Allowed:
Responses

Updated 23 days ago

Language
Credentials
Basic
base64
:
Request
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 23 days ago