PagAmerican Data API - PagAmerican Data API

Welcome! This API lets you query your sales/purchases programmatically. In 3 steps you’ll make your first request.

Prerequisite: a credential pair (clientId + apiKey) provided by the PagAmerican team. The apiKey is shown only once at creation — store it securely.

Quickstart

Exchange your credentials for a token

curl -X POST https://external-api-service.pagamerican.app/api/v1/auth \
  -H "Content-Type: application/json" \
  -d '{ "clientId": "YOUR_CLIENT_ID", "apiKey": "YOUR_API_KEY" }'

Response:

{ "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6..." }

Query your purchases using the token

curl -G https://external-api-service.pagamerican.app/api/v1/purchases \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6..." \
  --data-urlencode "from=2026-04-01" \
  --data-urlencode "to=2026-05-01" \
  --data-urlencode "limit=1000"

Done! You get the data as JSON

{
  "data": [{ "purchaseId": "pur_019dad28...", "transactionAmount": 97.0, "...": "..." }],
  "meta": { "count": 4, "limit": 1000, "from": "2026-04-01", "to": "2026-05-01", "truncated": false }
}

Generate the token once and reuse it across multiple requests while it’s valid. Only generate a new one when you get a 401.

Key concepts

Dates: `to` is exclusive

To get the entire month of April, use from=2026-04-01 and to=2026-05-01 (the day after your intended last day). The maximum window is 90 days.

Your data, only yours

You only see the data that belongs to you. There’s no per-client filter parameter — it’s enforced automatically by your token.

Rate limits

60 requests/min and 50,000/day per client. When exceeded: 429 with the Retry-After header.

Pagination

Use limit (up to 5000). If meta.truncated is true, there’s more data — narrow the date window. Records come newest first.

Errors

All errors follow the same shape:

{
  "error": {
    "code": "invalid_request",
    "message": "human-readable error description",
    "correlation_id": "a1b2c3d4-0000-0000-0000-000000000000"
  }
}

Status	`code`	When it happens
`400`	`invalid_request`	Invalid parameters (malformed dates, `from > to`)
`401`	`invalid_token`	Token missing, invalid, or expired → generate a new one
`403`	`forbidden`	Token lacks permission for the resource
`422`	`invalid_request`	Date window larger than 90 days
`429`	`rate_limited`	Rate limit exceeded
`5xx`	`internal_error`	Internal error — try again later

The correlation_id is always present in the response (and in the x-correlation-id header). Include it when opening a support ticket — it lets us trace your exact request.

Next steps

Authentication

Understand the token flow and security best practices.

API Reference

Explore the endpoints with the “Try it” playground.

Webhooks

Get notified in near real time about checkouts, orders, and refunds.

​Quickstart

​Key concepts

Dates: `to` is exclusive

Your data, only yours

Rate limits

Pagination

​Errors

​Next steps

Authentication

API Reference

Webhooks

Quickstart

Key concepts

Errors

Next steps