Referência da API v1

A v1 é só de consulta. Para criar cobranças pela API, use a API legada enquanto a criação na v1 não chega. Cartão pela API não existe: o cartão é digitado no checkout da Auryon.

Esta página é gerada da especificação OpenAPI, que por sua vez é gerada do código da API. Especificação OpenAPI 3.1 para baixar: openapi-v1.json

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

GET /v1/ping

Status

Permissão: nenhuma (sem credencial)

Resposta 200

Campo	Tipo	Obrigatório	Descrição
ok	boolean	sim
service	string	sim
version	string	sim

Erros possíveis: 429 · 503

GET /v1/credentials

Testar credenciais

Permissão: PRODUCER_DATA

Resposta 200

Campo	Tipo	Obrigatório	Descrição
seller_id	string	sim
permissions	array	sim

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

GET /v1/me

A conta dona da chave

Permissão: PRODUCER_DATA

Resposta 200

Campo	Tipo	Obrigatório	Descrição
id	string	sim
name	string \	null	sim
legal_name	string \	null	sim
email	string	sim
status	string	sim
created_at	string	sim

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

GET /v1/balance

Saldo POR MOEDA

Permissão: PRODUCER_DATA

Resposta 200

Campo	Tipo	Obrigatório	Descrição
balances	array	sim
balances[].currency	string	sim
balances[].available	string	sim	Menor unidade da moeda, como string (ex.: “19900” = R$ 199,00)
balances[].pending	string	sim	Menor unidade da moeda, como string (ex.: “19900” = R$ 199,00)
balances[].reserved	string	sim	Menor unidade da moeda, como string (ex.: “19900” = R$ 199,00)
balances[].blocked	string	sim	Menor unidade da moeda, como string (ex.: “19900” = R$ 199,00)
balances[].withdrawing	string	sim	Menor unidade da moeda, como string (ex.: “19900” = R$ 199,00)

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

GET /v1/transactions

Listar vendas

Permissão: PRODUCER_TRANSACTIONS

Parâmetros de consulta

Nome	Obrigatório	Descrição
page	não	Página (1…)
page_size	não	Itens por página (máx. 100 — o servidor limita)
identifier	não	Filtrar pelo seu identifier

Resposta 200

Campo	Tipo	Obrigatório	Descrição
items	array	sim
items[].id	string	sim
items[].status	string	sim
items[].amount	string	sim	Menor unidade da moeda, como string (ex.: “19900” = R$ 199,00)
items[].currency	string	sim
items[].payment_method	string \	null	sim
items[].installments	number	sim
items[].identifier	string \	null	sim
items[].metadata	any	sim
items[].offer_code	string	sim
items[].product	object	sim
items[].product.name	string	sim
items[].offer	object	sim
items[].offer.name	string	sim
items[].customer	object	sim
items[].customer.name	string	sim
items[].customer.email	string	sim
items[].created_at	string	sim
items[].paid_at	string \	null	sim
items[].refunded_at	string \	null	sim
page	number	sim
page_size	number	sim
total	number	sim

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

GET /v1/transactions/{id}

Uma venda

Permissão: PRODUCER_TRANSACTIONS

Parâmetros de consulta

Nome	Obrigatório	Descrição
id	sim

Resposta 200

Campo	Tipo	Obrigatório	Descrição
id	string	sim
status	string	sim
amount	string	sim	Menor unidade da moeda, como string (ex.: “19900” = R$ 199,00)
currency	string	sim
payment_method	string \	null	sim
installments	number	sim
identifier	string \	null	sim
metadata	any	sim
offer_code	string	sim
product	object	sim
product.name	string	sim
offer	object	sim
offer.name	string	sim
customer	object	sim
customer.name	string	sim
customer.email	string	sim
created_at	string	sim
paid_at	string \	null	sim
refunded_at	string \	null	sim

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

GET /v1/subscriptions

Listar assinaturas

Permissão: PRODUCER_TRANSACTIONS

Parâmetros de consulta

Nome	Obrigatório	Descrição
page	não	Página (1…)
page_size	não	Itens por página (máx. 100 — o servidor limita)

Resposta 200

Campo	Tipo	Obrigatório	Descrição
items	array	sim
items[].id	string	sim
items[].status	string	sim
items[].interval	number	sim
items[].recurrence_type	string	sim
items[].amount	string	sim	Menor unidade da moeda, como string (ex.: “19900” = R$ 199,00)
items[].currency	string	sim
items[].product	object	sim
items[].product.name	string	sim
items[].customer	object	sim
items[].customer.name	string	sim
items[].customer.email	string	sim
items[].cycle	number	sim
items[].next_charge_at	string \	null	sim
items[].canceled_at	string \	null	sim
items[].created_at	string	sim
page	number	sim
page_size	number	sim
total	number	sim

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

GET /v1/transfers

Listar saques

Permissão: PRODUCER_WITHDRAWS

Parâmetros de consulta

Nome	Obrigatório	Descrição
page	não	Página (1…)
page_size	não	Itens por página (máx. 100 — o servidor limita)

Resposta 200

Campo	Tipo	Obrigatório	Descrição
items	array	sim
items[].id	string	sim
items[].status	string	sim
items[].amount	string	sim	Menor unidade da moeda, como string (ex.: “19900” = R$ 199,00)
items[].currency	string	sim
items[].external_reference	string \	null	sim
items[].created_at	string	sim
items[].paid_at	string \	null	sim
page	number	sim
page_size	number	sim
total	number	sim

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