BrotasPay — Referência da API

Introduction

API REST do BrotasPay: carteira digital de pagamento com Pix, TED, boleto, cartões, onboarding PF/PJ e integrações.

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

Esta é a referência completa da API pública do BrotasPay — carteira digital de pagamento brasileira (CNPJ 46.186.761/0001-80). Use-a para integrar sua aplicação à nossa infraestrutura de pagamentos: Pix, TED, boleto, cartões, onboarding PF/PJ e mais.

Navegue pelos endpoints no menu lateral esquerdo. Em cada endpoint você encontra exemplos de requisição em cURL e JavaScript, o corpo JSON esperado e as possíveis respostas. Use o botão Send Request 💥 pra testar direto no navegador.

Autenticação: todas as requisições protegidas usam Bearer Token via Laravel Sanctum — obtenha seu token em POST /api/v1/auth/login e envie no header Authorization: Bearer <token>.

Base URL: https://api.brotaspay.com.br Versão atual: v1 Formato: JSON (UTF-8)

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {SEU_TOKEN}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

Obtenha seu token fazendo login em POST /api/v1/auth/login (portal) ou POST /api/v1/admin/auth/login (admin). Envie o token no header Authorization: Bearer <token>.

Admin · 2FA

Setup e gerenciamento de 2FA (TOTP) para admins.

Status do 2FA do admin atual.

GET

https://api.brotaspay.com.br

/api/v1/admin/2fa/status

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/2fa/status" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Gera um novo secret e devolve o otpauth URL para o app autenticador.

POST

https://api.brotaspay.com.br

/api/v1/admin/2fa/setup

requires authentication

Não persiste como ativo enquanto enable() não validar um código.

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/2fa/setup" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Ativa o 2FA validando um código TOTP gerado pelo app autenticador.

POST

https://api.brotaspay.com.br

/api/v1/admin/2fa/enable

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

code

string

required

Must be 6 characters.

Example:

bngzmi

Auth

Bearer

Headers

Body

{ "code": "bngzmi" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/2fa/enable" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"bngzmi\"
}"

Desativa o 2FA exigindo senha + código TOTP atual.

POST

https://api.brotaspay.com.br

/api/v1/admin/2fa/disable

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

password

string

required

Example:

|]|{+-

code

string

required

Must be 6 characters.

Example:

vdljni

Auth

Bearer

Headers

Body

{ "password": "|]|{+-", "code": "vdljni" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/2fa/disable" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"|]|{+-\",
    \"code\": \"vdljni\"
}"

Admin · AML/PLD

Alertas e regras de prevenção à lavagem de dinheiro.

Lista paginada de alertas com filtros.

GET

https://api.brotaspay.com.br

/api/v1/admin/aml/alerts

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

status

string

severity

string

rule_code

string

Must not be greater than 60 characters.

Example:

user_id

integer

Example:

start_date

string

Must be a valid date.

Example:

2026-06-27T15:12:23

end_date

string

Must be a valid date.

Example:

2026-06-27T15:12:23

per_page

integer

Must be at least 1. Must not be greater than 100.

Example:

page

integer

Must be at least 1.

Example:

Auth

Bearer

Headers

Body

{ "status": null, "severity": null, "rule_code": "b", "user_id": 16, "start_date": "2026-06-27T15:12:23", "end_date": "2026-06-27T15:12:23", "per_page": 22, "page": 67 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/aml/alerts" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"rule_code\": \"b\",
    \"user_id\": 16,
    \"start_date\": \"2026-06-27T15:12:23\",
    \"end_date\": \"2026-06-27T15:12:23\",
    \"per_page\": 22,
    \"page\": 67
}"

Example response:

GET api/v1/admin/aml/alerts/{id}

GET

https://api.brotaspay.com.br

/api/v1/admin/aml/alerts/{id}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the alert.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/aml/alerts/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Atualiza status do alerta (revisão pelo admin).

PATCH

https://api.brotaspay.com.br

/api/v1/admin/aml/alerts/{id}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the alert.

Example:

architecto

Body Parameters

status

string

required

Example:

architecto

review_notes

string

Must not be greater than 2000 characters.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "status": "architecto", "review_notes": "n" }

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/admin/aml/alerts/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"architecto\",
    \"review_notes\": \"n\"
}"

GET api/v1/admin/aml/rules

GET

https://api.brotaspay.com.br

/api/v1/admin/aml/rules

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/aml/rules" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

PATCH api/v1/admin/aml/rules/{id}

PATCH

https://api.brotaspay.com.br

/api/v1/admin/aml/rules/{id}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the rule.

Example:

architecto

Body Parameters

enabled

boolean

Example:

false

severity

string

params

object

Auth

Bearer

Headers

URL Parameters

Body

{ "enabled": false, "severity": null, "params": null }

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/admin/aml/rules/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"enabled\": false
}"

Dispara um scan manual.

POST

https://api.brotaspay.com.br

/api/v1/admin/aml/scan

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

days

integer

Must be at least 1. Must not be greater than 365.

Example:

Auth

Bearer

Headers

Body

{ "days": 1 }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/aml/scan" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"days\": 1
}"

Admin · Audit Log

Trilha de auditoria de ações destrutivas/sensíveis do admin.

GET api/v1/admin/audit

GET

https://api.brotaspay.com.br

/api/v1/admin/audit

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

action

string

Must not be greater than 60 characters.

Example:

resource_type

string

Must not be greater than 60 characters.

Example:

admin_user_id

integer

Example:

start_date

string

Must be a valid date.

Example:

2026-06-27T15:12:23

end_date

string

Must be a valid date.

Example:

2026-06-27T15:12:23

per_page

integer

Must be at least 1. Must not be greater than 100.

Example:

page

integer

Must be at least 1.

Example:

string

Must not be greater than 120 characters.

Example:

Auth

Bearer

Headers

Body

{ "action": "b", "resource_type": "n", "admin_user_id": 16, "start_date": "2026-06-27T15:12:23", "end_date": "2026-06-27T15:12:23", "per_page": 22, "page": 67, "q": "z" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/audit" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"action\": \"b\",
    \"resource_type\": \"n\",
    \"admin_user_id\": 16,
    \"start_date\": \"2026-06-27T15:12:23\",
    \"end_date\": \"2026-06-27T15:12:23\",
    \"per_page\": 22,
    \"page\": 67,
    \"q\": \"z\"
}"

Example response:

GET api/v1/admin/audit/actions

GET

https://api.brotaspay.com.br

/api/v1/admin/audit/actions

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/audit/actions" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Admin · Billing & MRR

KPIs financeiros baseados em account_plan_assignments (sombra local que vai sendo populada conforme changeUserPlan é chamado).

GET api/v1/admin/billing/overview

GET

https://api.brotaspay.com.br

/api/v1/admin/billing/overview

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/billing/overview" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/admin/billing/timeseries

GET

https://api.brotaspay.com.br

/api/v1/admin/billing/timeseries

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

days

integer

Must be at least 7. Must not be greater than 365.

Example:

Auth

Bearer

Headers

Body

{ "days": 1 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/billing/timeseries" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"days\": 1
}"

Example response:

Lista assignments (current + histórico) paginado.

GET

https://api.brotaspay.com.br

/api/v1/admin/billing/assignments

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

state

string

Must be one of:

active
ended
all

Example:

ended

plan_id

string

Must not be greater than 36 characters.

Example:

page

integer

Must be at least 1.

Example:

per_page

integer

Must be at least 1. Must not be greater than 100.

Example:

Auth

Bearer

Headers

Body

{ "state": "ended", "plan_id": "b", "page": 22, "per_page": 7 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/billing/assignments" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"state\": \"ended\",
    \"plan_id\": \"b\",
    \"page\": 22,
    \"per_page\": 7
}"

Example response:

Admin · Boletos

Gestão local de boletos (sombra). Inclui baixa manual e cancelamento com auditoria.

GET api/v1/admin/boletos

GET

https://api.brotaspay.com.br

/api/v1/admin/boletos

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

account_number

string

Must not be greater than 30 characters.

Example:

status

string

type

string

Must not be greater than 30 characters.

Example:

start_date

string

Must be a valid date.

Example:

2026-06-27T15:12:23

end_date

string

Must be a valid date.

Example:

2026-06-27T15:12:23

string

Must not be greater than 120 characters.

Example:

page

integer

Must be at least 1.

Example:

per_page

integer

Must be at least 1. Must not be greater than 100.

Example:

Auth

Bearer

Headers

Body

{ "account_number": "b", "status": null, "type": "n", "start_date": "2026-06-27T15:12:23", "end_date": "2026-06-27T15:12:23", "q": "g", "page": 66, "per_page": 17 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/boletos" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"account_number\": \"b\",
    \"type\": \"n\",
    \"start_date\": \"2026-06-27T15:12:23\",
    \"end_date\": \"2026-06-27T15:12:23\",
    \"q\": \"g\",
    \"page\": 66,
    \"per_page\": 17
}"

Example response:

GET api/v1/admin/boletos/{id}

GET

https://api.brotaspay.com.br

/api/v1/admin/boletos/{id}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the boleto.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/boletos/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

PATCH api/v1/admin/boletos/{id}/status

PATCH

https://api.brotaspay.com.br

/api/v1/admin/boletos/{id}/status

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the boleto.

Example:

architecto

Body Parameters

status

string

required

Example:

architecto

reason

string

required

Must not be greater than 500 characters.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "status": "architecto", "reason": "n" }

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/admin/boletos/architecto/status" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"architecto\",
    \"reason\": \"n\"
}"

Admin · Exportações

Streaming de CSV para os principais recursos. Não carrega tudo em memória — usa cursor() do Laravel.

GET api/v1/admin/export/manifest

GET

https://api.brotaspay.com.br

/api/v1/admin/export/manifest

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/export/manifest" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/admin/export/{resource}

GET

https://api.brotaspay.com.br

/api/v1/admin/export/{resource}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

resource

string

required

Example:

architecto

Body Parameters

start_date

string

Must be a valid date.

Example:

2026-06-27T15:12:23

end_date

string

Must be a valid date.

Example:

2026-06-27T15:12:23

limit

integer

Must be at least 1. Must not be greater than 100000.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "start_date": "2026-06-27T15:12:23", "end_date": "2026-06-27T15:12:23", "limit": 1 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/export/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-06-27T15:12:23\",
    \"end_date\": \"2026-06-27T15:12:23\",
    \"limit\": 1
}"

Example response:

Admin · Growth & Retenção

Métricas de produto: funil de ativação, churn, coortes e NPS. Todos os endpoints exigem autenticação admin (Bearer token).

Visão consolidada

GET

https://api.brotaspay.com.br

/api/v1/admin/growth/overview

requires authentication

Atalho que retorna funil + churn + NPS + coortes na mesma chamada para alimentar um dashboard único.

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

start_date

string

Must be a valid date. Must be a valid date in the format Y-m-d.

Example:

2026-06-27

end_date

string

Must be a valid date. Must be a valid date in the format Y-m-d. Must be a date after or equal to start_date.

Example:

2052-07-20

survey_tag

string

Must not be greater than 60 characters.

Example:

inactivity_days

integer

Must be at least 7. Must not be greater than 180.

Example:

window_days

integer

Must be at least 14. Must not be greater than 365.

Example:

months_back

integer

Must be at least 1. Must not be greater than 24.

Example:

Auth

Bearer

Headers

Body

{ "start_date": "2026-06-27", "end_date": "2052-07-20", "survey_tag": "n", "inactivity_days": 7, "window_days": 16, "months_back": 21 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/growth/overview" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-06-27\",
    \"end_date\": \"2052-07-20\",
    \"survey_tag\": \"n\",
    \"inactivity_days\": 7,
    \"window_days\": 16,
    \"months_back\": 21
}"

Example response:

Funil de ativação

GET

https://api.brotaspay.com.br

/api/v1/admin/growth/funnel

