Referência da API legada

Valores monetários em reais, como número JSON ("amount": 100.50), como na API antiga. Os erros seguem o formato antigo: veja Erros. Especificação OpenAPI 3.1 para baixar: openapi-legacy.json

URL base: https://api.auryon369.com.br/api/v1

GET /api/v1/ping

Status da API

Permissão: nenhuma (sem credencial)

Resposta 200

Campo	Tipo	Obrigatório	Descrição
`message`	`"pong"`	sim

Erros possíveis: 429 · 503

GET /api/v1/gateway/producer

Meus dados · Depreciada

Permissão: PRODUCER_DATA

Resposta 200

Campo	Tipo	Obrigatório
`name`	string	sim
`email`	string	sim
`phone`	string	sim
`document`	string	não
`address`	object (map)	não
`legalRepresentative`	object (map)	não

Erros possíveis: 400 · 401 · 403 · 429 · 503

GET /api/v1/gateway/producer/balance

Meu saldo — SÓ BRL · Depreciada

⚠️ Devolve apenas o saldo em Reais. Saldo em USD ou BDM não aparece aqui — use a API v1 (/v1/balance), que devolve por moeda.

Permissão: PRODUCER_DATA

Resposta 200

Campo	Tipo	Obrigatório	Descrição
`available`	number	sim	Valor em reais
`pending`	number	sim	Valor em reais
`fundLock`	number	sim	Valor em reais

Erros possíveis: 400 · 401 · 403 · 429 · 503

GET /api/v1/gateway/producer/credentials

Testar credenciais · Depreciada

Permissão: qualquer credencial válida

Resposta 200

Campo	Tipo	Obrigatório	Descrição
`name`	string	sim
`permissions`	array	sim
`grantAllPermissions`	boolean	sim
`expiresAt`	string \	null	sim

Erros possíveis: 400 · 401 · 403 · 429 · 503

GET /api/v1/gateway/transactions

Buscar transação · Depreciada

Não use para polling: a consulta repetida é bloqueada (429). Receba atualizações via webhook.

Permissão: PRODUCER_TRANSACTIONS

Parâmetros de consulta

Nome	Obrigatório	Descrição
`id`	não	transactionId devolvido na criação
`clientIdentifier`	não	o identifier que você enviou

Resposta 200

Campo	Tipo	Obrigatório	Descrição
`id`	string	sim
`clientIdentifier`	string \	null	sim
`currency`	string	sim
`amount`	number	sim	Valor em reais
`chargeAmount`	number	sim	Valor em reais
`exchangeRate`	number	sim
`status`	`PENDING` · `COMPLETED` · `FAILED` · `REFUNDED` · `CHARGED_BACK`	sim
`paymentMethod`	string \	null	sim
`webhookUrl`	string \	null	sim
`createdAt`	string	sim
`payedAt`	string \	null	sim
`refundedAt`	string \	null	sim
`boletoInformation`	object (map) \	null	sim
`pixInformation`	object (map) \	null	sim

Erros possíveis: 400 · 401 · 403 · 404 · 429 · 503

GET /api/v1/gateway/subscriptions

Buscar assinaturas · Depreciada

Permissão: PRODUCER_TRANSACTIONS

Parâmetros de consulta

Nome	Obrigatório	Descrição
`transactionId`	não
`subscriptionId`	não
`orderId`	não
`clientIdentifier`	não
`clientEmail`	não

Resposta 200

Campo	Tipo	Obrigatório	Descrição
`subscriptions`	array<object (map)>	sim

Erros possíveis: 401 · 403 · 429 · 503

POST /api/v1/gateway/producer/refunds

Solicitar reembolso (total) · Depreciada

Permissão: PRODUCER_TRANSACTIONS

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`transactionId`	string	sim
`reason`	string	sim
`description`	string \	null	não

Resposta 200

