API v1 reference

v1 is read-only. To create charges through the API, use the legacy API until creation arrives in v1. There is no card through the API: the card is typed in Auryon’s checkout.

This page is generated from the OpenAPI specification, which is in turn generated from the API code. Descriptions come from the code and are translated here. OpenAPI 3.1 specification to download: openapi-v1.json

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

GET /v1/ping

Status

Permission: none (no credential)

Response 200

Field	Type	Required	Description
ok	boolean	yes
service	string	yes
version	string	yes

Possible errors: 429 · 503

GET /v1/credentials

Test credentials

Permission: PRODUCER_DATA

Response 200

Field	Type	Required	Description
seller_id	string	yes
permissions	array	yes

Possible errors: 400 · 401 · 403 · 429 · 503

GET /v1/me

The account that owns the key

Permission: PRODUCER_DATA

Response 200

Field	Type	Required	Description
id	string	yes
name	string \	null	yes
legal_name	string \	null	yes
email	string	yes
status	string	yes
created_at	string	yes

Possible errors: 400 · 401 · 403 · 429 · 503

GET /v1/balance

Balance PER CURRENCY

Permission: PRODUCER_DATA

Response 200

Field	Type	Required	Description
balances	array	yes
balances[].currency	string	yes
balances[].available	string	yes	Currency minor unit, as a string (e.g. “19900” = R$ 199.00)
balances[].pending	string	yes	Currency minor unit, as a string (e.g. “19900” = R$ 199.00)
balances[].reserved	string	yes	Currency minor unit, as a string (e.g. “19900” = R$ 199.00)
balances[].blocked	string	yes	Currency minor unit, as a string (e.g. “19900” = R$ 199.00)
balances[].withdrawing	string	yes	Currency minor unit, as a string (e.g. “19900” = R$ 199.00)

Possible errors: 400 · 401 · 403 · 429 · 503

GET /v1/transactions

List sales

Permission: PRODUCER_TRANSACTIONS

Query parameters

Name	Required	Description
page	no	Page (1…)
page_size	no	Items per page (max. 100 — the server caps it)
identifier	no	Filter by your identifier

Response 200

Field	Type	Required	Description
items	array	yes
items[].id	string	yes
items[].status	string	yes
items[].amount	string	yes	Currency minor unit, as a string (e.g. “19900” = R$ 199.00)
items[].currency	string	yes
items[].payment_method	string \	null	yes
items[].installments	number	yes
items[].identifier	string \	null	yes
items[].metadata	any	yes
items[].offer_code	string	yes
items[].product	object	yes
items[].product.name	string	yes
items[].offer	object	yes
items[].offer.name	string	yes
items[].customer	object	yes
items[].customer.name	string	yes
items[].customer.email	string	yes
items[].created_at	string	yes
items[].paid_at	string \	null	yes
items[].refunded_at	string \	null	yes
page	number	yes
page_size	number	yes
total	number	yes

Possible errors: 400 · 401 · 403 · 429 · 503

GET /v1/transactions/{id}

One sale

Permission: PRODUCER_TRANSACTIONS

Query parameters

Name	Required	Description
id	yes

Response 200

Field	Type	Required	Description
id	string	yes
status	string	yes
amount	string	yes	Currency minor unit, as a string (e.g. “19900” = R$ 199.00)
currency	string	yes
payment_method	string \	null	yes
installments	number	yes
identifier	string \	null	yes
metadata	any	yes
offer_code	string	yes
product	object	yes
product.name	string	yes
offer	object	yes
offer.name	string	yes
customer	object	yes
customer.name	string	yes
customer.email	string	yes
created_at	string	yes
paid_at	string \	null	yes
refunded_at	string \	null	yes

Possible errors: 401 · 403 · 404 · 429 · 503

GET /v1/subscriptions

List subscriptions

Permission: PRODUCER_TRANSACTIONS

Query parameters

Name	Required	Description
page	no	Page (1…)
page_size	no	Items per page (max. 100 — the server caps it)

Response 200

Field	Type	Required	Description
items	array	yes
items[].id	string	yes
items[].status	string	yes
items[].interval	number	yes
items[].recurrence_type	string	yes
items[].amount	string	yes	Currency minor unit, as a string (e.g. “19900” = R$ 199.00)
items[].currency	string	yes
items[].product	object	yes
items[].product.name	string	yes
items[].customer	object	yes
items[].customer.name	string	yes
items[].customer.email	string	yes
items[].cycle	number	yes
items[].next_charge_at	string \	null	yes
items[].canceled_at	string \	null	yes
items[].created_at	string	yes
page	number	yes
page_size	number	yes
total	number	yes

Possible errors: 400 · 401 · 403 · 429 · 503

GET /v1/transfers

List withdrawals

Permission: PRODUCER_WITHDRAWS

Query parameters

Name	Required	Description
page	no	Page (1…)
page_size	no	Items per page (max. 100 — the server caps it)

Response 200

Field	Type	Required	Description
items	array	yes
items[].id	string	yes
items[].status	string	yes
items[].amount	string	yes	Currency minor unit, as a string (e.g. “19900” = R$ 199.00)
items[].currency	string	yes
items[].external_reference	string \	null	yes
items[].created_at	string	yes
items[].paid_at	string \	null	yes
page	number	yes
page_size	number	yes
total	number	yes

Possible errors: 400 · 401 · 403 · 429 · 503