requires authentication

Retorna a contagem de usuários em cada etapa do funil (cadastro → KYC → conta ativa → primeiro depósito → primeira transação enviada).

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

start_date

string

date Data inicial (Y-m-d). Default: 30 dias atrás.

Example:

architecto

end_date

string

date Data final (Y-m-d). Default: hoje.

Example:

architecto

Body Parameters

start_date

string

Must be a valid date. Must be a valid date in the format Y-m-d.

Example:

2026-06-27

end_date

string

Must be a valid date. Must be a valid date in the format Y-m-d. Must be a date after or equal to start_date.

Example:

2052-07-20

survey_tag

string

Must not be greater than 60 characters.

Example:

inactivity_days

integer

Must be at least 7. Must not be greater than 180.

Example:

window_days

integer

Must be at least 14. Must not be greater than 365.

Example:

months_back

integer

Must be at least 1. Must not be greater than 24.

Example:

Auth

Bearer

Headers

Query Parameters

Body

{ "start_date": "2026-06-27", "end_date": "2052-07-20", "survey_tag": "n", "inactivity_days": 7, "window_days": 16, "months_back": 21 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/growth/funnel?start_date=architecto&end_date=architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-06-27\",
    \"end_date\": \"2052-07-20\",
    \"survey_tag\": \"n\",
    \"inactivity_days\": 7,
    \"window_days\": 16,
    \"months_back\": 21
}"

Example response:

Churn e retenção

GET

https://api.brotaspay.com.br

/api/v1/admin/growth/churn

requires authentication

Compara usuários ativos (com transação) na janela atual vs. janela anterior para identificar perda e retenção de base ativa.

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

inactivity_days

integer

Dias de inatividade que definem churn. Default: 30.

Example:

window_days

integer

Tamanho da janela de comparação. Default: 90.

Example:

Body Parameters

start_date

string

Must be a valid date. Must be a valid date in the format Y-m-d.

Example:

2026-06-27

end_date

string

Must be a valid date. Must be a valid date in the format Y-m-d. Must be a date after or equal to start_date.

Example:

2052-07-20

survey_tag

string

Must not be greater than 60 characters.

Example:

inactivity_days

integer

Must be at least 7. Must not be greater than 180.

Example:

window_days

integer

Must be at least 14. Must not be greater than 365.

Example:

months_back

integer

Must be at least 1. Must not be greater than 24.

Example:

Auth

Bearer

Headers

Query Parameters

Body

{ "start_date": "2026-06-27", "end_date": "2052-07-20", "survey_tag": "n", "inactivity_days": 7, "window_days": 16, "months_back": 21 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/growth/churn?inactivity_days=16&window_days=16" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-06-27\",
    \"end_date\": \"2052-07-20\",
    \"survey_tag\": \"n\",
    \"inactivity_days\": 7,
    \"window_days\": 16,
    \"months_back\": 21
}"

Example response:

Coortes de retenção semanal

GET

https://api.brotaspay.com.br

/api/v1/admin/growth/cohorts

requires authentication

Agrupa usuários pelo mês de cadastro e mostra a retenção semana a semana (% que voltou a transacionar em cada uma das 8 semanas seguintes).

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

months_back

integer

Quantos meses retroceder. Default: 6.

Example:

Body Parameters

start_date

string

Must be a valid date. Must be a valid date in the format Y-m-d.

Example:

2026-06-27

end_date

string

Must be a valid date. Must be a valid date in the format Y-m-d. Must be a date after or equal to start_date.

Example:

2052-07-20

survey_tag

string

Must not be greater than 60 characters.

Example:

inactivity_days

integer

Must be at least 7. Must not be greater than 180.

Example:

window_days

integer

Must be at least 14. Must not be greater than 365.

Example:

months_back

integer

Must be at least 1. Must not be greater than 24.

Example:

Auth

Bearer

Headers

Query Parameters

Body

{ "start_date": "2026-06-27", "end_date": "2052-07-20", "survey_tag": "n", "inactivity_days": 7, "window_days": 16, "months_back": 21 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/growth/cohorts?months_back=16" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-06-27\",
    \"end_date\": \"2052-07-20\",
    \"survey_tag\": \"n\",
    \"inactivity_days\": 7,
    \"window_days\": 16,
    \"months_back\": 21
}"

Example response:

NPS — Net Promoter Score

GET

https://api.brotaspay.com.br

/api/v1/admin/growth/nps

requires authentication

Score = %promotores (9-10) − %detratores (0-6). Lista também os 10 comentários mais recentes.

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

start_date

string

date Y-m-d.

Example:

architecto

end_date

string

date Y-m-d.

Example:

architecto

survey_tag

string

Filtra por tag da pesquisa (ex: post_onboarding).

Example:

architecto

Body Parameters

start_date

string

Must be a valid date. Must be a valid date in the format Y-m-d.

Example:

2026-06-27

end_date

string

Must be a valid date. Must be a valid date in the format Y-m-d. Must be a date after or equal to start_date.

Example:

2052-07-20

survey_tag

string

Must not be greater than 60 characters.

Example:

inactivity_days

integer

Must be at least 7. Must not be greater than 180.

Example:

window_days

integer

Must be at least 14. Must not be greater than 365.

Example:

months_back

integer

Must be at least 1. Must not be greater than 24.

Example:

Auth

Bearer

Headers

Query Parameters

Body

{ "start_date": "2026-06-27", "end_date": "2052-07-20", "survey_tag": "n", "inactivity_days": 7, "window_days": 16, "months_back": 21 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/growth/nps?start_date=architecto&end_date=architecto&survey_tag=architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-06-27\",
    \"end_date\": \"2052-07-20\",
    \"survey_tag\": \"n\",
    \"inactivity_days\": 7,
    \"window_days\": 16,
    \"months_back\": 21
}"

Example response:

Lista de respostas NPS

GET

https://api.brotaspay.com.br

/api/v1/admin/growth/nps/responses

requires authentication

Lista paginada de respostas NPS individuais para análise qualitativa.

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

start_date

string

Must be a valid date. Must be a valid date in the format Y-m-d.

Example:

2026-06-27

end_date

string

Must be a valid date. Must be a valid date in the format Y-m-d. Must be a date after or equal to start_date.

Example:

2052-07-20

survey_tag

string

Must not be greater than 60 characters.

Example:

inactivity_days

integer

Must be at least 7. Must not be greater than 180.

Example:

window_days

integer

Must be at least 14. Must not be greater than 365.

Example:

months_back

integer

Must be at least 1. Must not be greater than 24.

Example:

Auth

Bearer

Headers

Body

{ "start_date": "2026-06-27", "end_date": "2052-07-20", "survey_tag": "n", "inactivity_days": 7, "window_days": 16, "months_back": 21 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/growth/nps/responses" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-06-27\",
    \"end_date\": \"2052-07-20\",
    \"survey_tag\": \"n\",
    \"inactivity_days\": 7,
    \"window_days\": 16,
    \"months_back\": 21
}"

Example response:

Admin · Observabilidade

Health do sistema: jobs, filas, webhooks recebidos/processados, falhas recentes.

GET api/v1/admin/observability/overview

GET

https://api.brotaspay.com.br

/api/v1/admin/observability/overview

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/observability/overview" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/admin/observability/jobs/failed

GET

https://api.brotaspay.com.br

/api/v1/admin/observability/jobs/failed

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

queue

string

Must not be greater than 60 characters.

Example:

page

integer

Must be at least 1.

Example:

per_page

integer

Must be at least 1. Must not be greater than 100.

Example:

Auth

Bearer

Headers

Body

{ "queue": "b", "page": 22, "per_page": 7 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/observability/jobs/failed" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"queue\": \"b\",
    \"page\": 22,
    \"per_page\": 7
}"

Example response:

POST api/v1/admin/observability/jobs/failed/retry-all

POST

https://api.brotaspay.com.br

/api/v1/admin/observability/jobs/failed/retry-all

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/observability/jobs/failed/retry-all" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/admin/observability/jobs/failed/{uuid}/retry

POST

https://api.brotaspay.com.br

/api/v1/admin/observability/jobs/failed/{uuid}/retry

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

string

required

Example:

6ff8f7f6-1eb3-3525-be4a-3932c805afed

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/observability/jobs/failed/6ff8f7f6-1eb3-3525-be4a-3932c805afed/retry" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

DELETE api/v1/admin/observability/jobs/failed/{uuid}

DELETE

https://api.brotaspay.com.br

/api/v1/admin/observability/jobs/failed/{uuid}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uuid

string

required

Example:

6ff8f7f6-1eb3-3525-be4a-3932c805afed

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.brotaspay.com.br/api/v1/admin/observability/jobs/failed/6ff8f7f6-1eb3-3525-be4a-3932c805afed" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Série temporal diária (N dias) de webhooks: received vs forwarded vs failed deliveries.

GET

https://api.brotaspay.com.br

/api/v1/admin/observability/webhooks/timeseries

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

days

integer

Must be at least 1. Must not be greater than 90.

Example:

Auth

Bearer

Headers

Body

{ "days": 1 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/observability/webhooks/timeseries" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"days\": 1
}"

Example response:

Admin · Offboarding

Encerramentos de conta: visualiza evidências, registra fechamento legal final.

Fluxo:

Conta é encerrada operacionalmente (closed_at gravado por AccountController::close)
Time legal/compliance revisa as evidências e marca legally_closed_at

GET api/v1/admin/offboarding

GET

https://api.brotaspay.com.br

/api/v1/admin/offboarding

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

state

string

Must be one of:

pending_legal
fully_closed
all

Example:

all

string

Must not be greater than 120 characters.

Example:

start_date

string

Must be a valid date.

Example:

2026-06-27T15:12:23

end_date

string

Must be a valid date.

Example:

2026-06-27T15:12:23

page

integer

Must be at least 1.

Example:

per_page

integer

Must be at least 1. Must not be greater than 100.

Example:

Auth

Bearer

Headers

Body

{ "state": "all", "q": "b", "start_date": "2026-06-27T15:12:23", "end_date": "2026-06-27T15:12:23", "page": 22, "per_page": 7 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/offboarding" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"state\": \"all\",
    \"q\": \"b\",
    \"start_date\": \"2026-06-27T15:12:23\",
    \"end_date\": \"2026-06-27T15:12:23\",
    \"page\": 22,
    \"per_page\": 7
}"

Example response:

GET api/v1/admin/offboarding/{id}

GET

https://api.brotaspay.com.br

/api/v1/admin/offboarding/{id}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the offboarding.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/offboarding/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

POST api/v1/admin/offboarding/{id}/close-legally

POST

https://api.brotaspay.com.br

/api/v1/admin/offboarding/{id}/close-legally

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the offboarding.

Example:

architecto

Body Parameters

legal_notes

string

Must not be greater than 2000 characters.

Example:

force

boolean

Example:

true

Auth

Bearer

Headers

URL Parameters

Body

{ "legal_notes": "b", "force": true }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/offboarding/architecto/close-legally" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"legal_notes\": \"b\",
    \"force\": true
}"

POST api/v1/admin/offboarding/{id}/notes

POST

https://api.brotaspay.com.br

/api/v1/admin/offboarding/{id}/notes

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the offboarding.

Example:

architecto

Body Parameters

note

string

required

Must not be greater than 2000 characters.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "note": "b" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/offboarding/architecto/notes" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"note\": \"b\"
}"

Admin · Papéis & Permissões

GET api/v1/admin/roles

GET

https://api.brotaspay.com.br

/api/v1/admin/roles

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/roles" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

POST api/v1/admin/roles

POST

https://api.brotaspay.com.br

/api/v1/admin/roles

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

code

string

required

Must match the regex /^[a-z0-9_]+$/. Must not be greater than 60 characters.

Example:

name

string

required

Must not be greater than 120 characters.

Example:

description

string

Must not be greater than 500 characters.

Example:

Animi quos velit et fugiat.