Campo	Tipo	Obrigatório	Descrição
`id`	string	sim
`transactionId`	string	sim
`producerId`	string	sim
`status`	`PENDING` · `COMPLETED` · `CANCELED`	sim
`amount`	number	sim	Valor em reais
`reason`	string	sim
`description`	string \	null	sim

Erros possíveis: 400 · 401 · 403 · 404 · 422 · 429 · 503

POST /api/v1/gateway/pix/receive

Receber PIX · Depreciada

Repetir o mesmo identifier com o mesmo pedido devolve a MESMA transação; com outro valor ou outra forma de pagamento, responde 409 GATEWAY_FAILED_PRECONDITION.

Permissão: PRODUCER_TRANSACTIONS

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`identifier`	string	sim	Único por transação — é a chave de idempotência
`amount`	number	sim	Valor em reais (mín. 0.01)
`shippingFee`	number	não
`extraFee`	number	não
`discount`	number	não
`products`	array	não
`products[].id`	string	sim
`products[].name`	string	sim
`products[].quantity`	integer	não
`products[].price`	number	sim
`products[].physical`	boolean	não
`splits`	array	não
`splits[].producerId`	string	sim	ID da conta Auryon que recebe
`splits[].amount`	number	sim	Valor em reais
`dueDate`	string	não
`metadata`	object (map) \	string	não
`callbackUrl`	string	não
`client`	object	sim
`client.name`	string	sim
`client.email`	string	sim
`client.phone`	string	não
`client.document`	string	não
`client.address`	object	não
`client.address.country`	string	sim	País, ISO 3166-1 alpha-2
`client.address.zipCode`	string	sim
`client.address.state`	string	sim	UF, ex.: SP
`client.address.city`	string	sim
`client.address.street`	string	sim
`client.address.neighborhood`	string	sim
`client.address.number`	string	sim
`client.address.complement`	string	não

Resposta 200

Campo	Tipo	Obrigatório	Descrição
`transactionId`	string	sim
`status`	`OK` · `FAILED` · `PENDING`	sim
`transactionStatus`	`PENDING` · `COMPLETED` · `FAILED`	sim
`webhookToken`	string	não	Devolvido quando callbackUrl é informado
`fee`	number	sim	Valor em reais
`order`	object	sim
`order.id`	string	sim
`order.url`	string	não
`errorDescription`	string	não
`pix`	object	sim
`pix.code`	string	sim
`pix.image`	string	não
`pix.base64`	`""`	sim	Sempre vazio — renderize o QR a partir de `code`
`pix.expiresAt`	string	não

Erros possíveis: 400 · 401 · 403 · 409 · 429 · 503

POST /api/v1/gateway/boleto/receive

Receber boleto · Depreciada

Repetir o mesmo identifier com o mesmo pedido devolve a MESMA transação; com outro valor ou outra forma de pagamento, responde 409 GATEWAY_FAILED_PRECONDITION.

Permissão: PRODUCER_TRANSACTIONS

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`identifier`	string	sim	Único por transação — é a chave de idempotência
`amount`	number	sim	Valor em reais (mín. 0.01)
`shippingFee`	number	não
`extraFee`	number	não
`discount`	number	não
`products`	array	não
`products[].id`	string	sim
`products[].name`	string	sim
`products[].quantity`	integer	não
`products[].price`	number	sim
`products[].physical`	boolean	não
`splits`	array	não
`splits[].producerId`	string	sim	ID da conta Auryon que recebe
`splits[].amount`	number	sim	Valor em reais
`dueDate`	string	não
`metadata`	object (map) \	string	não
`callbackUrl`	string	não
`client`	object	sim
`client.name`	string	sim
`client.email`	string	sim
`client.phone`	string	não
`client.document`	string	não
`client.address`	object	sim
`client.address.country`	string	sim	País, ISO 3166-1 alpha-2
`client.address.zipCode`	string	sim
`client.address.state`	string	sim	UF, ex.: SP
`client.address.city`	string	sim
`client.address.street`	string	sim
`client.address.neighborhood`	string	sim
`client.address.number`	string	sim
`client.address.complement`	string	não

