Getting started
Pix payments API.
Addresses #
| Environment | API | Token |
|---|---|---|
| Production | https://api.amunpay.com |
https://api.amunpay.com/oauth/token |
Credentials #
Ask your sales contact. You receive:
- the
client_id(the short name of your account, such asloja01); - the
client_secret, delivered once through a secure channel. Keep it in a vault: it is not shown again; - the list of granted scopes.
With the three, go to Authentication.
Rules that apply to the whole API #
- Money is a decimal string with two places:
"150.00". Never a number. - Instants are RFC 3339 in UTC:
2026-09-18T12:00:00Z. Statement dates are the accounting day in America/Sao_Paulo. - Charge, payout and sub-account identifiers are yours: 26 to 35 alphanumeric characters. The refund id is also yours, with 1 to 35. We recommend ULID.
- A CPF has 11 digits, without punctuation. A CNPJ has 14 positions, without punctuation: the first 12 may be digits or uppercase letters, and the last 2 are digits, such as
12ABC34501DE35. Store the CNPJ as text, never as a number. - Every response carries
x-correlation-id, including the response to the token request. Keep it to talk to support. - Your parser must tolerate new fields and values.
For machines #
- llms.txt: the list of these pages, one sentence each.
- The OpenAPI specification of the
/v2/ex/routes is served atGET /v2/openapi.yaml. The charge, received Pix and refund routes follow the Central Bank of Brazil standard and are not in that specification.