permissions

string[]

Auth

Bearer

Headers

Body

{ "code": "b", "name": "n", "description": "Animi quos velit et fugiat.", "permissions": null }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/roles" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"b\",
    \"name\": \"n\",
    \"description\": \"Animi quos velit et fugiat.\"
}"

PATCH api/v1/admin/roles/{id}

PATCH

https://api.brotaspay.com.br

/api/v1/admin/roles/{id}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the role.

Example:

architecto

Body Parameters

name

string

Must not be greater than 120 characters.

Example:

description

string

Must not be greater than 500 characters.

Example:

Et animi quos velit et fugiat.

permissions

string[]

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "b", "description": "Et animi quos velit et fugiat.", "permissions": null }

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/admin/roles/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"b\",
    \"description\": \"Et animi quos velit et fugiat.\"
}"

DELETE api/v1/admin/roles/{id}

DELETE

https://api.brotaspay.com.br

/api/v1/admin/roles/{id}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the role.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.brotaspay.com.br/api/v1/admin/roles/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Sincroniza papéis de um admin (substitui o set).

PUT

https://api.brotaspay.com.br

/api/v1/admin/users/{userId}/roles

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

userId

integer

required

Example:

Body Parameters

role_ids

integer[]

The id of an existing record in the admin_roles table.

Example:

[16]

Auth

Bearer

Headers

URL Parameters

Body

{ "role_ids": [ 16 ] }

Received response

Example request:

curl --request PUT \
    "https://api.brotaspay.com.br/api/v1/admin/users/1/roles" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"role_ids\": [
        16
    ]
}"

Admin · Reconciliação

Histórico de reconciliações (consulta de webhooks falhados no core e reprocesso local) e disparo manual.

GET api/v1/admin/reconcile

GET

https://api.brotaspay.com.br

/api/v1/admin/reconcile

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

status

string

Must be one of:

running
success
failed
partial

Example:

running

page

integer

Must be at least 1.

Example:

per_page

integer

Must be at least 1. Must not be greater than 100.

Example:

Auth

Bearer

Headers

Body

{ "status": "running", "page": 16, "per_page": 22 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/reconcile" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"running\",
    \"page\": 16,
    \"per_page\": 22
}"

Example response:

GET api/v1/admin/reconcile/{id}

GET

https://api.brotaspay.com.br

/api/v1/admin/reconcile/{id}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the reconcile.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/reconcile/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Dispara `php artisan webhooks:reconcile --days=N [--dry-run]`.

POST

https://api.brotaspay.com.br

/api/v1/admin/reconcile/run

requires authentication

Síncrono — fica rodando até terminar.

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

days

integer

Must be at least 1. Must not be greater than 90.

Example:

dry_run

boolean

Example:

false

Auth

Bearer

Headers

Body

{ "days": 1, "dry_run": false }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/reconcile/run" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"days\": 1,
    \"dry_run\": false
}"

Admin · Search

Busca global (Cmd+K) — retorna resultados unificados de users, accounts, transactions e cards.

GET api/v1/admin/search

GET

https://api.brotaspay.com.br

/api/v1/admin/search

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Must be at least 2 characters. Must not be greater than 120 characters.

Example:

Auth

Bearer

Headers

Body

{ "q": "b" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/search" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"q\": \"b\"
}"

Example response:

Admin · Stats

Estatísticas agregadas para o dashboard administrativo.

Série temporal diária (transações + cadastros) nos últimos N dias.

GET

https://api.brotaspay.com.br

/api/v1/admin/stats/timeseries

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

days

integer

Janela em dias (1-365). Default: 30.

Example:

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/stats/timeseries?days=16" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Distribuições por categoria.

GET

https://api.brotaspay.com.br

/api/v1/admin/stats/distribution

requires authentication

Retorna contagens agregadas para uso em gráficos de barra/pizza:

Transações por event_name (top 10)
Contas por status
Usuários por type_account

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/stats/distribution" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Endpoints

GET api/v1/user

GET

https://api.brotaspay.com.br

/api/v1/user

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/user" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

POST api/v1/auth/register

POST

https://api.brotaspay.com.br

/api/v1/auth/register

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Must not be greater than 120 characters.

Example:

string

required

Must be a valid email address.

Example:

zbailey@example.net

document

string

required

Must be at least 11 characters. Must not be greater than 18 characters.

Example:

iyvdljnikhwaykcm

phone

string

Must not be greater than 20 characters.

Example:

yuwpwlvqwrsitcps

password

string

required

Must be at least 8 characters.

Example:

a:x&S$hSn7L'

commercial_name

string

Dados da subconta (opcionais; se completos, provisiona já). Must not be greater than 120 characters.

Example:

responsible_name

string

Must not be greater than 120 characters.

Example:

responsible_document

string

Must be at least 11 characters. Must not be greater than 14 characters.

Example:

xjklqppwqbewtn

responsible_birth_date

string

Must be a valid date in the format d/m/Y.

Example:

27/06/2026

responsible_phone

string

Must not be greater than 20 characters.

Example:

noqitpxntltcvipo

bank

object

code

string

This field is required when bank is present. Must not be greater than 5 characters.

Example:

account_type

string

This field is required when bank is present.

Must be one of:

CC
PP

Example:

agency

string

This field is required when bank is present. Must not be greater than 10 characters.

Example:

sausgi

agency_digit

string

Must not be greater than 2 characters.

Example:

account

string

This field is required when bank is present. Must not be greater than 20 characters.

Example:

lrbchgsrzyhcttwb

account_digit

string

Must not be greater than 2 characters.

Example:

address

object

zip_code

string

This field is required when address is present. Must not be greater than 9 characters.

Example:

kftmgos

street

string

This field is required when address is present. Must not be greater than 120 characters.

Example:

number

string

Must not be greater than 20 characters.

Example:

tvnbobmzezcrcval

district

string

This field is required when address is present. Must not be greater than 80 characters.

Example:

city

string

This field is required when address is present. Must not be greater than 80 characters.

Example:

state

string

This field is required when address is present. Must be 2 characters.

Example:

Auth

Bearer

Headers

Body

{ "name": "b", "email": "zbailey@example.net", "document": "iyvdljnikhwaykcm", "phone": "yuwpwlvqwrsitcps", "password": "a:x\u0026S$hSn7L'", "commercial_name": "v", "responsible_name": "l", "responsible_document": "xjklqppwqbewtn", "responsible_birth_date": "27\/06\/2026", "responsible_phone": "noqitpxntltcvipo", "bank": { "code": "j", "account_type": "PP", "agency": "sausgi", "agency_digit": "og", "account": "lrbchgsrzyhcttwb", "account_digit": "km" }, "address": { "zip_code": "kftmgos", "street": "g", "number": "tvnbobmzezcrcval", "district": "e", "city": "x", "state": "qz" } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/auth/register" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"b\",
    \"email\": \"zbailey@example.net\",
    \"document\": \"iyvdljnikhwaykcm\",
    \"phone\": \"yuwpwlvqwrsitcps\",
    \"password\": \"a:x&S$hSn7L\'\",
    \"commercial_name\": \"v\",
    \"responsible_name\": \"l\",
    \"responsible_document\": \"xjklqppwqbewtn\",
    \"responsible_birth_date\": \"27\\/06\\/2026\",
    \"responsible_phone\": \"noqitpxntltcvipo\",
    \"bank\": {
        \"code\": \"j\",
        \"account_type\": \"PP\",
        \"agency\": \"sausgi\",
        \"agency_digit\": \"og\",
        \"account\": \"lrbchgsrzyhcttwb\",
        \"account_digit\": \"km\"
    },
    \"address\": {
        \"zip_code\": \"kftmgos\",
        \"street\": \"g\",
        \"number\": \"tvnbobmzezcrcval\",
        \"district\": \"e\",
        \"city\": \"x\",
        \"state\": \"qz\"
    }
}"

POST

https://api.brotaspay.com.br

/api/v1/auth/local-login

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Example:

architecto

password

string

required

Example:

|]|{+-

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/auth/local-login" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"login\": \"architecto\",
    \"password\": \"|]|{+-\"
}"

POST

https://api.brotaspay.com.br

/api/v1/auth/login

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

document

string

required

Example:

architecto

password

string

required

Example:

|]|{+-

account_number

string

Example:

architecto

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/auth/login" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"document\": \"architecto\",
    \"password\": \"|]|{+-\",
    \"account_number\": \"architecto\"
}"

POST api/v1/auth/verify-2fa

POST

https://api.brotaspay.com.br

/api/v1/auth/verify-2fa

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

two_factor_token

string

required

Example:

architecto

code

string

required

Must be 6 characters.

Example:

ngzmiy

Auth

Bearer

Headers

Body

{ "two_factor_token": "architecto", "code": "ngzmiy" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/auth/verify-2fa" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"two_factor_token\": \"architecto\",
    \"code\": \"ngzmiy\"
}"

POST api/v1/auth/forgot-password

POST

https://api.brotaspay.com.br

/api/v1/auth/forgot-password

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

cpf

string

Example:

architecto

string

Example:

architecto

Auth

Bearer

Headers

Body

{ "cpf": "architecto", "login": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/auth/forgot-password" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"cpf\": \"architecto\",
    \"login\": \"architecto\"
}"

POST api/v1/auth/reset-password

POST

https://api.brotaspay.com.br

/api/v1/auth/reset-password

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

cpf

string

Example:

architecto

string

Example:

architecto

token

string

required

Example:

architecto

new_password

string

required

Must be at least 8 characters.

Example:

ngzmiyvdljnikhwaykcmyuwpwl

Auth

Bearer

Headers

Body

{ "cpf": "architecto", "login": "architecto", "token": "architecto", "new_password": "ngzmiyvdljnikhwaykcmyuwpwl" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/auth/reset-password" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"cpf\": \"architecto\",
    \"login\": \"architecto\",
    \"token\": \"architecto\",
    \"new_password\": \"ngzmiyvdljnikhwaykcmyuwpwl\"
}"

POST api/v1/auth/logout

POST

https://api.brotaspay.com.br

/api/v1/auth/logout

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/auth/logout" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/auth/2fa/enable

POST

https://api.brotaspay.com.br

/api/v1/auth/2fa/enable

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Must be a valid email address. Must not be greater than 255 characters.

Example:

gbailey@example.net

password

string

required

Example:

|]|{+-

Auth

Bearer

Headers

Body

{ "email": "gbailey@example.net", "password": "|]|{+-" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/auth/2fa/enable" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"gbailey@example.net\",
    \"password\": \"|]|{+-\"
}"

POST api/v1/auth/2fa/confirm

POST

https://api.brotaspay.com.br

/api/v1/auth/2fa/confirm

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

verification_token

string

required

Example:

architecto

code

string

required

Must be 6 characters.

Example:

ngzmiy

Auth

Bearer

Headers

Body

{ "verification_token": "architecto", "code": "ngzmiy" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/auth/2fa/confirm" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"verification_token\": \"architecto\",
    \"code\": \"ngzmiy\"
}"

POST api/v1/auth/2fa/disable

POST

https://api.brotaspay.com.br

/api/v1/auth/2fa/disable

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

password

string

required

Example:

|]|{+-

Auth

Bearer

Headers

Body

{ "password": "|]|{+-" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/auth/2fa/disable" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"|]|{+-\"
}"

GET api/v1/auth/2fa/status

GET

https://api.brotaspay.com.br

/api/v1/auth/2fa/status

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/auth/2fa/status" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET

https://api.brotaspay.com.br

/api/v1/auth/login-history

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/auth/login-history" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Status da conta de recebimento + dados bancários.

GET

https://api.brotaspay.com.br

/api/v1/portal/safe2pay/me

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/portal/safe2pay/me" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Saldo da carteira da subconta (disponível/em trânsito).

GET

https://api.brotaspay.com.br

/api/v1/portal/safe2pay/balance

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/portal/safe2pay/balance" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Extrato/repasses da subconta.

GET

https://api.brotaspay.com.br

/api/v1/portal/safe2pay/statement

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/portal/safe2pay/statement" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Cria uma cobrança PIX (recebimento) na subconta do cliente.

POST

https://api.brotaspay.com.br

/api/v1/portal/safe2pay/charges/pix

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

amount

number

required

Must be at least 0.01.

Example:

description

string

Must not be greater than 140 characters.

Example:

Et animi quos velit et fugiat.

reference

string

Must not be greater than 140 characters.

Example:

expiration

integer

Must be at least 60.

Example:

customer

object

name

string

required

Must not be greater than 120 characters.

Example:

document

string

required

Must be at least 11 characters. Must not be greater than 18 characters.

Example:

nikhwaykcmyuwpwl

string

Must be a valid email address.

Example:

wleuschke@example.net

Auth

Bearer

Headers

Body

{ "amount": 27, "description": "Et animi quos velit et fugiat.", "reference": "d", "expiration": 89, "customer": { "name": "j", "document": "nikhwaykcmyuwpwl", "email": "wleuschke@example.net" } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/portal/safe2pay/charges/pix" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"amount\": 27,
    \"description\": \"Et animi quos velit et fugiat.\",
    \"reference\": \"d\",
    \"expiration\": 89,
    \"customer\": {
        \"name\": \"j\",
        \"document\": \"nikhwaykcmyuwpwl\",
        \"email\": \"wleuschke@example.net\"
    }
}"