Resposta 200

Campo	Tipo	Obrigatório	Descrição
`transactionId`	string	sim
`status`	`OK` · `FAILED` · `PENDING`	sim
`transactionStatus`	`PENDING` · `COMPLETED` · `FAILED`	sim
`webhookToken`	string	não	Devolvido quando callbackUrl é informado
`fee`	number	sim	Valor em reais
`order`	object	sim
`order.id`	string	sim
`order.url`	string	não
`errorDescription`	string	não
`boleto`	object	sim
`boleto.barcode`	string	sim
`boleto.digitableLine`	string	sim
`boleto.pdfUrl`	string	não

Erros possíveis: 400 · 401 · 403 · 409 · 429 · 503

POST /api/v1/gateway/crypto/receive

Receber cripto (BDM Digital) · Depreciada

A Auryon recebe cripto em BDM Digital: crypto.currency deve ser “BDM”. Repetir o mesmo identifier com o mesmo pedido devolve a MESMA transação; com outro valor ou outra forma de pagamento, responde 409 GATEWAY_FAILED_PRECONDITION.

Permissão: PRODUCER_TRANSACTIONS

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`identifier`	string	sim	Único por transação — é a chave de idempotência
`amount`	number	sim	Valor em reais (mín. 0.01)
`shippingFee`	number	não
`extraFee`	number	não
`discount`	number	não
`products`	array	não
`products[].id`	string	sim
`products[].name`	string	sim
`products[].quantity`	integer	não
`products[].price`	number	sim
`products[].physical`	boolean	não
`splits`	array	não
`splits[].producerId`	string	sim	ID da conta Auryon que recebe
`splits[].amount`	number	sim	Valor em reais
`dueDate`	string	não
`metadata`	object (map) \	string	não
`callbackUrl`	string	não
`client`	object	sim
`client.name`	string	sim
`client.email`	string	sim
`client.phone`	string	não
`client.document`	string	não
`client.address`	object	não
`client.address.country`	string	sim	País, ISO 3166-1 alpha-2
`client.address.zipCode`	string	sim
`client.address.state`	string	sim	UF, ex.: SP
`client.address.city`	string	sim
`client.address.street`	string	sim
`client.address.neighborhood`	string	sim
`client.address.number`	string	sim
`client.address.complement`	string	não
`crypto`	object	sim
`crypto.currency`	string	sim
`crypto.network`	string	sim

Resposta 200

Campo	Tipo	Obrigatório	Descrição
`transactionId`	string	sim
`status`	`OK` · `FAILED` · `PENDING`	sim
`transactionStatus`	`PENDING` · `COMPLETED` · `FAILED`	sim
`webhookToken`	string	não	Devolvido quando callbackUrl é informado
`fee`	number	sim	Valor em reais
`order`	object	sim
`order.id`	string	sim
`order.url`	string	não
`errorDescription`	string	não
`qr`	object	sim
`qr.code`	string	sim
`qr.image`	string	não

Erros possíveis: 400 · 401 · 403 · 409 · 429 · 503

POST /api/v1/gateway/card/receive

⛔ Cartão pela API — RECUSADO · Depreciada

A Auryon NÃO recebe dados de cartão pela API (PCI-DSS). Esta rota responde sempre 400 GATEWAY_FAILED_PRECONDITION e não lê o corpo. Use POST /gateway/checkout e redirecione o comprador.

Permissão: nenhuma (sem credencial)

Resposta 400

Campo	Tipo	Obrigatório
`statusCode`	number	sim
`errorCode`	string	sim
`message`	string	sim
`details`	any	não

Erros possíveis: 429 · 503

POST /api/v1/gateway/card/subscription

⛔ Assinatura no cartão pela API — RECUSADO · Depreciada

