Legacy API reference
Monetary values in reais (BRL), as a JSON number ("amount": 100.50), as in the old API. Errors
follow the old format: see Errors.
OpenAPI 3.1 specification to download: openapi-legacy.json
Base URL: https://api.auryon369.com.br/api/v1
GET /api/v1/ping
Section titled “GET /api/v1/ping”API status
Permission: none (no credential)
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
message |
"pong" |
yes |
Possible errors: 429 · 503
GET /api/v1/gateway/producer
Section titled “GET /api/v1/gateway/producer”My data · Deprecated
Permission: PRODUCER_DATA
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | yes | |
email |
string | yes | |
phone |
string | yes | |
document |
string | no | |
address |
object (map) | no | |
legalRepresentative |
object (map) | no |
Possible errors: 400 · 401 · 403 · 429 · 503
GET /api/v1/gateway/producer/balance
Section titled “GET /api/v1/gateway/producer/balance”My balance — BRL ONLY · Deprecated
⚠️ Returns the BRL balance only. USD or BDM balance does not show here — use API v1 (/v1/balance), which returns it per currency.
Permission: PRODUCER_DATA
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
available |
number | yes | Amount in reais (BRL) |
pending |
number | yes | Amount in reais (BRL) |
fundLock |
number | yes | Amount in reais (BRL) |
Possible errors: 400 · 401 · 403 · 429 · 503
GET /api/v1/gateway/producer/credentials
Section titled “GET /api/v1/gateway/producer/credentials”Test credentials · Deprecated
Permission: any valid credential
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | yes | |
permissions |
array |
yes | |
grantAllPermissions |
boolean | yes | |
expiresAt |
string \ | null | yes |
Possible errors: 400 · 401 · 403 · 429 · 503
GET /api/v1/gateway/transactions
Section titled “GET /api/v1/gateway/transactions”Find transaction · Deprecated
Do not use it for polling: repeated lookups are blocked (429). Receive updates by webhook.
Permission: PRODUCER_TRANSACTIONS
Query parameters
| Name | Required | Description |
|---|---|---|
id |
no | transactionId returned on creation |
clientIdentifier |
no | the identifier you sent |
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | yes | |
clientIdentifier |
string \ | null | yes |
currency |
string | yes | |
amount |
number | yes | Amount in reais (BRL) |
chargeAmount |
number | yes | Amount in reais (BRL) |
exchangeRate |
number | yes | |
status |
PENDING · COMPLETED · FAILED · REFUNDED · CHARGED_BACK |
yes | |
paymentMethod |
string \ | null | yes |
webhookUrl |
string \ | null | yes |
createdAt |
string | yes | |
payedAt |
string \ | null | yes |
refundedAt |
string \ | null | yes |
boletoInformation |
object (map) \ | null | yes |
pixInformation |
object (map) \ | null | yes |
Possible errors: 400 · 401 · 403 · 404 · 429 · 503
GET /api/v1/gateway/subscriptions
Section titled “GET /api/v1/gateway/subscriptions”Find subscriptions · Deprecated
Permission: PRODUCER_TRANSACTIONS
Query parameters
| Name | Required | Description |
|---|---|---|
transactionId |
no | |
subscriptionId |
no | |
orderId |
no | |
clientIdentifier |
no | |
clientEmail |
no |
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
subscriptions |
array<object (map)> | yes |
Possible errors: 401 · 403 · 429 · 503
POST /api/v1/gateway/producer/refunds
Section titled “POST /api/v1/gateway/producer/refunds”Request a refund (full) · Deprecated
Permission: PRODUCER_TRANSACTIONS
Request body
| Field | Type | Required | Description |
|---|---|---|---|
transactionId |
string | yes | |
reason |
string | yes | |
description |
string \ | null | no |
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | yes | |
transactionId |
string | yes | |
producerId |
string | yes | |
status |
PENDING · COMPLETED · CANCELED |
yes | |
amount |
number | yes | Amount in reais (BRL) |
reason |
string | yes | |
description |
string \ | null | yes |
Possible errors: 400 · 401 · 403 · 404 · 422 · 429 · 503
POST /api/v1/gateway/pix/receive
Section titled “POST /api/v1/gateway/pix/receive”Receive PIX · Deprecated
Repeating the same identifier with the same order returns the SAME transaction; with another amount or payment method, it returns 409 GATEWAY_FAILED_PRECONDITION.
Permission: PRODUCER_TRANSACTIONS
Request body
| Field | Type | Required | Description |
|---|---|---|---|
identifier |
string | yes | Unique per transaction — it is the idempotency key |
amount |
number | yes | Amount in reais (min. 0.01) |
shippingFee |
number | no | |
extraFee |
number | no | |
discount |
number | no | |
products |
array | no | |
products[].id |
string | yes | |
products[].name |
string | yes | |
products[].quantity |
integer | no | |
products[].price |
number | yes | |
products[].physical |
boolean | no | |
splits |
array | no | |
splits[].producerId |
string | yes | Auryon account ID of the recipient |
splits[].amount |
number | yes | Amount in reais (BRL) |
dueDate |
string | no | |
metadata |
object (map) \ | string | no |
callbackUrl |
string | no | |
client |
object | yes | |
client.name |
string | yes | |
client.email |
string | yes | |
client.phone |
string | no | |
client.document |
string | no | |
client.address |
object | no | |
client.address.country |
string | yes | Country, ISO 3166-1 alpha-2 |
client.address.zipCode |
string | yes | |
client.address.state |
string | yes | Brazilian state (UF), e.g. SP |
client.address.city |
string | yes | |
client.address.street |
string | yes | |
client.address.neighborhood |
string | yes | |
client.address.number |
string | yes | |
client.address.complement |
string | no |
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
transactionId |
string | yes | |
status |
OK · FAILED · PENDING |
yes | |
transactionStatus |
PENDING · COMPLETED · FAILED |
yes | |
webhookToken |
string | no | Returned when callbackUrl is sent |
fee |
number | yes | Amount in reais (BRL) |
order |
object | yes | |
order.id |
string | yes | |
order.url |
string | no | |
errorDescription |
string | no | |
pix |
object | yes | |
pix.code |
string | yes | |
pix.image |
string | no | |
pix.base64 |
"" |
yes | Always empty — render the QR from code |
pix.expiresAt |
string | no |
Possible errors: 400 · 401 · 403 · 409 · 429 · 503
POST /api/v1/gateway/boleto/receive
Section titled “POST /api/v1/gateway/boleto/receive”Receive boleto · Deprecated
Repeating the same identifier with the same order returns the SAME transaction; with another amount or payment method, it returns 409 GATEWAY_FAILED_PRECONDITION.
Permission: PRODUCER_TRANSACTIONS
Request body
| Field | Type | Required | Description |
|---|---|---|---|
identifier |
string | yes | Unique per transaction — it is the idempotency key |
amount |
number | yes | Amount in reais (min. 0.01) |
shippingFee |
number | no | |
extraFee |
number | no | |
discount |
number | no | |
products |
array | no | |
products[].id |
string | yes | |
products[].name |
string | yes | |
products[].quantity |
integer | no | |
products[].price |
number | yes | |
products[].physical |
boolean | no | |
splits |
array | no | |
splits[].producerId |
string | yes | Auryon account ID of the recipient |
splits[].amount |
number | yes | Amount in reais (BRL) |
dueDate |
string | no | |
metadata |
object (map) \ | string | no |
callbackUrl |
string | no | |
client |
object | yes | |
client.name |
string | yes | |
client.email |
string | yes | |
client.phone |
string | no | |
client.document |
string | no | |
client.address |
object | yes | |
client.address.country |
string | yes | Country, ISO 3166-1 alpha-2 |
client.address.zipCode |
string | yes | |
client.address.state |
string | yes | Brazilian state (UF), e.g. SP |
client.address.city |
string | yes | |
client.address.street |
string | yes | |
client.address.neighborhood |
string | yes | |
client.address.number |
string | yes | |
client.address.complement |
string | no |
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
transactionId |
string | yes | |
status |
OK · FAILED · PENDING |
yes | |
transactionStatus |
PENDING · COMPLETED · FAILED |
yes | |
webhookToken |
string | no | Returned when callbackUrl is sent |
fee |
number | yes | Amount in reais (BRL) |
order |
object | yes | |
order.id |
string | yes | |
order.url |
string | no | |
errorDescription |
string | no | |
boleto |
object | yes | |
boleto.barcode |
string | yes | |
boleto.digitableLine |
string | yes | |
boleto.pdfUrl |
string | no |
Possible errors: 400 · 401 · 403 · 409 · 429 · 503
POST /api/v1/gateway/crypto/receive
Section titled “POST /api/v1/gateway/crypto/receive”Receive crypto (BDM Digital) · Deprecated
Auryon receives crypto in BDM Digital: crypto.currency must be “BDM”. Repeating the same identifier with the same order returns the SAME transaction; with another amount or payment method, it returns 409 GATEWAY_FAILED_PRECONDITION.
Permission: PRODUCER_TRANSACTIONS
Request body
| Field | Type | Required | Description |
|---|---|---|---|
identifier |
string | yes | Unique per transaction — it is the idempotency key |
amount |
number | yes | Amount in reais (min. 0.01) |
shippingFee |
number | no | |
extraFee |
number | no | |
discount |
number | no | |
products |
array | no | |
products[].id |
string | yes | |
products[].name |
string | yes | |
products[].quantity |
integer | no | |
products[].price |
number | yes | |
products[].physical |
boolean | no | |
splits |
array | no | |
splits[].producerId |
string | yes | Auryon account ID of the recipient |
splits[].amount |
number | yes | Amount in reais (BRL) |
dueDate |
string | no | |
metadata |
object (map) \ | string | no |
callbackUrl |
string | no | |
client |
object | yes | |
client.name |
string | yes | |
client.email |
string | yes | |
client.phone |
string | no | |
client.document |
string | no | |
client.address |
object | no | |
client.address.country |
string | yes | Country, ISO 3166-1 alpha-2 |
client.address.zipCode |
string | yes | |
client.address.state |
string | yes | Brazilian state (UF), e.g. SP |
client.address.city |
string | yes | |
client.address.street |
string | yes | |
client.address.neighborhood |
string | yes | |
client.address.number |
string | yes | |
client.address.complement |
string | no | |
crypto |
object | yes | |
crypto.currency |
string | yes | |
crypto.network |
string | yes |
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
transactionId |
string | yes | |
status |
OK · FAILED · PENDING |
yes | |
transactionStatus |
PENDING · COMPLETED · FAILED |
yes | |
webhookToken |
string | no | Returned when callbackUrl is sent |
fee |
number | yes | Amount in reais (BRL) |
order |
object | yes | |
order.id |
string | yes | |
order.url |
string | no | |
errorDescription |
string | no | |
qr |
object | yes | |
qr.code |
string | yes | |
qr.image |
string | no |
Possible errors: 400 · 401 · 403 · 409 · 429 · 503
POST /api/v1/gateway/card/receive
Section titled “POST /api/v1/gateway/card/receive”⛔ Card through the API — REFUSED · Deprecated
Auryon does NOT take card data through the API (PCI-DSS). This route always returns 400 GATEWAY_FAILED_PRECONDITION and does not read the body. Use POST /gateway/checkout and redirect the buyer.
Permission: none (no credential)
Response 400
| Field | Type | Required | Description |
|---|---|---|---|
statusCode |
number | yes | |
errorCode |
string | yes | |
message |
string | yes | |
details |
any | no |
Possible errors: 429 · 503
POST /api/v1/gateway/card/subscription
Section titled “POST /api/v1/gateway/card/subscription”⛔ Card subscription through the API — REFUSED · Deprecated
Same refusal as card/receive. Use a recurring offer in the checkout.
Permission: none (no credential)
Response 400
| Field | Type | Required | Description |
|---|---|---|---|
statusCode |
number | yes | |
errorCode |
string | yes | |
message |
string | yes | |
details |
any | no |
Possible errors: 429 · 503
POST /api/v1/gateway/pix/subscription
Section titled “POST /api/v1/gateway/pix/subscription”PIX subscription · Deprecated
Each cycle issues a new charge and the buyer pays it. ⚠️ periodicityType: DAYS and firstChargeIn > 0 are not supported. Repeating the same identifier with the same order returns the SAME transaction; with another amount or payment method, it returns 409 GATEWAY_FAILED_PRECONDITION.
Permission: PRODUCER_TRANSACTIONS
Request body
| Field | Type | Required | Description |
|---|---|---|---|
identifier |
string | yes | |
amount |
number | yes | Amount of each charge, in reais (BRL) |
product |
object | yes | |
product.id |
string | yes | |
product.name |
string | yes | |
product.price |
number | no | |
subscription |
object | yes | |
subscription.periodicityType |
DAYS · WEEKS · MONTHS · YEARS |
yes | |
subscription.periodicity |
integer | yes | |
subscription.firstChargeIn |
integer | no | |
client |
object | yes | |
client.name |
string | yes | |
client.email |
string | yes | |
client.phone |
string | no | |
client.document |
string | no | |
client.address |
object | no | |
client.address.country |
string | yes | Country, ISO 3166-1 alpha-2 |
client.address.zipCode |
string | yes | |
client.address.state |
string | yes | Brazilian state (UF), e.g. SP |
client.address.city |
string | yes | |
client.address.street |
string | yes | |
client.address.neighborhood |
string | yes | |
client.address.number |
string | yes | |
client.address.complement |
string | no | |
dueDate |
string | no | |
metadata |
object (map) \ | string | no |
callbackUrl |
string | no | |
crypto |
object | no | |
crypto.currency |
string | yes | |
crypto.network |
string | yes |
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
transactionId |
string | yes | |
status |
OK · FAILED · PENDING |
yes | |
transactionStatus |
PENDING · COMPLETED · FAILED |
yes | |
webhookToken |
string | no | |
fee |
number | yes | Amount in reais (BRL) |
order |
object | yes | |
order.id |
string | yes | |
order.url |
string | no | |
pix |
object (map) | no | |
qr |
object (map) | no | |
subscription |
object | yes | |
subscription.id |
string | yes | |
subscription.periodicity |
number | yes | |
subscription.periodicityType |
WEEKS · MONTHS · YEARS |
yes | |
subscription.nextChargeAt |
string \ | null | yes |
subscription.startAt |
string | yes | |
subscription.status |
ACTIVE · INACTIVE · CANCELED |
yes |
Possible errors: 400 · 401 · 403 · 409 · 429 · 503
POST /api/v1/gateway/crypto/subscription
Section titled “POST /api/v1/gateway/crypto/subscription”Crypto subscription (BDM Digital) · Deprecated
Repeating the same identifier with the same order returns the SAME transaction; with another amount or payment method, it returns 409 GATEWAY_FAILED_PRECONDITION.
Permission: PRODUCER_TRANSACTIONS
Request body
| Field | Type | Required | Description |
|---|---|---|---|
identifier |
string | yes | |
amount |
number | yes | Amount of each charge, in reais (BRL) |
product |
object | yes | |
product.id |
string | yes | |
product.name |
string | yes | |
product.price |
number | no | |
subscription |
object | yes | |
subscription.periodicityType |
DAYS · WEEKS · MONTHS · YEARS |
yes | |
subscription.periodicity |
integer | yes | |
subscription.firstChargeIn |
integer | no | |
client |
object | yes | |
client.name |
string | yes | |
client.email |
string | yes | |
client.phone |
string | no | |
client.document |
string | no | |
client.address |
object | no | |
client.address.country |
string | yes | Country, ISO 3166-1 alpha-2 |
client.address.zipCode |
string | yes | |
client.address.state |
string | yes | Brazilian state (UF), e.g. SP |
client.address.city |
string | yes | |
client.address.street |
string | yes | |
client.address.neighborhood |
string | yes | |
client.address.number |
string | yes | |
client.address.complement |
string | no | |
dueDate |
string | no | |
metadata |
object (map) \ | string | no |
callbackUrl |
string | no | |
crypto |
object | no | |
crypto.currency |
string | yes | |
crypto.network |
string | yes |
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
transactionId |
string | yes | |
status |
OK · FAILED · PENDING |
yes | |
transactionStatus |
PENDING · COMPLETED · FAILED |
yes | |
webhookToken |
string | no | |
fee |
number | yes | Amount in reais (BRL) |
order |
object | yes | |
order.id |
string | yes | |
order.url |
string | no | |
pix |
object (map) | no | |
qr |
object (map) | no | |
subscription |
object | yes | |
subscription.id |
string | yes | |
subscription.periodicity |
number | yes | |
subscription.periodicityType |
WEEKS · MONTHS · YEARS |
yes | |
subscription.nextChargeAt |
string \ | null | yes |
subscription.startAt |
string | yes | |
subscription.status |
ACTIVE · INACTIVE · CANCELED |
yes |
Possible errors: 400 · 401 · 403 · 409 · 429 · 503
POST /api/v1/gateway/pix/deposit
Section titled “POST /api/v1/gateway/pix/deposit”PIX deposit to the balance — not available (501) · Deprecated
Permission: none (no credential)
Response 429
any
Possible errors: 501 · 503
POST /api/v1/gateway/checkout
Section titled “POST /api/v1/gateway/checkout”Create checkout (the CARD path) · Deprecated
Creates (or reuses, by product.externalId) a product and an offer and returns the link. ⚠️ offer.price in REAIS (BRL). A product not approved yet (your account does not approve automatically) returns 409 GATEWAY_FAILED_PRECONDITION with details.productId and details.approvalStatus, without creating an offer: call again after approval.
Permission: PRODUCER_CHECKOUT
Request body
| Field | Type | Required | Description |
|---|---|---|---|
product |
object | yes | |
product.externalId |
string | yes | |
product.name |
string | yes | |
product.photos |
array |
no | |
product.offer |
object | yes | |
product.offer.name |
string | yes | |
product.offer.price |
number | yes | Price in reais (BRL) |
product.offer.offerType |
INTERNATIONAL · NATIONAL · UNDEFINED |
yes | |
product.offer.currency |
string | no | |
product.offer.lang |
string | no | |
product.offer.warranty |
string | no | |
product.offer.type |
string | no | |
product.offer.category |
string | no | |
settings |
object | yes | |
settings.paymentMethods |
array<PIX · CREDIT_CARD · BOLETO · CRYPTO · CASH_ON_DELIVERY · GOOGLE_PAY · APPLE_PAY> |
no | |
settings.acceptedDocs |
array<CPF · CNPJ> |
no | |
settings.thankYouPage |
string | no | |
settings.askForAddress |
boolean | yes | |
settings.colors |
object (map) | no | |
customer |
object | no | |
customer.name |
string | no | |
customer.email |
string | no | |
customer.phone |
string | no | |
customer.document |
string | no | |
customer.address |
object (map) | no | |
trackProps |
object (map) | no |
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
productId |
string | yes | |
offerCode |
string | yes | |
checkoutUrl |
string | yes |
Possible errors: 400 · 401 · 403 · 409 · 429 · 503
GET /api/v1/utils/exchange-rates
Section titled “GET /api/v1/utils/exchange-rates”Exchange rates · Deprecated
Permission: none (no credential)
Query parameters
| Name | Required | Description |
|---|---|---|
from |
yes | |
to |
yes | |
amount |
yes |
Response 200
| Field | Type | Required | Description |
|---|---|---|---|
convertedAmount |
number | yes | |
exchangeRate |
number | yes |
Possible errors: 400 · 429 · 503