Cria um boleto na subconta do cliente.

POST

https://api.brotaspay.com.br

/api/v1/portal/safe2pay/charges/boleto

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

amount

number

required

Must be at least 0.01.

Example:

due_date

string

required

Must be a valid date in the format d/m/Y.

Example:

27/06/2026

description

string

Must not be greater than 140 characters.

Example:

Et animi quos velit et fugiat.

reference

string

Must not be greater than 140 characters.

Example:

customer

object

name

string

required

Must not be greater than 120 characters.

Example:

document

string

required

Must be at least 11 characters. Must not be greater than 18 characters.

Example:

jnikhwaykcmyuwpw

string

Must be a valid email address.

Example:

emelie.baumbach@example.net

address

object

Auth

Bearer

Headers

Body

{ "amount": 27, "due_date": "27\/06\/2026", "description": "Et animi quos velit et fugiat.", "reference": "d", "customer": { "name": "l", "document": "jnikhwaykcmyuwpw", "email": "emelie.baumbach@example.net", "address": null } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/portal/safe2pay/charges/boleto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"amount\": 27,
    \"due_date\": \"27\\/06\\/2026\",
    \"description\": \"Et animi quos velit et fugiat.\",
    \"reference\": \"d\",
    \"customer\": {
        \"name\": \"l\",
        \"document\": \"jnikhwaykcmyuwpw\",
        \"email\": \"emelie.baumbach@example.net\"
    }
}"

POST api/v1/pix/qrcode/static

POST

https://api.brotaspay.com.br

/api/v1/pix/qrcode/static

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

amount

number

required

Must be at least 0.

Example:

conciliation_id

string

required

Must not be greater than 25 characters.

Example:

recipient_name

string

Example:

architecto

addressing_key

object

location

object

Auth

Bearer

Headers

Body

{ "amount": 27, "conciliation_id": "n", "recipient_name": "architecto", "addressing_key": { "type": "architecto", "value": "architecto" }, "location": { "city": "architecto", "zip_code": "architecto" } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/pix/qrcode/static" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"amount\": 27,
    \"conciliation_id\": \"n\",
    \"recipient_name\": \"architecto\",
    \"addressing_key\": {
        \"type\": \"architecto\",
        \"value\": \"architecto\"
    },
    \"location\": {
        \"city\": \"architecto\",
        \"zip_code\": \"architecto\"
    }
}"

POST api/v1/pix/qrcode/dynamic

POST

https://api.brotaspay.com.br

/api/v1/pix/qrcode/dynamic

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

addressing_key

object

conciliation_id

string

required

Must be at least 26 characters. Must not be greater than 35 characters.

Example:

single_payment

boolean

required

Example:

true

amount

number

required

Must be at least 0.01.

Example:

change_amount_type

string

required

Must be one of:

ALLOWED
NOT_ALLOWED

Example:

NOT_ALLOWED

recipient_name

string

Example:

architecto

expires_at

string

Must be a valid date.

Example:

2026-06-27T15:12:22

payer

object

name

string

required

Example:

architecto

document_number

string

required

Example:

architecto

type

string

required

Must be one of:

CUSTOMER
BUSINESS

Example:

CUSTOMER

address

object

city

string

required

Example:

architecto

state

string

required

Example:

architecto

zip_code

string

required

Example:

architecto

address_line

string

required

Example:

architecto

neighborhood

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "addressing_key": { "type": "architecto", "value": "architecto" }, "conciliation_id": "n", "single_payment": true, "amount": 84, "change_amount_type": "NOT_ALLOWED", "recipient_name": "architecto", "expires_at": "2026-06-27T15:12:22", "payer": { "name": "architecto", "document_number": "architecto", "type": "CUSTOMER", "address": { "city": "architecto", "state": "architecto", "zip_code": "architecto", "address_line": "architecto", "neighborhood": "architecto" } } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/pix/qrcode/dynamic" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"addressing_key\": {
        \"type\": \"architecto\",
        \"value\": \"architecto\"
    },
    \"conciliation_id\": \"n\",
    \"single_payment\": true,
    \"amount\": 84,
    \"change_amount_type\": \"NOT_ALLOWED\",
    \"recipient_name\": \"architecto\",
    \"expires_at\": \"2026-06-27T15:12:22\",
    \"payer\": {
        \"name\": \"architecto\",
        \"document_number\": \"architecto\",
        \"type\": \"CUSTOMER\",
        \"address\": {
            \"city\": \"architecto\",
            \"state\": \"architecto\",
            \"zip_code\": \"architecto\",
            \"address_line\": \"architecto\",
            \"neighborhood\": \"architecto\"
        }
    }
}"

GET api/v1/plan

GET

https://api.brotaspay.com.br

/api/v1/plan

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/plan" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/notifications

GET

https://api.brotaspay.com.br

/api/v1/notifications

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/notifications" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/notifications/unread-count

GET

https://api.brotaspay.com.br

/api/v1/notifications/unread-count

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/notifications/unread-count" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

PATCH api/v1/notifications/{id}/read

PATCH

https://api.brotaspay.com.br

/api/v1/notifications/{id}/read

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the notification.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/notifications/architecto/read" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/notifications/read-all

POST

https://api.brotaspay.com.br

/api/v1/notifications/read-all

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/notifications/read-all" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Retorna o código de indicação do usuário atual (gera se ainda não tem) + estatísticas (total convidados, convertidos).

GET

https://api.brotaspay.com.br

/api/v1/referral

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/referral" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Aplica um código de indicação ao usuário atual.

POST

https://api.brotaspay.com.br

/api/v1/referral/apply

requires authentication

Só funciona se ainda não foi indicado e o código não é o dele mesmo.

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

code

string

required

Must not be greater than 16 characters.

Example:

bngzmiyvdljnikhw

Auth

Bearer

Headers

Body

{ "code": "bngzmiyvdljnikhw" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/referral/apply" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"bngzmiyvdljnikhw\"
}"

GET api/v1/integration

GET

https://api.brotaspay.com.br

/api/v1/integration

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/integration" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

POST api/v1/integration/activate

POST

https://api.brotaspay.com.br

/api/v1/integration/activate

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

password

string

required

Example:

|]|{+-

Auth

Bearer

Headers

Body

{ "password": "|]|{+-" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/integration/activate" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"|]|{+-\"
}"

PATCH api/v1/integration

PATCH

https://api.brotaspay.com.br

/api/v1/integration

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

webhook_url

string

required

Must be a valid URL. Must not be greater than 500 characters.

Example:

http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html

Auth

Bearer

Headers

Body

{ "webhook_url": "http:\/\/www.bailey.biz\/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html" }

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/integration" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"webhook_url\": \"http:\\/\\/www.bailey.biz\\/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html\"
}"

PATCH api/v1/integration/password

PATCH

https://api.brotaspay.com.br

/api/v1/integration/password

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

password

string

required

Example:

|]|{+-

Auth

Bearer

Headers

Body

{ "password": "|]|{+-" }

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/integration/password" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"|]|{+-\"
}"

POST api/v1/integration/rotate-key

POST

https://api.brotaspay.com.br

/api/v1/integration/rotate-key

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/integration/rotate-key" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

DELETE api/v1/integration

DELETE

https://api.brotaspay.com.br

/api/v1/integration

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request DELETE \
    "https://api.brotaspay.com.br/api/v1/integration" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

GET api/v1/integration/webhooks

GET

https://api.brotaspay.com.br

/api/v1/integration/webhooks

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/integration/webhooks" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

POST api/v1/integration/webhooks/{id}/retry

POST

https://api.brotaspay.com.br

/api/v1/integration/webhooks/{id}/retry

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the webhook.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/integration/webhooks/architecto/retry" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/payments/card

POST

https://api.brotaspay.com.br

/api/v1/payments/card

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

amount

number

required

Must be at least 0.01.

Example:

reference

string

required

Must not be greater than 200 characters.

Example:

description

string

Must not be greater than 200 characters.

Example:

Animi quos velit et fugiat.

installments

integer

Must be at least 1. Must not be greater than 12.

Example:

card_token

string

cartão cru OU token do cofre. This field is required when card.number is not present.

Example:

architecto

card

object

holder

string

This field is required when card_token is not present.

Example:

architecto

number

string

This field is required when card_token is not present.

Example:

architecto

expiration

string

This field is required when card_token is not present.

Example:

architecto

cvv

string

MM/AAAA.

Example:

architecto

customer

object

name

string

required

cliente.

Example:

architecto

document

string

required

Example:

architecto

string

Must be a valid email address.

Example:

zbailey@example.net

phone

string

Example:

architecto

address

object

Auth

Bearer

Headers

Body

{ "amount": 27, "reference": "n", "description": "Animi quos velit et fugiat.", "installments": 8, "card_token": "architecto", "card": { "holder": "architecto", "number": "architecto", "expiration": "architecto", "cvv": "architecto" }, "customer": { "name": "architecto", "document": "architecto", "email": "zbailey@example.net", "phone": "architecto", "address": null } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/payments/card" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"amount\": 27,
    \"reference\": \"n\",
    \"description\": \"Animi quos velit et fugiat.\",
    \"installments\": 8,
    \"card_token\": \"architecto\",
    \"card\": {
        \"holder\": \"architecto\",
        \"number\": \"architecto\",
        \"expiration\": \"architecto\",
        \"cvv\": \"architecto\"
    },
    \"customer\": {
        \"name\": \"architecto\",
        \"document\": \"architecto\",
        \"email\": \"zbailey@example.net\",
        \"phone\": \"architecto\"
    }
}"

POST api/v1/payments/card/tokenize

POST

https://api.brotaspay.com.br

/api/v1/payments/card/tokenize

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

card

object

holder

string

required

Example:

architecto

number

string

required

Example:

architecto

expiration

string

required

Example:

architecto

cvv

string

Example:

architecto

Auth

Bearer

Headers

Body

{ "card": { "holder": "architecto", "number": "architecto", "expiration": "architecto", "cvv": "architecto" } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/payments/card/tokenize" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"card\": {
        \"holder\": \"architecto\",
        \"number\": \"architecto\",
        \"expiration\": \"architecto\",
        \"cvv\": \"architecto\"
    }
}"

GET api/v1/banks

GET

https://api.brotaspay.com.br

/api/v1/banks

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

product

string

Must be one of:

TED
PIX
accountPortability

Example:

accountPortability

Auth

Bearer

Headers

Body