Mesma recusa do card/receive. Use uma oferta recorrente no checkout.

Permissão: nenhuma (sem credencial)

Resposta 400

Campo	Tipo	Obrigatório
`statusCode`	number	sim
`errorCode`	string	sim
`message`	string	sim
`details`	any	não

Erros possíveis: 429 · 503

POST /api/v1/gateway/pix/subscription

Assinatura em PIX · Depreciada

Cada ciclo emite uma cobrança nova e o comprador paga. ⚠️ periodicityType: DAYS e firstChargeIn > 0 não são suportados. Repetir o mesmo identifier com o mesmo pedido devolve a MESMA transação; com outro valor ou outra forma de pagamento, responde 409 GATEWAY_FAILED_PRECONDITION.

Permissão: PRODUCER_TRANSACTIONS

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`identifier`	string	sim
`amount`	number	sim	Valor de cada cobrança, em reais
`product`	object	sim
`product.id`	string	sim
`product.name`	string	sim
`product.price`	number	não
`subscription`	object	sim
`subscription.periodicityType`	`DAYS` · `WEEKS` · `MONTHS` · `YEARS`	sim
`subscription.periodicity`	integer	sim
`subscription.firstChargeIn`	integer	não
`client`	object	sim
`client.name`	string	sim
`client.email`	string	sim
`client.phone`	string	não
`client.document`	string	não
`client.address`	object	não
`client.address.country`	string	sim	País, ISO 3166-1 alpha-2
`client.address.zipCode`	string	sim
`client.address.state`	string	sim	UF, ex.: SP
`client.address.city`	string	sim
`client.address.street`	string	sim
`client.address.neighborhood`	string	sim
`client.address.number`	string	sim
`client.address.complement`	string	não
`dueDate`	string	não
`metadata`	object (map) \	string	não
`callbackUrl`	string	não
`crypto`	object	não
`crypto.currency`	string	sim
`crypto.network`	string	sim

Resposta 200

Campo	Tipo	Obrigatório	Descrição
`transactionId`	string	sim
`status`	`OK` · `FAILED` · `PENDING`	sim
`transactionStatus`	`PENDING` · `COMPLETED` · `FAILED`	sim
`webhookToken`	string	não
`fee`	number	sim	Valor em reais
`order`	object	sim
`order.id`	string	sim
`order.url`	string	não
`pix`	object (map)	não
`qr`	object (map)	não
`subscription`	object	sim
`subscription.id`	string	sim
`subscription.periodicity`	number	sim
`subscription.periodicityType`	`WEEKS` · `MONTHS` · `YEARS`	sim
`subscription.nextChargeAt`	string \	null	sim
`subscription.startAt`	string	sim
`subscription.status`	`ACTIVE` · `INACTIVE` · `CANCELED`	sim

Erros possíveis: 400 · 401 · 403 · 409 · 429 · 503

POST /api/v1/gateway/crypto/subscription

Assinatura em cripto (BDM Digital) · Depreciada

Repetir o mesmo identifier com o mesmo pedido devolve a MESMA transação; com outro valor ou outra forma de pagamento, responde 409 GATEWAY_FAILED_PRECONDITION.

Permissão: PRODUCER_TRANSACTIONS

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`identifier`	string	sim
`amount`	number	sim	Valor de cada cobrança, em reais
`product`	object	sim
`product.id`	string	sim
`product.name`	string	sim
`product.price`	number	não
`subscription`	object	sim
`subscription.periodicityType`	`DAYS` · `WEEKS` · `MONTHS` · `YEARS`	sim
`subscription.periodicity`	integer	sim
`subscription.firstChargeIn`	integer	não
`client`	object	sim
`client.name`	string	sim
`client.email`	string	sim
`client.phone`	string	não
`client.document`	string	não
`client.address`	object	não
`client.address.country`	string	sim	País, ISO 3166-1 alpha-2
`client.address.zipCode`	string	sim
`client.address.state`	string	sim	UF, ex.: SP
`client.address.city`	string	sim
`client.address.street`	string	sim
`client.address.neighborhood`	string	sim
`client.address.number`	string	sim
`client.address.complement`	string	não
`dueDate`	string	não
`metadata`	object (map) \	string	não
`callbackUrl`	string	não
`crypto`	object	não
`crypto.currency`	string	sim
`crypto.network`	string	sim

