PagAmerican API

One HTTPS endpoint, one API key, and read access to everything that belongs to your account. There is no SDK to install and no token to refresh. If you can make an HTTP request, you can use it.

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

{
  "data": [{ "purchaseId": 151206, "productName": "EXAMPLE PRODUCT", "amountTransaction": 97.0, "...": "..." }],
  "meta": { "count": 4, "limit": 1000, "from": "2026-08-01", "to": "2026-08-08", "truncated": false }
}

How it behaves

Read only

Every endpoint is a GET. Nothing you call here can change an order, a refund or a customer.

Scoped by your key

You only ever receive your own data. There is no account filter to pass, and none to get wrong.

Same shape everywhere

One error envelope, one date convention, one pagination model, across every resource.

Two things that surprise people

`to` is exclusive

For all of April, use from=2026-04-01 and to=2026-05-01, the day after your intended last day. The widest window you can ask for is 90 days.

`limit` truncates, it does not paginate

limit goes up to 5000 and defaults to 1000. When meta.truncated is true there is more data behind it, so narrow the window. Records come newest first.

When something goes wrong

Every error comes back in the same envelope:

{
  "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`	Key missing, invalid, or revoked
`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 body and in the x-correlation-id header. Include it when you open a support ticket and we can trace your exact request.

Authentication

How the pag_ key works, how to send it, and how to keep it safe.

API Reference

Every resource, every parameter, and a “Try it” playground.

Get started

PagAmerican API

How it behaves

Read only

Scoped by your key

Same shape everywhere

Two things that surprise people

`to` is exclusive

`limit` truncates, it does not paginate

When something goes wrong

Next

Authentication

API Reference

​How it behaves

Read only

Scoped by your key

Same shape everywhere

​Two things that surprise people

to is exclusive

limit truncates, it does not paginate

​When something goes wrong

​Next

Authentication

API Reference

How it behaves

Two things that surprise people

`to` is exclusive

`limit` truncates, it does not paginate

When something goes wrong

Next