{ "product": "accountPortability" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/banks" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"product\": \"accountPortability\"
}"

Example response:

POST api/v1/boletos

POST

https://api.brotaspay.com.br

/api/v1/boletos

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

alias

string

Must not be greater than 255 characters.

Example:

account_number

string

required

Example:

architecto

account_branch

string

required

Example:

architecto

document_number

string

required

Must be at least 11 characters. Must not be greater than 14 characters.

Example:

ngzmiyvdljnikh

amount

number

required

Must be at least 0.01.

Example:

due_date

string

required

Must be a valid date in the format Y-m-d.

Example:

2026-06-27

close_payment

string

required

Must be a valid date in the format Y-m-d.

Example:

2026-06-27

type

string

required

Must be one of:

Levy
Deposit

Example:

Deposit

payer

object

document

string

This field is required when type is Levy. Must be at least 11 characters. Must not be greater than 14 characters.

Example:

aykcmyuwpwlvqw

name

string

This field is required when type is Levy. Must not be greater than 100 characters.

Example:

trade_name

string

Must not be greater than 100 characters.

Example:

address

object

zip_code

string

This field is required when type is Levy. Must be 8 characters.

Example:

itcpscql

address_line

string

This field is required when type is Levy. Must not be greater than 60 characters.

Example:

number

string

Must not be greater than 20 characters.

Example:

zsnrwtujwvlxjklq

neighborhood

string

This field is required when type is Levy. Must not be greater than 40 characters.

Example:

city

string

This field is required when type is Levy. Must not be greater than 40 characters.

Example:

state

string

This field is required when type is Levy. Must be 2 characters.

Example:

interest

object

fine

object

discount

object

Auth

Bearer

Headers

Body

{ "alias": "b", "account_number": "architecto", "account_branch": "architecto", "document_number": "ngzmiyvdljnikh", "amount": 87, "due_date": "2026-06-27", "close_payment": "2026-06-27", "type": "Deposit", "payer": { "document": "aykcmyuwpwlvqw", "name": "r", "trade_name": "s", "address": { "zip_code": "itcpscql", "address_line": "d", "number": "zsnrwtujwvlxjklq", "neighborhood": "p", "city": "p", "state": "wq" } }, "interest": { "start_date": "2026-06-27", "value": 4, "type": "FixedAmount" }, "fine": { "start_date": "2026-06-27", "value": 25, "type": "FixedAmount" }, "discount": { "limit_date": "2026-06-27", "value": 9, "type": "FixedPercentUntilLimitDate" } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/boletos" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"alias\": \"b\",
    \"account_number\": \"architecto\",
    \"account_branch\": \"architecto\",
    \"document_number\": \"ngzmiyvdljnikh\",
    \"amount\": 87,
    \"due_date\": \"2026-06-27\",
    \"close_payment\": \"2026-06-27\",
    \"type\": \"Deposit\",
    \"payer\": {
        \"document\": \"aykcmyuwpwlvqw\",
        \"name\": \"r\",
        \"trade_name\": \"s\",
        \"address\": {
            \"zip_code\": \"itcpscql\",
            \"address_line\": \"d\",
            \"number\": \"zsnrwtujwvlxjklq\",
            \"neighborhood\": \"p\",
            \"city\": \"p\",
            \"state\": \"wq\"
        }
    },
    \"interest\": {
        \"start_date\": \"2026-06-27\",
        \"value\": 4,
        \"type\": \"FixedAmount\"
    },
    \"fine\": {
        \"start_date\": \"2026-06-27\",
        \"value\": 25,
        \"type\": \"FixedAmount\"
    },
    \"discount\": {
        \"limit_date\": \"2026-06-27\",
        \"value\": 9,
        \"type\": \"FixedPercentUntilLimitDate\"
    }
}"

GET api/v1/boletos

GET

https://api.brotaspay.com.br

/api/v1/boletos

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

start_date

string

Must be a valid date in the format Y-m-d.

Example:

2026-06-27

end_date

string

Must be a valid date in the format Y-m-d.

Example:

2026-06-27

page

integer

Must be at least 1.

Example:

per_page

integer

Must be at least 1. Must not be greater than 100.

Example:

order_column

string

Must be one of:

createdAt
status

Example:

createdAt

order_direction

string

Must be one of:

ASC
DESC

Example:

ASC

payer_name

string

Must not be greater than 255 characters.

Example:

Auth

Bearer

Headers

Body

{ "start_date": "2026-06-27", "end_date": "2026-06-27", "page": 16, "per_page": 22, "order_column": "createdAt", "order_direction": "ASC", "payer_name": "g" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/boletos" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-06-27\",
    \"end_date\": \"2026-06-27\",
    \"page\": 16,
    \"per_page\": 22,
    \"order_column\": \"createdAt\",
    \"order_direction\": \"ASC\",
    \"payer_name\": \"g\"
}"

Example response:

GET api/v1/boletos/{authCode}

GET

https://api.brotaspay.com.br

/api/v1/boletos/{authCode}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

authCode

string

required

Example:

architecto

Body Parameters

account_branch

string

required

Example:

architecto

account_number

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "account_branch": "architecto", "account_number": "architecto" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/boletos/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"account_branch\": \"architecto\",
    \"account_number\": \"architecto\"
}"

Example response:

GET api/v1/boletos/{authCode}/print

GET

https://api.brotaspay.com.br

/api/v1/boletos/{authCode}/print

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

authCode

string

required

Example:

architecto

Body Parameters

account_branch

string

required

Example:

architecto

account_number

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "account_branch": "architecto", "account_number": "architecto" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/boletos/architecto/print" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"account_branch\": \"architecto\",
    \"account_number\": \"architecto\"
}"

Example response:

DELETE api/v1/boletos

DELETE

https://api.brotaspay.com.br

/api/v1/boletos

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

authentication_code

string

required

Example:

architecto

account_number

string

required

Example:

architecto

account_branch

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "authentication_code": "architecto", "account_number": "architecto", "account_branch": "architecto" }

Received response

Example request:

curl --request DELETE \
    "https://api.brotaspay.com.br/api/v1/boletos" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"authentication_code\": \"architecto\",
    \"account_number\": \"architecto\",
    \"account_branch\": \"architecto\"
}"

POST api/v1/webhooks/safe2pay/{integration}/{sig}

POST

https://api.brotaspay.com.br

/api/v1/webhooks/safe2pay/{integration}/{sig}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integration

string

required

Example:

564

sig

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/webhooks/safe2pay/564/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

GET api/v1/external/me

GET

https://api.brotaspay.com.br

/api/v1/external/me

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/external/me" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/external/plan

GET

https://api.brotaspay.com.br

/api/v1/external/plan

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/external/plan" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Status da subconta + dados bancários do recebedor.

GET

https://api.brotaspay.com.br

/api/v1/external/safe2pay/me

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/external/safe2pay/me" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Saldo da carteira da subconta (disponível/em trânsito/previsto).

GET

https://api.brotaspay.com.br

/api/v1/external/safe2pay/balance

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/external/safe2pay/balance" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Extrato/repasses da subconta (mês/ano opcionais).

GET

https://api.brotaspay.com.br

/api/v1/external/safe2pay/statement

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/external/safe2pay/statement" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Consulta uma transação por id (conciliação/sync).

GET

https://api.brotaspay.com.br

/api/v1/external/safe2pay/transactions/{id}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the transaction.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/external/safe2pay/transactions/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Consulta uma transação pelo Reference (conciliation_id do consumidor).

GET

https://api.brotaspay.com.br

/api/v1/external/safe2pay/by-reference/{reference}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

reference

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/external/safe2pay/by-reference/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

POST api/v1/external/pix/qrcode/static

POST

https://api.brotaspay.com.br

/api/v1/external/pix/qrcode/static

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

amount

number

required

Must be at least 0.

Example:

conciliation_id

string

required

Must not be greater than 25 characters.

Example:

recipient_name

string

Example:

architecto

addressing_key

object

location

object

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/external/pix/qrcode/static" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"amount\": 27,
    \"conciliation_id\": \"n\",
    \"recipient_name\": \"architecto\",
    \"addressing_key\": {
        \"type\": \"architecto\",
        \"value\": \"architecto\"
    },
    \"location\": {
        \"city\": \"architecto\",
        \"zip_code\": \"architecto\"
    }
}"

POST api/v1/external/pix/qrcode/dynamic

POST

https://api.brotaspay.com.br

/api/v1/external/pix/qrcode/dynamic

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

addressing_key

object

conciliation_id

string

required

Must be at least 26 characters. Must not be greater than 35 characters.

Example:

single_payment

boolean

required

Example:

false

amount

number

required

Must be at least 0.01.

Example:

change_amount_type

string

required

Must be one of:

ALLOWED
NOT_ALLOWED

Example:

ALLOWED

recipient_name

string

Example:

architecto

expires_at

string

Must be a valid date.

Example:

2026-06-27T15:12:22

payer

object

name

string

required

Example:

architecto

document_number

string

required

Example:

architecto

type

string

required

Must be one of:

CUSTOMER
BUSINESS

Example:

CUSTOMER

address

object

city

string

required

Example:

architecto

state

string

required

Example:

architecto

zip_code

string

required

Example:

architecto

address_line

string

required

Example:

architecto

neighborhood

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "addressing_key": { "type": "architecto", "value": "architecto" }, "conciliation_id": "n", "single_payment": false, "amount": 84, "change_amount_type": "ALLOWED", "recipient_name": "architecto", "expires_at": "2026-06-27T15:12:22", "payer": { "name": "architecto", "document_number": "architecto", "type": "CUSTOMER", "address": { "city": "architecto", "state": "architecto", "zip_code": "architecto", "address_line": "architecto", "neighborhood": "architecto" } } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/external/pix/qrcode/dynamic" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"addressing_key\": {
        \"type\": \"architecto\",
        \"value\": \"architecto\"
    },
    \"conciliation_id\": \"n\",
    \"single_payment\": false,
    \"amount\": 84,
    \"change_amount_type\": \"ALLOWED\",
    \"recipient_name\": \"architecto\",
    \"expires_at\": \"2026-06-27T15:12:22\",
    \"payer\": {
        \"name\": \"architecto\",
        \"document_number\": \"architecto\",
        \"type\": \"CUSTOMER\",
        \"address\": {
            \"city\": \"architecto\",
            \"state\": \"architecto\",
            \"zip_code\": \"architecto\",
            \"address_line\": \"architecto\",
            \"neighborhood\": \"architecto\"
        }
    }
}"

GET api/v1/external/banks

GET

https://api.brotaspay.com.br

/api/v1/external/banks

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

product

string

Must be one of:

TED
PIX
accountPortability

Example:

TED

Auth

Bearer

Headers

Body

{ "product": "TED" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/external/banks" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"product\": \"TED\"
}"

Example response:

POST api/v1/external/boletos

POST

https://api.brotaspay.com.br

/api/v1/external/boletos

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

alias

string

Must not be greater than 255 characters.

Example:

account_number

string

required

Example:

architecto

account_branch

string

required

Example:

architecto

document_number

string

required

Must be at least 11 characters. Must not be greater than 14 characters.

Example:

ngzmiyvdljnikh

amount

number

required

Must be at least 0.01.

Example:

due_date

string

required

Must be a valid date in the format Y-m-d.

Example:

2026-06-27

close_payment

string

required

Must be a valid date in the format Y-m-d.

Example:

2026-06-27

type

string

required

Must be one of:

Levy
Deposit

Example:

Levy

payer

object

document

string

This field is required when type is Levy. Must be at least 11 characters. Must not be greater than 14 characters.

Example:

aykcmyuwpwlvqw

name

string

This field is required when type is Levy. Must not be greater than 100 characters.

Example:

trade_name

string

Must not be greater than 100 characters.

Example:

address

object

zip_code

string

This field is required when type is Levy. Must be 8 characters.

Example:

itcpscql

address_line

string