Resposta 200

Campo	Tipo	Obrigatório	Descrição
`transactionId`	string	sim
`status`	`OK` · `FAILED` · `PENDING`	sim
`transactionStatus`	`PENDING` · `COMPLETED` · `FAILED`	sim
`webhookToken`	string	não
`fee`	number	sim	Valor em reais
`order`	object	sim
`order.id`	string	sim
`order.url`	string	não
`pix`	object (map)	não
`qr`	object (map)	não
`subscription`	object	sim
`subscription.id`	string	sim
`subscription.periodicity`	number	sim
`subscription.periodicityType`	`WEEKS` · `MONTHS` · `YEARS`	sim
`subscription.nextChargeAt`	string \	null	sim
`subscription.startAt`	string	sim
`subscription.status`	`ACTIVE` · `INACTIVE` · `CANCELED`	sim

Erros possíveis: 400 · 401 · 403 · 409 · 429 · 503

POST /api/v1/gateway/pix/deposit

Depósito PIX no saldo — não disponível (501) · Depreciada

Permissão: nenhuma (sem credencial)

Resposta 429

any

Erros possíveis: 501 · 503

POST /api/v1/gateway/checkout

Criar checkout (o caminho do CARTÃO) · Depreciada

Cria (ou reusa, pelo product.externalId) produto e oferta e devolve o link. ⚠️ offer.price em REAIS. Produto ainda não aprovado (sua conta não aprova automaticamente) responde 409 GATEWAY_FAILED_PRECONDITION com details.productId e details.approvalStatus, sem criar oferta: chame de novo depois da aprovação.

Permissão: PRODUCER_CHECKOUT

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
`product`	object	sim
`product.externalId`	string	sim
`product.name`	string	sim
`product.photos`	array	não
`product.offer`	object	sim
`product.offer.name`	string	sim
`product.offer.price`	number	sim	Preço em reais
`product.offer.offerType`	`INTERNATIONAL` · `NATIONAL` · `UNDEFINED`	sim
`product.offer.currency`	string	não
`product.offer.lang`	string	não
`product.offer.warranty`	string	não
`product.offer.type`	string	não
`product.offer.category`	string	não
`settings`	object	sim
`settings.paymentMethods`	array<`PIX` · `CREDIT_CARD` · `BOLETO` · `CRYPTO` · `CASH_ON_DELIVERY` · `GOOGLE_PAY` · `APPLE_PAY`>	não
`settings.acceptedDocs`	array<`CPF` · `CNPJ`>	não
`settings.thankYouPage`	string	não
`settings.askForAddress`	boolean	sim
`settings.colors`	object (map)	não
`customer`	object	não
`customer.name`	string	não
`customer.email`	string	não
`customer.phone`	string	não
`customer.document`	string	não
`customer.address`	object (map)	não
`trackProps`	object (map)	não

Resposta 200

Campo	Tipo	Obrigatório
`productId`	string	sim
`offerCode`	string	sim
`checkoutUrl`	string	sim

Erros possíveis: 400 · 401 · 403 · 409 · 429 · 503

GET /api/v1/utils/exchange-rates

Taxas de câmbio · Depreciada

Permissão: nenhuma (sem credencial)

Parâmetros de consulta

Nome	Obrigatório	Descrição
`from`	sim
`to`	sim
`amount`	sim

Resposta 200

Campo	Tipo	Obrigatório	Descrição
`convertedAmount`	number	sim
`exchangeRate`	number	sim

Erros possíveis: 400 · 429 · 503