Getting started

1. Create a credential

In the Auryon dashboard, open Integrações → API → Gerar credencial (Integrations → API → Create credential). Give it a name and select only the permissions your system needs (see Authentication).

The secret key is shown only once. Keep it in a secrets vault, never in code or in the browser. You can have up to 5 active credentials and revoke any of them at any time.

2. Test the connection

/v1/ping needs no credential. It tells you that you reached Auryon:

curl https://api.auryon369.com.br/v1/ping

{ "ok": true, "service": "auryon369", "version": "v1" }

3. Test the credential

curl https://api.auryon369.com.br/v1/credentials \
  -H "x-public-key: $AURYON_PUBLIC_KEY" \
  -H "x-secret-key: $AURYON_SECRET_KEY"

The response says what the credential can do:

{ "seller_id": "01a1…", "permissions": ["PRODUCER_DATA", "PRODUCER_TRANSACTIONS"] }

4. Query your sales

curl "https://api.auryon369.com.br/v1/transactions?page=1&page_size=20" \
  -H "x-public-key: $AURYON_PUBLIC_KEY" \
  -H "x-secret-key: $AURYON_SECRET_KEY"

To find the sale for one of your orders, filter by the identifier you sent when creating it: /v1/transactions?identifier=YOUR-ORDER-123.

5. Receive events by webhook

Do not poll the API to find out whether a sale was paid. Register a webhook in Integrações → Webhooks, subscribe to transaction.paid and grant access when it arrives. See Webhooks.

Conventions

• Money: an integer in the currency’s minor unit, as a string. "19900" in BRL is R$ 199.00. The scale comes from the currency (2 decimals for BRL and USD). A string because a large JSON number loses precision in several languages.
• Dates: ISO 8601 in UTC (2026-09-17T12:00:00.000Z).
• Pagination: page (from 1) and page_size (default 20, maximum 100; above that the server caps it at 100). The response has items, page, page_size and total.
• Buyer data: the API and the webhooks carry the buyer’s name and email, which is what you need to deliver the product. Tax ID (CPF), phone and address never leave Auryon.
• Balance per currency: BRL, USD and BDM are never added together; /v1/balance returns a list, one row per currency.