This field is required when type is Levy. Must not be greater than 60 characters.

Example:

number

string

Must not be greater than 20 characters.

Example:

zsnrwtujwvlxjklq

neighborhood

string

This field is required when type is Levy. Must not be greater than 40 characters.

Example:

city

string

This field is required when type is Levy. Must not be greater than 40 characters.

Example:

state

string

This field is required when type is Levy. Must be 2 characters.

Example:

interest

object

fine

object

discount

object

Auth

Bearer

Headers

Body

{ "alias": "b", "account_number": "architecto", "account_branch": "architecto", "document_number": "ngzmiyvdljnikh", "amount": 87, "due_date": "2026-06-27", "close_payment": "2026-06-27", "type": "Levy", "payer": { "document": "aykcmyuwpwlvqw", "name": "r", "trade_name": "s", "address": { "zip_code": "itcpscql", "address_line": "d", "number": "zsnrwtujwvlxjklq", "neighborhood": "p", "city": "p", "state": "wq" } }, "interest": { "start_date": "2026-06-27", "value": 4, "type": "Percent" }, "fine": { "start_date": "2026-06-27", "value": 25, "type": "Percent" }, "discount": { "limit_date": "2026-06-27", "value": 9, "type": "FixedAmountUntilLimitDate" } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/external/boletos" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"alias\": \"b\",
    \"account_number\": \"architecto\",
    \"account_branch\": \"architecto\",
    \"document_number\": \"ngzmiyvdljnikh\",
    \"amount\": 87,
    \"due_date\": \"2026-06-27\",
    \"close_payment\": \"2026-06-27\",
    \"type\": \"Levy\",
    \"payer\": {
        \"document\": \"aykcmyuwpwlvqw\",
        \"name\": \"r\",
        \"trade_name\": \"s\",
        \"address\": {
            \"zip_code\": \"itcpscql\",
            \"address_line\": \"d\",
            \"number\": \"zsnrwtujwvlxjklq\",
            \"neighborhood\": \"p\",
            \"city\": \"p\",
            \"state\": \"wq\"
        }
    },
    \"interest\": {
        \"start_date\": \"2026-06-27\",
        \"value\": 4,
        \"type\": \"Percent\"
    },
    \"fine\": {
        \"start_date\": \"2026-06-27\",
        \"value\": 25,
        \"type\": \"Percent\"
    },
    \"discount\": {
        \"limit_date\": \"2026-06-27\",
        \"value\": 9,
        \"type\": \"FixedAmountUntilLimitDate\"
    }
}"

GET api/v1/external/boletos

GET

https://api.brotaspay.com.br

/api/v1/external/boletos

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

start_date

string

Must be a valid date in the format Y-m-d.

Example:

2026-06-27

end_date

string

Must be a valid date in the format Y-m-d.

Example:

2026-06-27

page

integer

Must be at least 1.

Example:

per_page

integer

Must be at least 1. Must not be greater than 100.

Example:

order_column

string

Must be one of:

createdAt
status

Example:

status

order_direction

string

Must be one of:

ASC
DESC

Example:

ASC

payer_name

string

Must not be greater than 255 characters.

Example:

Auth

Bearer

Headers

Body

{ "start_date": "2026-06-27", "end_date": "2026-06-27", "page": 16, "per_page": 22, "order_column": "status", "order_direction": "ASC", "payer_name": "g" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/external/boletos" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-06-27\",
    \"end_date\": \"2026-06-27\",
    \"page\": 16,
    \"per_page\": 22,
    \"order_column\": \"status\",
    \"order_direction\": \"ASC\",
    \"payer_name\": \"g\"
}"

Example response:

GET api/v1/external/boletos/{authCode}

GET

https://api.brotaspay.com.br

/api/v1/external/boletos/{authCode}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

authCode

string

required

Example:

architecto

Body Parameters

account_branch

string

required

Example:

architecto

account_number

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "account_branch": "architecto", "account_number": "architecto" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/external/boletos/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"account_branch\": \"architecto\",
    \"account_number\": \"architecto\"
}"

Example response:

GET api/v1/external/boletos/{authCode}/print

GET

https://api.brotaspay.com.br

/api/v1/external/boletos/{authCode}/print

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

authCode

string

required

Example:

architecto

Body Parameters

account_branch

string

required

Example:

architecto

account_number

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "account_branch": "architecto", "account_number": "architecto" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/external/boletos/architecto/print" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"account_branch\": \"architecto\",
    \"account_number\": \"architecto\"
}"

Example response:

DELETE api/v1/external/boletos

DELETE

https://api.brotaspay.com.br

/api/v1/external/boletos

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

authentication_code

string

required

Example:

architecto

account_number

string

required

Example:

architecto

account_branch

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "authentication_code": "architecto", "account_number": "architecto", "account_branch": "architecto" }

Received response

Example request:

curl --request DELETE \
    "https://api.brotaspay.com.br/api/v1/external/boletos" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"authentication_code\": \"architecto\",
    \"account_number\": \"architecto\",
    \"account_branch\": \"architecto\"
}"

POST api/v1/external/payments/card

POST

https://api.brotaspay.com.br

/api/v1/external/payments/card

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

amount

number

required

Must be at least 0.01.

Example:

reference

string

required

Must not be greater than 200 characters.

Example:

description

string

Must not be greater than 200 characters.

Example:

Animi quos velit et fugiat.

installments

integer

Must be at least 1. Must not be greater than 12.

Example:

card_token

string

cartão cru OU token do cofre. This field is required when card.number is not present.

Example:

architecto

card

object

holder

string

This field is required when card_token is not present.

Example:

architecto

number

string

This field is required when card_token is not present.

Example:

architecto

expiration

string

This field is required when card_token is not present.

Example:

architecto

cvv

string

MM/AAAA.

Example:

architecto

customer

object

name

string

required

cliente.

Example:

architecto

document

string

required

Example:

architecto

string

Must be a valid email address.

Example:

zbailey@example.net

phone

string

Example:

architecto

address

object

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/external/payments/card" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"amount\": 27,
    \"reference\": \"n\",
    \"description\": \"Animi quos velit et fugiat.\",
    \"installments\": 8,
    \"card_token\": \"architecto\",
    \"card\": {
        \"holder\": \"architecto\",
        \"number\": \"architecto\",
        \"expiration\": \"architecto\",
        \"cvv\": \"architecto\"
    },
    \"customer\": {
        \"name\": \"architecto\",
        \"document\": \"architecto\",
        \"email\": \"zbailey@example.net\",
        \"phone\": \"architecto\"
    }
}"

POST api/v1/external/payments/card/tokenize

POST

https://api.brotaspay.com.br

/api/v1/external/payments/card/tokenize

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

card

object

holder

string

required

Example:

architecto

number

string

required

Example:

architecto

expiration

string

required

Example:

architecto

cvv

string

Example:

architecto

Auth

Bearer

Headers

Body

{ "card": { "holder": "architecto", "number": "architecto", "expiration": "architecto", "cvv": "architecto" } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/external/payments/card/tokenize" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"card\": {
        \"holder\": \"architecto\",
        \"number\": \"architecto\",
        \"expiration\": \"architecto\",
        \"cvv\": \"architecto\"
    }
}"

Cash-out por TRANSFERÊNCIA BANCÁRIA — única forma de saque da Safe2Pay (não há saque por chave PIX). Mesma idempotência do pix().

POST

https://api.brotaspay.com.br

/api/v1/payouts/transfer

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

receiver_name

string

required

Must not be greater than 140 characters.

Example:

receiver_document

string

required

Must be at least 11 characters. Must not be greater than 18 characters.

Example:

ngzmiyvdljnikhwa

amount

number

required

Must be at least 0.01.

Example:

description

string

Must not be greater than 140 characters.

Example:

Quo omnis nostrum aut adipisci.

reference

string

Must not be greater than 140 characters.

Example:

compensation_date

string

Must be a valid date in the format Y-m-d.

Example:

2026-06-27

bank

object

code

string

required

Must not be greater than 5 characters.

Example:

account_type

string

required

Must be one of:

CC
PP

Example:

agency

string

required

Must not be greater than 10 characters.

Example:

lvqwrs

agency_digit

string

Must not be greater than 2 characters.

Example:

account

string

required

Must not be greater than 20 characters.

Example:

cpscqldzsnrwtujw

account_digit

string

Must not be greater than 2 characters.

Example:

Auth

Bearer

Headers

Body

{ "receiver_name": "b", "receiver_document": "ngzmiyvdljnikhwa", "amount": 50, "description": "Quo omnis nostrum aut adipisci.", "reference": "p", "compensation_date": "2026-06-27", "bank": { "code": "w", "account_type": "PP", "agency": "lvqwrs", "agency_digit": "it", "account": "cpscqldzsnrwtujw", "account_digit": "vl" } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/payouts/transfer" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"receiver_name\": \"b\",
    \"receiver_document\": \"ngzmiyvdljnikhwa\",
    \"amount\": 50,
    \"description\": \"Quo omnis nostrum aut adipisci.\",
    \"reference\": \"p\",
    \"compensation_date\": \"2026-06-27\",
    \"bank\": {
        \"code\": \"w\",
        \"account_type\": \"PP\",
        \"agency\": \"lvqwrs\",
        \"agency_digit\": \"it\",
        \"account\": \"cpscqldzsnrwtujw\",
        \"account_digit\": \"vl\"
    }
}"

Consulta de um payout pela referência/idempotency-key do consumidor.

GET

https://api.brotaspay.com.br

/api/v1/payouts/transfer/{reference}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

reference

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/payouts/transfer/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

POST api/v1/payouts/pix

POST

https://api.brotaspay.com.br

/api/v1/payouts/pix

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

pix_key

string

required

Must not be greater than 140 characters.

Example:

amount

number

required

Must be at least 0.01.

Example:

description

string

Must not be greater than 140 characters.

Example:

Animi quos velit et fugiat.

reference

string

Must not be greater than 140 characters.

Example:

pix_key_type

string

Must be one of:

cpf
cnpj
email
phone
evp
random

Example:

cpf

Auth

Bearer

Headers

Body

{ "pix_key": "b", "amount": 39, "description": "Animi quos velit et fugiat.", "reference": "d", "pix_key_type": "cpf" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/payouts/pix" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"pix_key\": \"b\",
    \"amount\": 39,
    \"description\": \"Animi quos velit et fugiat.\",
    \"reference\": \"d\",
    \"pix_key_type\": \"cpf\"
}"

Consulta de um payout pela referência/idempotency-key do consumidor.

GET

https://api.brotaspay.com.br

/api/v1/payouts/pix/{reference}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

reference

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/payouts/pix/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

POST

https://api.brotaspay.com.br

/api/v1/admin/login

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Must be a valid email address.

Example:

gbailey@example.net

password

string

required

Example:

|]|{+-

totp_code

string

Must be 6 characters.

Example:

vdljni

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/login" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"gbailey@example.net\",
    \"password\": \"|]|{+-\",
    \"totp_code\": \"vdljni\"
}"

POST api/v1/admin/logout

POST

https://api.brotaspay.com.br

/api/v1/admin/logout

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/logout" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

GET api/v1/admin/me

GET

https://api.brotaspay.com.br

/api/v1/admin/me

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/me" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/admin/transactions

GET

https://api.brotaspay.com.br

/api/v1/admin/transactions

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

start_date

string

Must be a valid date.

Example:

2026-06-27T15:12:22

end_date

string

Must be a valid date. Must be a date after or equal to start_date.

Example:

2052-07-20

page

integer

Must be at least 1.

Example:

per_page

integer

Must be at least 1. Must not be greater than 100.

Example:

string

Must not be greater than 255 characters.

Example:

direction

string

Must be one of:

IN
OUT

Example:

OUT

transaction_type_code

string

Must be one of:

pix
ted
p2p
payment
slc

Example:

p2p

status

string

Must be one of:

CREATED
DONE
UNDONE
PENDING
CANCELED
RETURN
REFUND
IN_PROCESS
APPROVED
REPROVED
CONFIRMED
COMPLETED
RECEIVED
FAILED
REFUSED
TRANSACTION_HOLD_WAS_REPROVED
TRANSACTION_HOLD_WAS_APPROVED
TRANSACTION_WAS_REVERSED
TRANSACTION_HOLD_WAS_EXPIRED
TRANSACTION_WAS_CONFIRMED
TRANSACTION_WAS_REVERSED_IN_SECOND_INSTANCE
TRANSACTION_VOUCHER_WAS_CREATED

Example:

RETURN

order_column

string

Must be one of:

createdAt

Example:

createdAt

order_direction

string

Must be one of:

ASC
DESC

Example:

DESC

Auth

Bearer

Headers

Body

{ "start_date": "2026-06-27T15:12:22", "end_date": "2052-07-20", "page": 22, "per_page": 7, "search": "z", "direction": "OUT", "transaction_type_code": "p2p", "status": "RETURN", "order_column": "createdAt", "order_direction": "DESC" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/transactions" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-06-27T15:12:22\",
    \"end_date\": \"2052-07-20\",
    \"page\": 22,
    \"per_page\": 7,
    \"search\": \"z\",
    \"direction\": \"OUT\",
    \"transaction_type_code\": \"p2p\",
    \"status\": \"RETURN\",
    \"order_column\": \"createdAt\",
    \"order_direction\": \"DESC\"
}"

Example response:

GET api/v1/admin/environments

GET

https://api.brotaspay.com.br

/api/v1/admin/environments

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/environments" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

POST api/v1/admin/environments

POST

https://api.brotaspay.com.br

/api/v1/admin/environments

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/environments" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Lista consumidores (integrações) e o ambiente em que estão.

GET

https://api.brotaspay.com.br

/api/v1/admin/environments/consumers

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/environments/consumers" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Saldo + próximos repasses (extrato) da carteira Safe2Pay do ambiente.

GET

https://api.brotaspay.com.br

/api/v1/admin/environments/{environment_id}/balance

requires authentication

Só Safe2Pay tem carteira; HiperBanco devolve "unsupported".

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

environment_id

integer

required

The ID of the environment.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/environments/1/balance" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

PATCH api/v1/admin/environments/{environment_id}

PATCH

https://api.brotaspay.com.br

/api/v1/admin/environments/{environment_id}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

environment_id

integer

required

The ID of the environment.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/admin/environments/1" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Define o ambiente como padrão (usado por consumidores sem atribuição).

POST

https://api.brotaspay.com.br

/api/v1/admin/environments/{environment_id}/default

requires authentication

Garante exclusividade do flag is_default.

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

environment_id

integer

required

The ID of the environment.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/environments/1/default" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Testa a conexão com o provedor usando as credenciais salvas.

POST

https://api.brotaspay.com.br

/api/v1/admin/environments/{environment_id}/test

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

environment_id

integer

required

The ID of the environment.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/environments/1/test" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Atribui um consumidor a um ambiente (migração gradual por sistema).

POST

https://api.brotaspay.com.br

/api/v1/admin/integrations/{integration_id}/environment

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integration_id

integer

required

The ID of the integration.

Example:

Body Parameters

payment_environment_id

integer

The id of an existing record in the payment_environments table.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "payment_environment_id": 16 }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/integrations/3/environment" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"payment_environment_id\": 16
}"

Lista clientes com subconta Safe2Pay + plano de comissão atual.

GET

https://api.brotaspay.com.br

/api/v1/admin/clients

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/clients" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Status da subconta + saldo (se ativa).

GET

https://api.brotaspay.com.br

/api/v1/admin/clients/{user_id}/subaccount

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/clients/1/subaccount" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Cria/Reprovisiona a subconta do cliente.

POST

https://api.brotaspay.com.br

/api/v1/admin/clients/{user_id}/subaccount

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Body Parameters

name

string

Must not be greater than 120 characters.

Example:

commercial_name

string

Must not be greater than 120 characters.

Example:

document

string

Must be at least 11 characters. Must not be greater than 18 characters.

Example:

gzmiyvdljnikhway

responsible_name

string

required

Must not be greater than 120 characters.

Example:

responsible_document

string

required

Must be at least 11 characters. Must not be greater than 14 characters.

Example:

cmyuwpwlvqwrsi

responsible_birth_date

string

required

Must be a valid date in the format d/m/Y.

Example:

27/06/2026

responsible_phone

string

required

exigido pela Safe2Pay. Must not be greater than 20 characters.

Example:

tcpscqldzsnrwtuj

string

required

Must be a valid email address.

Example:

schultz.audrey@example.org

bank

object

code

string

required

Must not be greater than 5 characters.

Example:

account_type

string

required

Must be one of:

CC
PP

Example:

agency

string

required

Must not be greater than 10 characters.

Example:

lqppwq

agency_digit

string

Must not be greater than 2 characters.

Example:

account

string

required

Must not be greater than 20 characters.

Example:

wtnnoqitpxntltcv

account_digit

string

Must not be greater than 2 characters.

Example:

address

object

zip_code

string

required

Must not be greater than 9 characters.

Example:

ojsausg

street

string

required

Must not be greater than 120 characters.

Example:

number

string

Must not be greater than 20 characters.

Example:

oglrbchgsrzyhctt

complement

string

Must not be greater than 80 characters.

Example:

district

string

required

Must not be greater than 80 characters.

Example:

city

string

required

Must not be greater than 80 characters.

Example:

state

string

required

Must be 2 characters.

Example:

split

object

Comissão opcional por chamada (senão usa config).

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "b", "commercial_name": "n", "document": "gzmiyvdljnikhway", "responsible_name": "k", "responsible_document": "cmyuwpwlvqwrsi", "responsible_birth_date": "27\/06\/2026", "responsible_phone": "tcpscqldzsnrwtuj", "email": "schultz.audrey@example.org", "bank": { "code": "k", "account_type": "PP", "agency": "lqppwq", "agency_digit": "be", "account": "wtnnoqitpxntltcv", "account_digit": "ip" }, "address": { "zip_code": "ojsausg", "street": "i", "number": "oglrbchgsrzyhctt", "complement": "w", "district": "b", "city": "k", "state": "mk" }, "split": null }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/clients/1/subaccount" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"b\",
    \"commercial_name\": \"n\",
    \"document\": \"gzmiyvdljnikhway\",
    \"responsible_name\": \"k\",
    \"responsible_document\": \"cmyuwpwlvqwrsi\",
    \"responsible_birth_date\": \"27\\/06\\/2026\",
    \"responsible_phone\": \"tcpscqldzsnrwtuj\",
    \"email\": \"schultz.audrey@example.org\",
    \"bank\": {
        \"code\": \"k\",
        \"account_type\": \"PP\",
        \"agency\": \"lqppwq\",
        \"agency_digit\": \"be\",
        \"account\": \"wtnnoqitpxntltcv\",
        \"account_digit\": \"ip\"
    },
    \"address\": {
        \"zip_code\": \"ojsausg\",
        \"street\": \"i\",
        \"number\": \"oglrbchgsrzyhctt\",
        \"complement\": \"w\",
        \"district\": \"b\",
        \"city\": \"k\",
        \"state\": \"mk\"
    }
}"

Propaga o plano de comissão atual para a subconta (Marketplace/Update).

POST

https://api.brotaspay.com.br

/api/v1/admin/clients/{user_id}/subaccount/sync

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/clients/1/subaccount/sync" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

GET api/v1/admin/commission-plans

GET

https://api.brotaspay.com.br

/api/v1/admin/commission-plans

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/commission-plans" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

POST api/v1/admin/commission-plans

POST

https://api.brotaspay.com.br

/api/v1/admin/commission-plans

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/commission-plans" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

PATCH api/v1/admin/commission-plans/{commissionPlan_id}

PATCH

https://api.brotaspay.com.br

/api/v1/admin/commission-plans/{commissionPlan_id}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

commissionPlan_id

integer

required

The ID of the commissionPlan.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/admin/commission-plans/1" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

DELETE api/v1/admin/commission-plans/{commissionPlan_id}

DELETE

https://api.brotaspay.com.br

/api/v1/admin/commission-plans/{commissionPlan_id}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

commissionPlan_id

integer

required

The ID of the commissionPlan.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.brotaspay.com.br/api/v1/admin/commission-plans/1" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Define como padrão (exclusivo).

POST

https://api.brotaspay.com.br

/api/v1/admin/commission-plans/{commissionPlan_id}/default

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

commissionPlan_id

integer

required

The ID of the commissionPlan.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/commission-plans/1/default" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Atribui um plano de comissão a um cliente (null = volta ao padrão).

POST

https://api.brotaspay.com.br

/api/v1/admin/clients/{user_id}/commission-plan

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Body Parameters

commission_plan_id

integer

The id of an existing record in the commission_plans table.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "commission_plan_id": 16 }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/clients/1/commission-plan" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"commission_plan_id\": 16
}"

GET api/v1/admin/webhooks/event-names

GET

https://api.brotaspay.com.br

/api/v1/admin/webhooks/event-names

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/webhooks/event-names" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/admin/webhooks/messages

GET

https://api.brotaspay.com.br

/api/v1/admin/webhooks/messages

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

start_date

string

required

Must be a valid date in the format Y-m-d.

Example:

2026-06-27

end_date

string

required

Must be a valid date in the format Y-m-d.

Example:

2026-06-27

state

string

Must be one of:

Success
Failed

Example:

Failed

event_name

string

Example:

architecto

context

string

Example:

architecto

page

integer

Must be at least 1.

Example:

page_size

integer

Must be at least 1. Must not be greater than 100.

Example:

Auth

Bearer

Headers

Body

{ "start_date": "2026-06-27", "end_date": "2026-06-27", "state": "Failed", "event_name": "architecto", "context": "architecto", "page": 22, "page_size": 7 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/webhooks/messages" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-06-27\",
    \"end_date\": \"2026-06-27\",
    \"state\": \"Failed\",
    \"event_name\": \"architecto\",
    \"context\": \"architecto\",
    \"page\": 22,
    \"page_size\": 7
}"

Example response:

POST api/v1/admin/webhooks/messages/{id}/reprocess

POST

https://api.brotaspay.com.br

/api/v1/admin/webhooks/messages/{id}/reprocess

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the message.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/webhooks/messages/architecto/reprocess" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

GET api/v1/admin/webhooks/reconcile-logs

GET

https://api.brotaspay.com.br

/api/v1/admin/webhooks/reconcile-logs

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/webhooks/reconcile-logs" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/admin/webhooks

GET

https://api.brotaspay.com.br

/api/v1/admin/webhooks

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

status

string

Must be one of:

Enabled
Disabled

Example:

Disabled

page

integer

Must be at least 1.

Example:

page_size

integer

Must be at least 1. Must not be greater than 100.

Example:

Auth

Bearer

Headers

Body

{ "status": "Disabled", "page": 16, "page_size": 22 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/webhooks" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"Disabled\",
    \"page\": 16,
    \"page_size\": 22
}"

Example response:

POST api/v1/admin/webhooks

POST

https://api.brotaspay.com.br

/api/v1/admin/webhooks

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Must not be greater than 255 characters.

Example:

context

string

required

Must be one of:

Boleto
Pix
Ted
Payment
Account
Authorization
Card
Customer
Business
Document
Dict
SLC
Openfinance

Example:

Customer

uri

string

required

Must be a valid URL.

Example:

http://bailey.com/

event_name

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "name": "b", "context": "Customer", "uri": "http:\/\/bailey.com\/", "event_name": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/webhooks" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"b\",
    \"context\": \"Customer\",
    \"uri\": \"http:\\/\\/bailey.com\\/\",
    \"event_name\": \"architecto\"
}"

PATCH api/v1/admin/webhooks/bulk-update

PATCH

https://api.brotaspay.com.br

/api/v1/admin/webhooks/bulk-update

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

ids

string[]

required

Example:

["architecto"]

uri

string

required

Must be a valid URL. Must not be greater than 500 characters.

Example:

Auth

Bearer

Headers

Body

{ "ids": [ "architecto" ], "uri": "n" }

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/admin/webhooks/bulk-update" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ids\": [
        \"architecto\"
    ],
    \"uri\": \"n\"
}"

PATCH api/v1/admin/webhooks/{id}

PATCH

https://api.brotaspay.com.br

/api/v1/admin/webhooks/{id}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the webhook.

Example:

architecto

Body Parameters

uri

string

required

Must be a valid URL.

Example:

http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html

Auth

Bearer

Headers

URL Parameters

Body

{ "uri": "http:\/\/www.bailey.biz\/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html" }

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/admin/webhooks/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uri\": \"http:\\/\\/www.bailey.biz\\/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html\"
}"

DELETE api/v1/admin/webhooks/{id}

DELETE

https://api.brotaspay.com.br

/api/v1/admin/webhooks/{id}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the webhook.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.brotaspay.com.br/api/v1/admin/webhooks/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

GET api/v1/admin/plans

GET

https://api.brotaspay.com.br

/api/v1/admin/plans

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

page

integer

Must be at least 1.

Example:

per_page

integer

Must be at least 1. Must not be greater than 100.

Example:

string

Must not be greater than 255 characters.

Example:

order_column

string

Must be one of:

name
price
type_account
availability

Example:

availability

order_direction

string

Must be one of:

ASC
DESC

Example:

ASC

Auth

Bearer

Headers

Body

{ "page": 16, "per_page": 22, "search": "g", "order_column": "availability", "order_direction": "ASC" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/plans" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"page\": 16,
    \"per_page\": 22,
    \"search\": \"g\",
    \"order_column\": \"availability\",
    \"order_direction\": \"ASC\"
}"

Example response:

POST api/v1/admin/plans

POST

https://api.brotaspay.com.br

/api/v1/admin/plans

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

name

string

required

Must not be greater than 255 characters.

Example:

description

string

Example:

Eius et animi quos velit et.

benefits

string

Example:

architecto

contract

file

required

Must be a file. Must not be greater than 51200 kilobytes.

Example:

/tmp/php5Bs6sq

plan_default

boolean

required

Example:

true

availability

string

required

Example:

architecto

visibility

string

required

Example:

architecto

type_account

string

required

Must be one of:

PF
PJ

Example:

days_until_first_payment

integer

required

Must be at least 0.

Example:

price

number

required

Must be at least 0.

Example:

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/plans" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=b"\
    --form "description=Eius et animi quos velit et."\
    --form "benefits=architecto"\
    --form "plan_default=1"\
    --form "availability=architecto"\
    --form "visibility=architecto"\
    --form "type_account=PJ"\
    --form "days_until_first_payment=39"\
    --form "price=84"\
    --form "contract=@/tmp/php5Bs6sq"

GET api/v1/admin/plans/{id}

GET

https://api.brotaspay.com.br

/api/v1/admin/plans/{id}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the plan.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/plans/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

PATCH api/v1/admin/plans/{id}

PATCH

https://api.brotaspay.com.br

/api/v1/admin/plans/{id}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

string

required

The ID of the plan.

Example:

architecto

Body Parameters

name

string

required

Must not be greater than 255 characters.

Example:

description

string

required

Must not be greater than 255 characters.

Example:

Et animi quos velit et fugiat.

benefits

string

required

Must not be greater than 255 characters.

Example:

contract

file

required

Must be a file. Must not be greater than 51200 kilobytes.

Example:

/tmp/phpZZDwHU

plan_default

boolean

required

Example:

false

availability

boolean

required

Example:

false

visibility

boolean

required

Example:

true

type_account

string

required

Must be one of:

PF
PJ

Example:

days_until_first_payment

integer

required

Must be at least 0.

Example:

price

number

required

Must be at least 0.

Example:

price_pix

number

required

Must be at least 0.

Example:

price_ted

number

required

Must be at least 0.

Example:

price_billet

number

required

Must be at least 0.

Example:

price_p2p

number

required

Must be at least 0.

Example:

price_generate_dynamic_qr_code_pix

number

required

Must be at least 0.

Example:

price_generate_static_qr_code_pix

number

required

Must be at least 0.

Example:

price_receive_dynamic_qr_code_pix

number

required

Must be at least 0.

Example:

price_receive_static_qr_code_pix

number

required

Must be at least 0.

Example:

bill_settlement_price

number

required

Must be at least 0.

Example:

price_withdraw

number

required

Must be at least 0.

Example:

quantity_generate_dynamic_qr_code_pix

integer

required

Must be at least 0.

Example:

quantity_generate_static_qr_code_pix

integer

required

Must be at least 0.

Example:

quantity_receive_dynamic_qr_code_pix

integer

required

Must be at least 0.

Example:

quantity_receive_static_qr_code_pix

integer

required

Must be at least 0.

Example:

quantity_pix

integer

required

Must be at least 0.

Example:

quantity_ted

integer

required

Must be at least 0.

Example:

quantity_billet

integer

required

Must be at least 0.

Example:

quantity_periodo

integer

required

Must be at least 0.

Example:

quantity_p2p

integer

required

Must be at least 0.

Example:

quantity_bill_settlement

integer

required

Must be at least 0.

Example:

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/admin/plans/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=b"\
    --form "description=Et animi quos velit et fugiat."\
    --form "benefits=d"\
    --form "plan_default="\
    --form "availability="\
    --form "visibility=1"\
    --form "type_account=PJ"\
    --form "days_until_first_payment=37"\
    --form "price=9"\
    --form "price_pix=52"\
    --form "price_ted=8"\
    --form "price_billet=75"\
    --form "price_p2p=7"\
    --form "price_generate_dynamic_qr_code_pix=87"\
    --form "price_generate_static_qr_code_pix=39"\
    --form "price_receive_dynamic_qr_code_pix=50"\
    --form "price_receive_static_qr_code_pix=62"\
    --form "bill_settlement_price=54"\
    --form "price_withdraw=38"\
    --form "quantity_generate_dynamic_qr_code_pix=50"\
    --form "quantity_generate_static_qr_code_pix=72"\
    --form "quantity_receive_dynamic_qr_code_pix=61"\
    --form "quantity_receive_static_qr_code_pix=67"\
    --form "quantity_pix=61"\
    --form "quantity_ted=89"\
    --form "quantity_billet=34"\
    --form "quantity_periodo=3"\
    --form "quantity_p2p=22"\
    --form "quantity_bill_settlement=4"\
    --form "contract=@/tmp/phpZZDwHU"

DELETE api/v1/admin/plans/{id}

DELETE

https://api.brotaspay.com.br

/api/v1/admin/plans/{id}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the plan.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.brotaspay.com.br/api/v1/admin/plans/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

GET api/v1/admin/plans/{id}/accounts

GET

https://api.brotaspay.com.br

/api/v1/admin/plans/{id}/accounts

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the plan.

Example:

architecto

Body Parameters

page

integer

Must be at least 1.

Example:

per_page

integer

Must be at least 1. Must not be greater than 100.

Example:

string

Must not be greater than 255 characters.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "page": 16, "per_page": 22, "search": "g" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/plans/architecto/accounts" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"page\": 16,
    \"per_page\": 22,
    \"search\": \"g\"
}"

Example response:

GET api/v1/admin/plans/{accountId}/billing-history

GET

https://api.brotaspay.com.br

/api/v1/admin/plans/{accountId}/billing-history

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

accountId

string

required

Example:

architecto

Body Parameters

page

integer

Must be at least 1.

Example:

per_page

integer

Must be at least 1. Must not be greater than 100.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "page": 16, "per_page": 22 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/plans/architecto/billing-history" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"page\": 16,
    \"per_page\": 22
}"

Example response:

PUT api/v1/admin/plans/{accountId}/assign

PUT

https://api.brotaspay.com.br

/api/v1/admin/plans/{accountId}/assign

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

accountId

string

required

Example:

architecto

Body Parameters

new_plan_id

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "new_plan_id": "architecto" }

Received response

Example request:

curl --request PUT \
    "https://api.brotaspay.com.br/api/v1/admin/plans/architecto/assign" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"new_plan_id\": \"architecto\"
}"

GET api/v1/admin/users

GET

https://api.brotaspay.com.br

/api/v1/admin/users

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/users" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

POST api/v1/admin/users

POST

https://api.brotaspay.com.br

/api/v1/admin/users

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Must not be greater than 255 characters.

Example:

string

required

Must be a valid email address.

Example:

zbailey@example.net

password

string

required

Example:

|]|{+-

Auth

Bearer

Headers

Body

{ "name": "b", "email": "zbailey@example.net", "password": "|]|{+-" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/users" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"b\",
    \"email\": \"zbailey@example.net\",
    \"password\": \"|]|{+-\"
}"

DELETE api/v1/admin/users/{id}

DELETE

https://api.brotaspay.com.br

/api/v1/admin/users/{id}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the user.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.brotaspay.com.br/api/v1/admin/users/1" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

GET api/v1/admin/profile

GET

https://api.brotaspay.com.br

/api/v1/admin/profile

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/profile" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

PATCH api/v1/admin/profile

PATCH

https://api.brotaspay.com.br

/api/v1/admin/profile

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Must not be greater than 255 characters.

Example:

string

required

Must be a valid email address.

Example:

zbailey@example.net

Auth

Bearer

Headers

Body

{ "name": "b", "email": "zbailey@example.net" }

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/admin/profile" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"b\",
    \"email\": \"zbailey@example.net\"
}"

PATCH api/v1/admin/profile/password

PATCH

https://api.brotaspay.com.br

/api/v1/admin/profile/password

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

current_password

string

required

Example:

architecto

new_password

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "current_password": "architecto", "new_password": "architecto" }

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/admin/profile/password" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"current_password\": \"architecto\",
    \"new_password\": \"architecto\"
}"

GET api/v1/admin/email-test/templates

GET

https://api.brotaspay.com.br

/api/v1/admin/email-test/templates

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/email-test/templates" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

POST api/v1/admin/email-test/send

POST

https://api.brotaspay.com.br

/api/v1/admin/email-test/send

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

template

string

required

Example:

architecto

string

required

Must be a valid email address.

Example:

zbailey@example.net

Auth

Bearer

Headers

Body

{ "template": "architecto", "to": "zbailey@example.net" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/email-test/send" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"template\": \"architecto\",
    \"to\": \"zbailey@example.net\"
}"

Portal · NPS

Coleta de NPS dentro do app autenticado.

Verificar elegibilidade da pesquisa

GET

https://api.brotaspay.com.br

/api/v1/nps/eligibility

requires authentication

Retorna se o usuário deve ver o prompt de NPS (ainda não respondeu nesta tag nos últimos 90 dias).

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

survey_tag

string

Tag da pesquisa para checar.

Example:

post_onboarding

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/nps/eligibility?survey_tag=post_onboarding" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Enviar resposta NPS

POST

https://api.brotaspay.com.br

/api/v1/nps

requires authentication

Registra uma resposta de NPS do usuário autenticado. A categoria (promoter/passive/detractor) é derivada do score.

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

score

integer

required

Nota de 0 a 10.

Example:

comment

string

Comentário opcional (max 2000).

Example:

Atendimento rápido.

survey_tag

string

Tag da pesquisa.

Example:

post_onboarding

source

string

Origem (app|email|web).

Example:

app

Auth

Bearer

Headers

Body

{ "score": 9, "comment": "Atendimento r\u00e1pido.", "survey_tag": "post_onboarding", "source": "app" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/nps" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"score\": 9,
    \"comment\": \"Atendimento rápido.\",
    \"survey_tag\": \"post_onboarding\",
    \"source\": \"app\"
}"