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 · 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-04-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-05-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-04-27", "end_date": "2052-05-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-04-27\",
    \"end_date\": \"2052-05-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-04-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-05-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-04-27", "end_date": "2052-05-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-04-27\",
    \"end_date\": \"2052-05-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-04-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-05-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-04-27", "end_date": "2052-05-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-04-27\",
    \"end_date\": \"2052-05-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-04-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-05-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-04-27", "end_date": "2052-05-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-04-27\",
    \"end_date\": \"2052-05-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-04-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-05-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-04-27", "end_date": "2052-05-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-04-27\",
    \"end_date\": \"2052-05-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-04-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-05-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-04-27", "end_date": "2052-05-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-04-27\",
    \"end_date\": \"2052-05-20\",
    \"survey_tag\": \"n\",
    \"inactivity_days\": 7,
    \"window_days\": 16,
    \"months_back\": 21
}"

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

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

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "cpf": "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\"
}"

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

required

Example:

architecto

token

string

required

Must be 4 characters.

Example:

ngzm

new_password

string

required

Must be at least 8 characters.

Example:

iyvdljnikhwaykcmyuwpwlvqwr

Auth

Bearer

Headers

Body

{ "cpf": "architecto", "token": "ngzm", "new_password": "iyvdljnikhwaykcmyuwpwlvqwr" }

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\",
    \"token\": \"ngzm\",
    \"new_password\": \"iyvdljnikhwaykcmyuwpwlvqwr\"
}"

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:

POST api/v1/onboarding/pf

POST

https://api.brotaspay.com.br

/api/v1/onboarding/pf

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

register_name

string

required

Must not be greater than 255 characters.

Example:

social_name

string

required

Must not be greater than 255 characters.

Example:

document_number

string

required

Must be 11 characters.

Example:

gzmiyvdljni

document_number_photo

string

required

Example:

architecto

document_type

string

required

Must be one of:

RG
CNH

Example:

issuer_entity

string

required

Example:

architecto

date_number_document_photo

string

required

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

Example:

2026-04-27

string

required

Must be a valid email address.

Example:

zbailey@example.net

password

string

required

Must be at least 8 characters.

Example:

-0pBNvYgxw

birth_date

string

required

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

Example:

2026-04-27

mother_name

string

required

Must not be greater than 255 characters.

Example:

phone

object

required

address

object

required

zip_code

string

required

Example:

architecto

address_line

string

required

Example:

architecto

building_number

string

required

Example:

architecto

neighborhood

string

required

Example:

architecto

city

string

required

Example:

architecto

state

string

required

Must be 2 characters.

Example:

country

string

required

Example:

architecto

occupation

string

required

Example:

architecto

pep

string

required

Must be one of:

NONE
SELF
RELATED

Example:

NONE

asserted_income

number

required

Must be at least 0.

Example:

gender

string

required

Must be one of:

FEMININO
MASCULINO
OUTROS

Example:

MASCULINO

nationality

string

required

Must be one of:

BRASILEIRO
ESTRANGEIRO

Example:

ESTRANGEIRO

relationship_status

string

required

Must be one of:

CASADO
DIVORCIADO
VIUVO
SEPARADO
SOLTEIRO
COMPANHEIRO
UNIAO_ESTAVEL
SEPARADO_JUDICIALMENTE

Example:

SEPARADO

education

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "register_name": "b", "social_name": "n", "document_number": "gzmiyvdljni", "document_number_photo": "architecto", "document_type": "RG", "issuer_entity": "architecto", "date_number_document_photo": "2026-04-27", "email": "zbailey@example.net", "password": "-0pBNvYgxw", "birth_date": "2026-04-27", "mother_name": "a", "phone": { "country_code": "architecto", "number": "architecto" }, "address": { "zip_code": "architecto", "address_line": "architecto", "building_number": "architecto", "neighborhood": "architecto", "city": "architecto", "state": "ng", "country": "architecto" }, "occupation": "architecto", "pep": "NONE", "asserted_income": 39, "gender": "MASCULINO", "nationality": "ESTRANGEIRO", "relationship_status": "SEPARADO", "education": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/onboarding/pf" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"register_name\": \"b\",
    \"social_name\": \"n\",
    \"document_number\": \"gzmiyvdljni\",
    \"document_number_photo\": \"architecto\",
    \"document_type\": \"RG\",
    \"issuer_entity\": \"architecto\",
    \"date_number_document_photo\": \"2026-04-27\",
    \"email\": \"zbailey@example.net\",
    \"password\": \"-0pBNvYgxw\",
    \"birth_date\": \"2026-04-27\",
    \"mother_name\": \"a\",
    \"phone\": {
        \"country_code\": \"architecto\",
        \"number\": \"architecto\"
    },
    \"address\": {
        \"zip_code\": \"architecto\",
        \"address_line\": \"architecto\",
        \"building_number\": \"architecto\",
        \"neighborhood\": \"architecto\",
        \"city\": \"architecto\",
        \"state\": \"ng\",
        \"country\": \"architecto\"
    },
    \"occupation\": \"architecto\",
    \"pep\": \"NONE\",
    \"asserted_income\": 39,
    \"gender\": \"MASCULINO\",
    \"nationality\": \"ESTRANGEIRO\",
    \"relationship_status\": \"SEPARADO\",
    \"education\": \"architecto\"
}"

POST api/v1/onboarding/pf/documents

POST

https://api.brotaspay.com.br

/api/v1/onboarding/pf/documents

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

onboarding_id

integer

required

Example:

document_type

string

required

Must be one of:

SELFIE
RG
CNH

Example:

CNH

document_side

string

required

Must be one of:

FRONT
BACK

Example:

BACK

provider

string

required

Must be one of:

UNICO_CHECK
BANKLY

Example:

UNICO_CHECK

image

file

required

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

Example:

/tmp/phpkm37iu2i6i0mfXrrBq6

provider_metadata

object

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/onboarding/pf/documents" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "onboarding_id=16"\
    --form "document_type=CNH"\
    --form "document_side=BACK"\
    --form "provider=UNICO_CHECK"\
    --form "provider_metadata[isLastDocument]="\
    --form "provider_metadata[encrypted]=architecto"\
    --form "image=@/tmp/phpkm37iu2i6i0mfXrrBq6"

POST api/v1/onboarding/pf/complete

POST

https://api.brotaspay.com.br

/api/v1/onboarding/pf/complete

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

onboarding_id

integer

required

Example:

Auth

Bearer

Headers

Body

{ "onboarding_id": 16 }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/onboarding/pf/complete" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"onboarding_id\": 16
}"

POST api/v1/onboarding/pj/mei

POST

https://api.brotaspay.com.br

/api/v1/onboarding/pj/mei

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

document_number

string

required

Must be 14 characters.

Example:

bngzmiyvdljnik

business_name

string

required

Must not be greater than 255 characters.

Example:

trading_name

string

required

Must not be greater than 255 characters.

Example:

business_email

string

required

Must be a valid email address.

Example:

cormier.nick@example.com

business_type

string

required

Must be one of:

MEI
EI
EIRELLI
SLU

Example:

business_size

string

required

Must be one of:

MEI
ME
EPP

Example:

MEI

password

string

required

Must be at least 8 characters.

Example:

/kXaz<m5L[)~=NG5a:

declared_annual_billing

string

required

Example:

architecto

document_number_personal

string

required

Must be 11 characters.

Example:

ngzmiyvdljn

business_address

object

required

zip_code

string

required

Example:

architecto

address_line

string

required

Example:

architecto

building_number

string

required

Example:

architecto

neighborhood

string

required

Example:

architecto

city

string

required

Example:

architecto

state

string

required

Must be 2 characters.

Example:

country

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "document_number": "bngzmiyvdljnik", "business_name": "h", "trading_name": "w", "business_email": "cormier.nick@example.com", "business_type": "EI", "business_size": "MEI", "password": "\/kXaz\u003Cm5L[)~=NG5a:", "declared_annual_billing": "architecto", "document_number_personal": "ngzmiyvdljn", "business_address": { "zip_code": "architecto", "address_line": "architecto", "building_number": "architecto", "neighborhood": "architecto", "city": "architecto", "state": "ng", "country": "architecto" } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/onboarding/pj/mei" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"document_number\": \"bngzmiyvdljnik\",
    \"business_name\": \"h\",
    \"trading_name\": \"w\",
    \"business_email\": \"cormier.nick@example.com\",
    \"business_type\": \"EI\",
    \"business_size\": \"MEI\",
    \"password\": \"\\/kXaz<m5L[)~=NG5a:\",
    \"declared_annual_billing\": \"architecto\",
    \"document_number_personal\": \"ngzmiyvdljn\",
    \"business_address\": {
        \"zip_code\": \"architecto\",
        \"address_line\": \"architecto\",
        \"building_number\": \"architecto\",
        \"neighborhood\": \"architecto\",
        \"city\": \"architecto\",
        \"state\": \"ng\",
        \"country\": \"architecto\"
    }
}"

POST api/v1/onboarding/pj/documents

POST

https://api.brotaspay.com.br

/api/v1/onboarding/pj/documents

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

cnpj

string

required

Must be 14 characters.

Example:

bngzmiyvdljnik

document_type

string

required

Must be one of:

ARTICLES_OF_INCORPORATION
LAST_CONTRACT_CHANGE
POWER_OF_ATTORNEY
BALANCE_SHEET
PROOF_OF_ADDRESS

Example:

POWER_OF_ATTORNEY

file

required

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

Example:

/tmp/phppod3n8it8kg87jzE0nv

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/onboarding/pj/documents" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "cnpj=bngzmiyvdljnik"\
    --form "document_type=POWER_OF_ATTORNEY"\
    --form "file=@/tmp/phppod3n8it8kg87jzE0nv"

POST api/v1/onboarding/pj/representative

POST

https://api.brotaspay.com.br

/api/v1/onboarding/pj/representative

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

cpf

string

required

Must be 11 characters.

Example:

bngzmiyvdlj

document_type

string

required

Must be one of:

SELFIE
RG
CNH

Example:

SELFIE

document_side

string

required

Must be one of:

FRONT
BACK

Example:

BACK

provider

string

required

Must be one of:

UNICO_CHECK
BANKLY

Example:

UNICO_CHECK

image

file

required

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

Example:

/tmp/phpugff8edhdkpl5z8brEr

provider_metadata

object

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/onboarding/pj/representative" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "cpf=bngzmiyvdlj"\
    --form "document_type=SELFIE"\
    --form "document_side=BACK"\
    --form "provider=UNICO_CHECK"\
    --form "image=@/tmp/phpugff8edhdkpl5z8brEr"

POST api/v1/onboarding/pj/enterprise

POST

https://api.brotaspay.com.br

/api/v1/onboarding/pj/enterprise

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

document_number

string

required

Must be 14 characters.

Example:

bngzmiyvdljnik

business_name

string

required

Must not be greater than 255 characters.

Example:

trading_name

string

required

Must not be greater than 255 characters.

Example:

business_email

string

required

Must be a valid email address.

Example:

cormier.nick@example.com

business_type

string

required

Must be one of:

LTDA
SA
TS

Example:

LTDA

business_size

string

required

Must be one of:

SMALL
MEDIUM
LARGE

Example:

SMALL

cnae_code

string

required

Example:

architecto

legal_nature

string

required

Example:

architecto

opening_date

string

required

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

Example:

2026-04-27

declared_annual_billing

string

required

Example:

architecto

password

string

required

Must be at least 8 characters.

Example:

]|{+-0pBNvYg

phone

object

required

business_address

object

required

Example:

[]

documentation

object

required

Example:

[]

legal_representatives

object

required

Must have at least 1 items.

Example:

[]

owners

object

required

Must have at least 1 items.

Example:

[]

Auth

Bearer

Headers

Body

{ "document_number": "bngzmiyvdljnik", "business_name": "h", "trading_name": "w", "business_email": "cormier.nick@example.com", "business_type": "LTDA", "business_size": "SMALL", "cnae_code": "architecto", "legal_nature": "architecto", "opening_date": "2026-04-27", "declared_annual_billing": "architecto", "password": "]|{+-0pBNvYg", "phone": { "country_code": "architecto", "number": "architecto" }, "business_address": [], "documentation": [], "legal_representatives": [], "owners": [] }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/onboarding/pj/enterprise" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"document_number\": \"bngzmiyvdljnik\",
    \"business_name\": \"h\",
    \"trading_name\": \"w\",
    \"business_email\": \"cormier.nick@example.com\",
    \"business_type\": \"LTDA\",
    \"business_size\": \"SMALL\",
    \"cnae_code\": \"architecto\",
    \"legal_nature\": \"architecto\",
    \"opening_date\": \"2026-04-27\",
    \"declared_annual_billing\": \"architecto\",
    \"password\": \"]|{+-0pBNvYg\",
    \"phone\": {
        \"country_code\": \"architecto\",
        \"number\": \"architecto\"
    },
    \"business_address\": [],
    \"documentation\": [],
    \"legal_representatives\": [],
    \"owners\": []
}"

GET api/v1/onboarding/status

GET

https://api.brotaspay.com.br

/api/v1/onboarding/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/onboarding/status" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/pix/keys

GET

https://api.brotaspay.com.br

/api/v1/pix/keys

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

account_number

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "account_number": "architecto" }

Received response

Example request:

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

Example response:

POST api/v1/pix/keys

POST

https://api.brotaspay.com.br

/api/v1/pix/keys

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

key_type

string

required

Must be one of:

CPF
CNPJ
EMAIL
PHONE
EVP

Example:

PHONE

key_value

string

This field is required unless key_type is in EVP.

Example:

architecto

account_type

string

required

Must be one of:

PAYMENT
CHECKING

Example:

PAYMENT

account_branch

string

required

Must be 4 characters.

Example:

ngzm

account_number

string

required

Example:

architecto

totp_code

string

Must be 6 characters.

Example:

ngzmiy

Auth

Bearer

Headers

Body

{ "key_type": "PHONE", "key_value": "architecto", "account_type": "PAYMENT", "account_branch": "ngzm", "account_number": "architecto", "totp_code": "ngzmiy" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/pix/keys" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"key_type\": \"PHONE\",
    \"key_value\": \"architecto\",
    \"account_type\": \"PAYMENT\",
    \"account_branch\": \"ngzm\",
    \"account_number\": \"architecto\",
    \"totp_code\": \"ngzmiy\"
}"

DELETE api/v1/pix/keys/{key}

DELETE

https://api.brotaspay.com.br

/api/v1/pix/keys/{key}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

key

string

required

The key.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

POST api/v1/pix/lookup

POST

https://api.brotaspay.com.br

/api/v1/pix/lookup

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

key

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "key": "architecto" }

Received response

Example request:

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

POST api/v1/pix/transfer

POST

https://api.brotaspay.com.br

/api/v1/pix/transfer

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

initialization_type

string

required

Must be one of:

Key
StaticQrCode
DynamicQrCode
Manual

Example:

Key

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.

pix_key

string

Example:

architecto

end_to_end_id

string

Example:

architecto

receiver_reconciliation_id

string

Example:

architecto

sender

object

account_type

string

required

Example:

architecto

account_branch

string

required

Example:

architecto

account_number

string

required

Example:

architecto

document_number

string

required

Example:

architecto

name

string

required

Example:

architecto

recipient

object

document_number

string

Example:

architecto

name

string

Example:

architecto

account_type

string

Example:

architecto

account_branch

string

Example:

architecto

account_number

string

Example:

architecto

bank_ispb

string

Example:

architecto

Auth

Bearer

Headers

Body

{ "initialization_type": "Key", "amount": 27, "description": "Et animi quos velit et fugiat.", "pix_key": "architecto", "end_to_end_id": "architecto", "receiver_reconciliation_id": "architecto", "sender": { "account_type": "architecto", "account_branch": "architecto", "account_number": "architecto", "document_number": "architecto", "name": "architecto" }, "recipient": { "document_number": "architecto", "name": "architecto", "account_type": "architecto", "account_branch": "architecto", "account_number": "architecto", "bank_ispb": "architecto" } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/pix/transfer" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"initialization_type\": \"Key\",
    \"amount\": 27,
    \"description\": \"Et animi quos velit et fugiat.\",
    \"pix_key\": \"architecto\",
    \"end_to_end_id\": \"architecto\",
    \"receiver_reconciliation_id\": \"architecto\",
    \"sender\": {
        \"account_type\": \"architecto\",
        \"account_branch\": \"architecto\",
        \"account_number\": \"architecto\",
        \"document_number\": \"architecto\",
        \"name\": \"architecto\"
    },
    \"recipient\": {
        \"document_number\": \"architecto\",
        \"name\": \"architecto\",
        \"account_type\": \"architecto\",
        \"account_branch\": \"architecto\",
        \"account_number\": \"architecto\",
        \"bank_ispb\": \"architecto\"
    }
}"

GET api/v1/pix/transfer/{authCode}

GET

https://api.brotaspay.com.br

/api/v1/pix/transfer/{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_number

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "account_number": "architecto" }

Received response

Example request:

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

Example response:

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-04-27T00:52:39

payer

object

name

string

required

Example:

architecto

document_number

string

required

Example:

architecto

type

string

required

Must be one of:

CUSTOMER
BUSINESS

Example:

BUSINESS

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-04-27T00:52:39", "payer": { "name": "architecto", "document_number": "architecto", "type": "BUSINESS", "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-04-27T00:52:39\",
    \"payer\": {
        \"name\": \"architecto\",
        \"document_number\": \"architecto\",
        \"type\": \"BUSINESS\",
        \"address\": {
            \"city\": \"architecto\",
            \"state\": \"architecto\",
            \"zip_code\": \"architecto\",
            \"address_line\": \"architecto\",
            \"neighborhood\": \"architecto\"
        }
    }
}"

POST api/v1/pix/qrcode/decode

POST

https://api.brotaspay.com.br

/api/v1/pix/qrcode/decode

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

code

string

required

Example:

architecto

city_code

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "code": "architecto", "city_code": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/pix/qrcode/decode" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"architecto\",
    \"city_code\": \"architecto\"
}"

POST api/v1/pix/claims

POST

https://api.brotaspay.com.br

/api/v1/pix/claims

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

type

string

required

Must be one of:

OWNERSHIP
PORTABILITY

Example:

PORTABILITY

key_type

string

required

Must be one of:

CPF
CNPJ
EMAIL
PHONE

Example:

PHONE

key_value

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "type": "PORTABILITY", "key_type": "PHONE", "key_value": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/pix/claims" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"PORTABILITY\",
    \"key_type\": \"PHONE\",
    \"key_value\": \"architecto\"
}"

GET api/v1/pix/claims

GET

https://api.brotaspay.com.br

/api/v1/pix/claims

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/pix/claims" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

POST api/v1/pix/claims/{id}/confirm

POST

https://api.brotaspay.com.br

/api/v1/pix/claims/{id}/confirm

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the claim.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

POST api/v1/pix/claims/{id}/complete

POST

https://api.brotaspay.com.br

/api/v1/pix/claims/{id}/complete

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the claim.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

POST api/v1/pix/claims/{id}/cancel

POST

https://api.brotaspay.com.br

/api/v1/pix/claims/{id}/cancel

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the claim.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

POST api/v1/pix/totp

POST

https://api.brotaspay.com.br

/api/v1/pix/totp

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

operation

string

required

Must be one of:

RegisterEntry
Ownership
Portability

Example:

Portability

key_type

string

required

Example:

architecto

key_value

string

required

Example:

architecto

pix_key_claim_id

string

Example:

architecto

Auth

Bearer

Headers

Body

{ "operation": "Portability", "key_type": "architecto", "key_value": "architecto", "pix_key_claim_id": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/pix/totp" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"operation\": \"Portability\",
    \"key_type\": \"architecto\",
    \"key_value\": \"architecto\",
    \"pix_key_claim_id\": \"architecto\"
}"

GET api/v1/account/{accountNumber}

GET

https://api.brotaspay.com.br

/api/v1/account/{accountNumber}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

accountNumber

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

Example response:

GET api/v1/account/{accountNumber}/balance

GET

https://api.brotaspay.com.br

/api/v1/account/{accountNumber}/balance

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

accountNumber

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

Example response:

GET api/v1/account/{accountNumber}/statement

GET

https://api.brotaspay.com.br

/api/v1/account/{accountNumber}/statement

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

accountNumber

string

required

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-04-27

end_date

string

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

Example:

2026-04-27

context

string

Must be one of:

Pix
Ted
Boleto
Payment
Authorization
Slc
SLC

Example:

Boleto

direction

string

Must be one of:

IN
OUT
in
out

Example:

out

per_page

integer

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

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "start_date": "2026-04-27", "end_date": "2026-04-27", "context": "Boleto", "direction": "out", "per_page": 1 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/account/architecto/statement" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-04-27\",
    \"end_date\": \"2026-04-27\",
    \"context\": \"Boleto\",
    \"direction\": \"out\",
    \"per_page\": 1
}"

Example response:

GET api/v1/account/{accountNumber}/statement/{transactionId}/receipt

GET

https://api.brotaspay.com.br

/api/v1/account/{accountNumber}/statement/{transactionId}/receipt

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

accountNumber

string

required

Example:

architecto

transactionId

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

Example response:

GET api/v1/account/{accountNumber}/income-report

GET

https://api.brotaspay.com.br

/api/v1/account/{accountNumber}/income-report

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

accountNumber

string

required

Example:

architecto

Body Parameters

year

string

Must be 4 characters.

Example:

bngz

Auth

Bearer

Headers

URL Parameters

Body

{ "year": "bngz" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/account/architecto/income-report" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"year\": \"bngz\"
}"

Example response:

GET api/v1/account/{accountNumber}/tariffs

GET

https://api.brotaspay.com.br

/api/v1/account/{accountNumber}/tariffs

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

accountNumber

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 50.

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/account/architecto/tariffs" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"page\": 16,
    \"per_page\": 22
}"

Example response:

GET api/v1/limits

GET

https://api.brotaspay.com.br

/api/v1/limits

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

feature_name

string

required

Must be one of:

SPI
SPB
Cardholder
PayBill
Withdrawn

Example:

Withdrawn

Auth

Bearer

Headers

Body

{ "feature_name": "Withdrawn" }

Received response

Example request:

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

Example response:

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"

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"

GET api/v1/cards

GET

https://api.brotaspay.com.br

/api/v1/cards

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/cards" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

POST api/v1/cards

POST

https://api.brotaspay.com.br

/api/v1/cards

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

type

string

required

Must be one of:

Virtual
Physical

Example:

Virtual

document_number

string

required

Example:

architecto

card_name

string

required

Example:

architecto

alias

string

required

Example:

architecto

bank_agency

string

required

Example:

architecto

bank_account

string

required

Example:

architecto

program_id

string

required

Example:

architecto

password

string

required

Must be 4 characters.

Example:

ngzm

address

object

zip_code

string

This field is required when address is present.

Example:

architecto

address_line

string

This field is required when address is present.

Example:

architecto

building_number

string

This field is required when address is present.

Example:

architecto

neighborhood

string

This field is required when address is present.

Example:

architecto

city

string

This field is required when address is present.

Example:

architecto

state

string

This field is required when address is present.

Example:

architecto

country

string

This field is required when address is present.

Example:

architecto

complement

string

Example:

architecto

Auth

Bearer

Headers

Body

{ "type": "Virtual", "document_number": "architecto", "card_name": "architecto", "alias": "architecto", "bank_agency": "architecto", "bank_account": "architecto", "program_id": "architecto", "password": "ngzm", "address": { "zip_code": "architecto", "address_line": "architecto", "building_number": "architecto", "neighborhood": "architecto", "city": "architecto", "state": "architecto", "country": "architecto", "complement": "architecto" } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/cards" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"Virtual\",
    \"document_number\": \"architecto\",
    \"card_name\": \"architecto\",
    \"alias\": \"architecto\",
    \"bank_agency\": \"architecto\",
    \"bank_account\": \"architecto\",
    \"program_id\": \"architecto\",
    \"password\": \"ngzm\",
    \"address\": {
        \"zip_code\": \"architecto\",
        \"address_line\": \"architecto\",
        \"building_number\": \"architecto\",
        \"neighborhood\": \"architecto\",
        \"city\": \"architecto\",
        \"state\": \"architecto\",
        \"country\": \"architecto\",
        \"complement\": \"architecto\"
    }
}"

GET api/v1/cards/{proxy}

GET

https://api.brotaspay.com.br

/api/v1/cards/{proxy}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

Example response:

GET api/v1/cards/{proxy}/security-data

GET

https://api.brotaspay.com.br

/api/v1/cards/{proxy}/security-data

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

Example response:

GET api/v1/cards/{proxy}/next-status

GET

https://api.brotaspay.com.br

/api/v1/cards/{proxy}/next-status

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

Example response:

GET api/v1/cards/{proxy}/tracking

GET

https://api.brotaspay.com.br

/api/v1/cards/{proxy}/tracking

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

Example response:

GET api/v1/cards/{proxy}/transactions

GET

https://api.brotaspay.com.br

/api/v1/cards/{proxy}/transactions

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

string

required

Example:

architecto

Body Parameters

account_branch

string

required

Example:

architecto

account_number

string

required

Example:

architecto

page

integer

Must be at least 1.

Example:

items_per_page

integer

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

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "account_branch": "architecto", "account_number": "architecto", "page": 22, "items_per_page": 7 }

Received response

Example request:

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

Example response:

PATCH api/v1/cards/{proxy}/activate

PATCH

https://api.brotaspay.com.br

/api/v1/cards/{proxy}/activate

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

string

required

Example:

architecto

Body Parameters

activate_code

string

required

Example:

architecto

password

string

required

Must be 4 characters.

Example:

ngzm

Auth

Bearer

Headers

URL Parameters

Body

{ "activate_code": "architecto", "password": "ngzm" }

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/cards/architecto/activate" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"activate_code\": \"architecto\",
    \"password\": \"ngzm\"
}"

PATCH api/v1/cards/{proxy}/status

PATCH

https://api.brotaspay.com.br

/api/v1/cards/{proxy}/status

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

string

required

Example:

architecto

Body Parameters

action

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "action": "architecto" }

Received response

Example request:

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

PATCH api/v1/cards/{proxy}/password

PATCH

https://api.brotaspay.com.br

/api/v1/cards/{proxy}/password

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

string

required

Example:

architecto

Body Parameters

password

string

required

Must be 4 characters.

Example:

bngz

Auth

Bearer

Headers

URL Parameters

Body

{ "password": "bngz" }

Received response

Example request:

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

PATCH api/v1/cards/{proxy}/contactless

PATCH

https://api.brotaspay.com.br

/api/v1/cards/{proxy}/contactless

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

string

required

Example:

architecto

Body Parameters

allow_contactless

boolean

required

Example:

true

Auth

Bearer

Headers

URL Parameters

Body

{ "allow_contactless": true }

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/cards/architecto/contactless" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"allow_contactless\": true
}"

PATCH api/v1/cards/{proxy}/address

PATCH

https://api.brotaspay.com.br

/api/v1/cards/{proxy}/address

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

string

required

Example:

architecto

Body Parameters

zip_code

string

required

Example:

architecto

address_line

string

required

Example:

architecto

building_number

string

required

Example:

architecto

neighborhood

string

required

Example:

architecto

city

string

required

Example:

architecto

state

string

required

Example:

architecto

country

string

required

Example:

architecto

complement

string

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "zip_code": "architecto", "address_line": "architecto", "building_number": "architecto", "neighborhood": "architecto", "city": "architecto", "state": "architecto", "country": "architecto", "complement": "architecto" }

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/cards/architecto/address" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"zip_code\": \"architecto\",
    \"address_line\": \"architecto\",
    \"building_number\": \"architecto\",
    \"neighborhood\": \"architecto\",
    \"city\": \"architecto\",
    \"state\": \"architecto\",
    \"country\": \"architecto\",
    \"complement\": \"architecto\"
}"

POST api/v1/cards/{proxy}/reissue

POST

https://api.brotaspay.com.br

/api/v1/cards/{proxy}/reissue

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

POST api/v1/payments/validate

POST

https://api.brotaspay.com.br

/api/v1/payments/validate

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

code

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "code": "architecto" }

Received response

Example request:

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

POST api/v1/payments/confirm

POST

https://api.brotaspay.com.br

/api/v1/payments/confirm

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Example:

architecto

bank_branch

string

required

Example:

architecto

bank_account

string

required

Example:

architecto

amount

number

required

Must be at least 0.01.

Example:

description

string

Example:

Eius et animi quos velit et.

Auth

Bearer

Headers

Body

{ "id": "architecto", "bank_branch": "architecto", "bank_account": "architecto", "amount": 39, "description": "Eius et animi quos velit et." }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/payments/confirm" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"bank_branch\": \"architecto\",
    \"bank_account\": \"architecto\",
    \"amount\": 39,
    \"description\": \"Eius et animi quos velit et.\"
}"

GET api/v1/payments

GET

https://api.brotaspay.com.br

/api/v1/payments

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

account_branch

string

required

Example:

architecto

account_number

string

required

Example:

architecto

page

integer

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

Example:

Auth

Bearer

Headers

Body

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

Received response

Example request:

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

Example response:

GET api/v1/payments/{authCode}

GET

https://api.brotaspay.com.br

/api/v1/payments/{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/payments/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"account_branch\": \"architecto\",
    \"account_number\": \"architecto\"
}"

Example response:

POST api/v1/ted/transfer

POST

https://api.brotaspay.com.br

/api/v1/ted/transfer

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 255 characters.

Example:

Et animi quos velit et fugiat.

sender

object

document

string

required

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

Example:

dljnikhwaykcmy

name

string

required

Example:

architecto

branch

string

required

Example:

architecto

account

string

required

Example:

architecto

recipient

object

document

string

required

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

Example:

ngzmiyvdljnikh

name

string

required

Example:

architecto

bank_code

string

required

Example:

architecto

branch

string

required

Example:

architecto

account

string

required

Example:

architecto

account_type

string

Must be one of:

CHECKING
SAVINGS

Example:

SAVINGS

Auth

Bearer

Headers

Body

{ "amount": 27, "description": "Et animi quos velit et fugiat.", "sender": { "document": "dljnikhwaykcmy", "name": "architecto", "branch": "architecto", "account": "architecto" }, "recipient": { "document": "ngzmiyvdljnikh", "name": "architecto", "bank_code": "architecto", "branch": "architecto", "account": "architecto", "account_type": "SAVINGS" } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/ted/transfer" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"amount\": 27,
    \"description\": \"Et animi quos velit et fugiat.\",
    \"sender\": {
        \"document\": \"dljnikhwaykcmy\",
        \"name\": \"architecto\",
        \"branch\": \"architecto\",
        \"account\": \"architecto\"
    },
    \"recipient\": {
        \"document\": \"ngzmiyvdljnikh\",
        \"name\": \"architecto\",
        \"bank_code\": \"architecto\",
        \"branch\": \"architecto\",
        \"account\": \"architecto\",
        \"account_type\": \"SAVINGS\"
    }
}"

GET api/v1/ted/transactions

GET

https://api.brotaspay.com.br

/api/v1/ted/transactions

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

account_number

string

required

Example:

architecto

account_branch

string

required

Example:

architecto

Auth

Bearer

Headers

Body

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

Received response

Example request:

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

Example response:

GET api/v1/ted/transactions/{authCode}

GET

https://api.brotaspay.com.br

/api/v1/ted/transactions/{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_number

string

required

Example:

architecto

account_branch

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

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

Received response

Example request:

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

Example response:

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:

TED

Auth

Bearer

Headers

Body

{ "product": "TED" }

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\": \"TED\"
}"

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-04-27

close_payment

string

required

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

Example:

2026-04-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:

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-04-27", "close_payment": "2026-04-27", "type": "Deposit", "payer": { "document": "aykcmyuwpwlvqw", "name": "r", "trade_name": "s", "address": { "zip_code": "itcpscql", "address_line": "d", "neighborhood": "z", "city": "s", "state": "nr" } }, "interest": { "start_date": "2026-04-27", "value": 25, "type": "Percent" }, "fine": { "start_date": "2026-04-27", "value": 19, "type": "FixedAmount" }, "discount": { "limit_date": "2026-04-27", "value": 16, "type": "FixedAmountUntilLimitDate" } }

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-04-27\",
    \"close_payment\": \"2026-04-27\",
    \"type\": \"Deposit\",
    \"payer\": {
        \"document\": \"aykcmyuwpwlvqw\",
        \"name\": \"r\",
        \"trade_name\": \"s\",
        \"address\": {
            \"zip_code\": \"itcpscql\",
            \"address_line\": \"d\",
            \"neighborhood\": \"z\",
            \"city\": \"s\",
            \"state\": \"nr\"
        }
    },
    \"interest\": {
        \"start_date\": \"2026-04-27\",
        \"value\": 25,
        \"type\": \"Percent\"
    },
    \"fine\": {
        \"start_date\": \"2026-04-27\",
        \"value\": 19,
        \"type\": \"FixedAmount\"
    },
    \"discount\": {
        \"limit_date\": \"2026-04-27\",
        \"value\": 16,
        \"type\": \"FixedAmountUntilLimitDate\"
    }
}"

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-04-27

end_date

string

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

Example:

2026-04-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-04-27", "end_date": "2026-04-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/boletos" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-04-27\",
    \"end_date\": \"2026-04-27\",
    \"page\": 16,
    \"per_page\": 22,
    \"order_column\": \"status\",
    \"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\"
}"

Generate ticket for data transmission WebView.

POST

https://api.brotaspay.com.br

/api/v1/open-finance/ticket

requires authentication

Used in the deep link flow when a receiving institution redirects here.

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

request_uri

string

required

Example:

architecto

open_finance_client_id

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "request_uri": "architecto", "open_finance_client_id": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/open-finance/ticket" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"request_uri\": \"architecto\",
    \"open_finance_client_id\": \"architecto\"
}"

Generate ticket for consent management WebView.

POST

https://api.brotaspay.com.br

/api/v1/open-finance/consents

requires authentication

redirectType: 1 = Meus Compartilhamentos, 2 = Meus Pagamentos, 3 = Minhas Autorizações

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

redirect_type

integer

required

Must be one of:

Example:

Auth

Bearer

Headers

Body

{ "redirect_type": 3 }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/open-finance/consents" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"redirect_type\": 3
}"

GET api/v1/references/occupations

GET

https://api.brotaspay.com.br

/api/v1/references/occupations

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/references/occupations" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/references/legal-natures

GET

https://api.brotaspay.com.br

/api/v1/references/legal-natures

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/references/legal-natures" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/references/income-ranges

GET

https://api.brotaspay.com.br

/api/v1/references/income-ranges

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/references/income-ranges" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/references/annual-revenue-ranges

GET

https://api.brotaspay.com.br

/api/v1/references/annual-revenue-ranges

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/references/annual-revenue-ranges" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

POST api/v1/register/pf

POST

https://api.brotaspay.com.br

/api/v1/register/pf

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

register_name

string

required

Must not be greater than 255 characters.

Example:

social_name

string

required

Must not be greater than 255 characters.

Example:

document_number

string

required

Must be 11 characters.

Example:

gzmiyvdljni

document_number_photo

string

required

Example:

architecto

document_type

string

required

Must be one of:

RG
CNH

Example:

CNH

issuer_entity

string

required

Example:

architecto

date_number_document_photo

string

required

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

Example:

2026-04-27

string

required

Must be a valid email address.

Example:

zbailey@example.net

password

string

required

Must be at least 8 characters.

Example:

-0pBNvYgxw

birth_date

string

required

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

Example:

2026-04-27

mother_name

string

required

Must not be greater than 255 characters.

Example:

phone

object

required

address

object

required

zip_code

string

required

Example:

architecto

address_line

string

required

Example:

architecto

building_number

string

required

Example:

architecto

neighborhood

string

required

Example:

architecto

city

string

required

Example:

architecto

state

string

required

Must be 2 characters.

Example:

country

string

required

Example:

architecto

occupation

string

required

Example:

architecto

pep

string

required

Must be one of:

NONE
SELF
RELATED

Example:

SELF

asserted_income

number

required

Must be at least 0.

Example:

gender

string

required

Must be one of:

FEMININO
MASCULINO
OUTROS

Example:

OUTROS

nationality

string

required

Must be one of:

BRASILEIRO
ESTRANGEIRO

Example:

BRASILEIRO

relationship_status

string

required

Must be one of:

CASADO
DIVORCIADO
VIUVO
SEPARADO
SOLTEIRO
COMPANHEIRO
UNIAO_ESTAVEL
SEPARADO_JUDICIALMENTE

Example:

SEPARADO

education

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "register_name": "b", "social_name": "n", "document_number": "gzmiyvdljni", "document_number_photo": "architecto", "document_type": "CNH", "issuer_entity": "architecto", "date_number_document_photo": "2026-04-27", "email": "zbailey@example.net", "password": "-0pBNvYgxw", "birth_date": "2026-04-27", "mother_name": "a", "phone": { "country_code": "architecto", "number": "architecto" }, "address": { "zip_code": "architecto", "address_line": "architecto", "building_number": "architecto", "neighborhood": "architecto", "city": "architecto", "state": "ng", "country": "architecto" }, "occupation": "architecto", "pep": "SELF", "asserted_income": 39, "gender": "OUTROS", "nationality": "BRASILEIRO", "relationship_status": "SEPARADO", "education": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/register/pf" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"register_name\": \"b\",
    \"social_name\": \"n\",
    \"document_number\": \"gzmiyvdljni\",
    \"document_number_photo\": \"architecto\",
    \"document_type\": \"CNH\",
    \"issuer_entity\": \"architecto\",
    \"date_number_document_photo\": \"2026-04-27\",
    \"email\": \"zbailey@example.net\",
    \"password\": \"-0pBNvYgxw\",
    \"birth_date\": \"2026-04-27\",
    \"mother_name\": \"a\",
    \"phone\": {
        \"country_code\": \"architecto\",
        \"number\": \"architecto\"
    },
    \"address\": {
        \"zip_code\": \"architecto\",
        \"address_line\": \"architecto\",
        \"building_number\": \"architecto\",
        \"neighborhood\": \"architecto\",
        \"city\": \"architecto\",
        \"state\": \"ng\",
        \"country\": \"architecto\"
    },
    \"occupation\": \"architecto\",
    \"pep\": \"SELF\",
    \"asserted_income\": 39,
    \"gender\": \"OUTROS\",
    \"nationality\": \"BRASILEIRO\",
    \"relationship_status\": \"SEPARADO\",
    \"education\": \"architecto\"
}"

POST api/v1/register/pf/documents

POST

https://api.brotaspay.com.br

/api/v1/register/pf/documents

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

document_type

string

required

Must be one of:

SELFIE
RG
CNH

Example:

CNH

document_side

string

required

Must be one of:

FRONT
BACK

Example:

BACK

provider

string

required

Must be one of:

UNICO_CHECK
BANKLY

Example:

BANKLY

image

file

required

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

Example:

/tmp/phpd1a4all3bvhq4THBm3b

provider_metadata

object

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/register/pf/documents" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "document_type=CNH"\
    --form "document_side=BACK"\
    --form "provider=BANKLY"\
    --form "provider_metadata[isLastDocument]=1"\
    --form "provider_metadata[encrypted]=architecto"\
    --form "image=@/tmp/phpd1a4all3bvhq4THBm3b"

POST api/v1/register/pf/complete

POST

https://api.brotaspay.com.br

/api/v1/register/pf/complete

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/register/pf/complete" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/register/pj/mei

POST

https://api.brotaspay.com.br

/api/v1/register/pj/mei

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

document_number

string

required

Must be 14 characters.

Example:

bngzmiyvdljnik

business_name

string

required

Must not be greater than 255 characters.

Example:

trading_name

string

required

Must not be greater than 255 characters.

Example:

business_email

string

required

Must be a valid email address.

Example:

cormier.nick@example.com

business_type

string

required

Must be one of:

MEI
EI
EIRELLI
SLU

Example:

SLU

business_size

string

required

Must be one of:

MEI
ME
EPP

Example:

password

string

required

Must be at least 8 characters.

Example:

/kXaz<m5L[)~=NG5a:

declared_annual_billing

string

required

Example:

architecto

document_number_personal

string

required

Must be 11 characters.

Example:

ngzmiyvdljn

business_address

object

required

zip_code

string

required

Example:

architecto

address_line

string

required

Example:

architecto

building_number

string

required

Example:

architecto

neighborhood

string

required

Example:

architecto

city

string

required

Example:

architecto

state

string

required

Must be 2 characters.

Example:

country

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "document_number": "bngzmiyvdljnik", "business_name": "h", "trading_name": "w", "business_email": "cormier.nick@example.com", "business_type": "SLU", "business_size": "ME", "password": "\/kXaz\u003Cm5L[)~=NG5a:", "declared_annual_billing": "architecto", "document_number_personal": "ngzmiyvdljn", "business_address": { "zip_code": "architecto", "address_line": "architecto", "building_number": "architecto", "neighborhood": "architecto", "city": "architecto", "state": "ng", "country": "architecto" } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/register/pj/mei" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"document_number\": \"bngzmiyvdljnik\",
    \"business_name\": \"h\",
    \"trading_name\": \"w\",
    \"business_email\": \"cormier.nick@example.com\",
    \"business_type\": \"SLU\",
    \"business_size\": \"ME\",
    \"password\": \"\\/kXaz<m5L[)~=NG5a:\",
    \"declared_annual_billing\": \"architecto\",
    \"document_number_personal\": \"ngzmiyvdljn\",
    \"business_address\": {
        \"zip_code\": \"architecto\",
        \"address_line\": \"architecto\",
        \"building_number\": \"architecto\",
        \"neighborhood\": \"architecto\",
        \"city\": \"architecto\",
        \"state\": \"ng\",
        \"country\": \"architecto\"
    }
}"

POST api/v1/register/pj/documents

POST

https://api.brotaspay.com.br

/api/v1/register/pj/documents

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

cnpj

string

required

Must be 14 characters.

Example:

bngzmiyvdljnik

document_type

string

required

Must be one of:

ARTICLES_OF_INCORPORATION
LAST_CONTRACT_CHANGE
POWER_OF_ATTORNEY
BALANCE_SHEET
PROOF_OF_ADDRESS

Example:

ARTICLES_OF_INCORPORATION

file

required

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

Example:

/tmp/phpvpic0fr0mh471EhiRgs

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/register/pj/documents" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "cnpj=bngzmiyvdljnik"\
    --form "document_type=ARTICLES_OF_INCORPORATION"\
    --form "file=@/tmp/phpvpic0fr0mh471EhiRgs"

POST api/v1/register/pj/representative

POST

https://api.brotaspay.com.br

/api/v1/register/pj/representative

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

cpf

string

required

Must be 11 characters.

Example:

bngzmiyvdlj

document_type

string

required

Must be one of:

SELFIE
RG
CNH

Example:

CNH

document_side

string

required

Must be one of:

FRONT
BACK

Example:

BACK

provider

string

required

Must be one of:

UNICO_CHECK
BANKLY

Example:

BANKLY

image

file

required

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

Example:

/tmp/phpf9jdac96b1hd0m6Tnk7

provider_metadata

object

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/register/pj/representative" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "cpf=bngzmiyvdlj"\
    --form "document_type=CNH"\
    --form "document_side=BACK"\
    --form "provider=BANKLY"\
    --form "image=@/tmp/phpf9jdac96b1hd0m6Tnk7"

POST api/v1/register/pj/enterprise

POST

https://api.brotaspay.com.br

/api/v1/register/pj/enterprise

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

document_number

string

required

Must be 14 characters.

Example:

bngzmiyvdljnik

business_name

string

required

Must not be greater than 255 characters.

Example:

trading_name

string

required

Must not be greater than 255 characters.

Example:

business_email

string

required

Must be a valid email address.

Example:

cormier.nick@example.com

business_type

string

required

Must be one of:

LTDA
SA
TS

Example:

business_size

string

required

Must be one of:

SMALL
MEDIUM
LARGE

Example:

LARGE

cnae_code

string

required

Example:

architecto

legal_nature

string

required

Example:

architecto

opening_date

string

required

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

Example:

2026-04-27

declared_annual_billing

string

required

Example:

architecto

password

string

required

Must be at least 8 characters.

Example:

]|{+-0pBNvYg

phone

object

required

business_address

object

required

Example:

[]

documentation

object

required

Example:

[]

legal_representatives

object

required

Must have at least 1 items.

Example:

[]

owners

object

required

Must have at least 1 items.

Example:

[]

Auth

Bearer

Headers

Body

{ "document_number": "bngzmiyvdljnik", "business_name": "h", "trading_name": "w", "business_email": "cormier.nick@example.com", "business_type": "TS", "business_size": "LARGE", "cnae_code": "architecto", "legal_nature": "architecto", "opening_date": "2026-04-27", "declared_annual_billing": "architecto", "password": "]|{+-0pBNvYg", "phone": { "country_code": "architecto", "number": "architecto" }, "business_address": [], "documentation": [], "legal_representatives": [], "owners": [] }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/register/pj/enterprise" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"document_number\": \"bngzmiyvdljnik\",
    \"business_name\": \"h\",
    \"trading_name\": \"w\",
    \"business_email\": \"cormier.nick@example.com\",
    \"business_type\": \"TS\",
    \"business_size\": \"LARGE\",
    \"cnae_code\": \"architecto\",
    \"legal_nature\": \"architecto\",
    \"opening_date\": \"2026-04-27\",
    \"declared_annual_billing\": \"architecto\",
    \"password\": \"]|{+-0pBNvYg\",
    \"phone\": {
        \"country_code\": \"architecto\",
        \"number\": \"architecto\"
    },
    \"business_address\": [],
    \"documentation\": [],
    \"legal_representatives\": [],
    \"owners\": []
}"

GET api/v1/register/status/{document}

GET

https://api.brotaspay.com.br

/api/v1/register/status/{document}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

document

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

Example response:

POST api/v1/register/kyc/session

POST

https://api.brotaspay.com.br

/api/v1/register/kyc/session

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/register/kyc/session" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Polling endpoint — frontend chama a cada 5s para verificar se o KYC foi concluído.

GET

https://api.brotaspay.com.br

/api/v1/register/kyc/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/register/kyc/status" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

POST api/v1/webhooks/hiperbanco

POST

https://api.brotaspay.com.br

/api/v1/webhooks/hiperbanco

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/webhooks/hiperbanco" \
    --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/account/{accountNumber}

GET

https://api.brotaspay.com.br

/api/v1/external/account/{accountNumber}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

accountNumber

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/account/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/external/account/{accountNumber}/balance

GET

https://api.brotaspay.com.br

/api/v1/external/account/{accountNumber}/balance

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

accountNumber

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/account/architecto/balance" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/external/account/{accountNumber}/statement

GET

https://api.brotaspay.com.br

/api/v1/external/account/{accountNumber}/statement

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

accountNumber

string

required

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-04-27

end_date

string

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

Example:

2026-04-27

context

string

Must be one of:

Pix
Ted
Boleto
Payment
Authorization
Slc
SLC

Example:

Slc

direction

string

Must be one of:

IN
OUT
in
out

Example:

OUT

per_page

integer

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

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "start_date": "2026-04-27", "end_date": "2026-04-27", "context": "Slc", "direction": "OUT", "per_page": 1 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/external/account/architecto/statement" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-04-27\",
    \"end_date\": \"2026-04-27\",
    \"context\": \"Slc\",
    \"direction\": \"OUT\",
    \"per_page\": 1
}"

Example response:

GET api/v1/external/account/{accountNumber}/statement/{transactionId}/receipt

GET

https://api.brotaspay.com.br

/api/v1/external/account/{accountNumber}/statement/{transactionId}/receipt

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

accountNumber

string

required

Example:

architecto

transactionId

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/account/architecto/statement/architecto/receipt" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/external/account/{accountNumber}/income-report

GET

https://api.brotaspay.com.br

/api/v1/external/account/{accountNumber}/income-report

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

accountNumber

string

required

Example:

architecto

Body Parameters

year

string

Must be 4 characters.

Example:

bngz

Auth

Bearer

Headers

URL Parameters

Body

{ "year": "bngz" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/external/account/architecto/income-report" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"year\": \"bngz\"
}"

Example response:

GET api/v1/external/account/{accountNumber}/tariffs

GET

https://api.brotaspay.com.br

/api/v1/external/account/{accountNumber}/tariffs

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

accountNumber

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 50.

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/external/account/architecto/tariffs" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"page\": 16,
    \"per_page\": 22
}"

Example response:

GET api/v1/external/limits

GET

https://api.brotaspay.com.br

/api/v1/external/limits

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

feature_name

string

required

Must be one of:

SPI
SPB
Cardholder
PayBill
Withdrawn

Example:

Cardholder

Auth

Bearer

Headers

Body

{ "feature_name": "Cardholder" }

Received response

Example request:

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

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:

GET api/v1/external/pix/keys

GET

https://api.brotaspay.com.br

/api/v1/external/pix/keys

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

account_number

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "account_number": "architecto" }

Received response

Example request:

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

Example response:

POST api/v1/external/pix/keys

POST

https://api.brotaspay.com.br

/api/v1/external/pix/keys

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

key_type

string

required

Must be one of:

CPF
CNPJ
EMAIL
PHONE
EVP

Example:

CPF

key_value

string

This field is required unless key_type is in EVP.

Example:

architecto

account_type

string

required

Must be one of:

PAYMENT
CHECKING

Example:

PAYMENT

account_branch

string

required

Must be 4 characters.

Example:

ngzm

account_number

string

required

Example:

architecto

totp_code

string

Must be 6 characters.

Example:

ngzmiy

Auth

Bearer

Headers

Body

{ "key_type": "CPF", "key_value": "architecto", "account_type": "PAYMENT", "account_branch": "ngzm", "account_number": "architecto", "totp_code": "ngzmiy" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/external/pix/keys" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"key_type\": \"CPF\",
    \"key_value\": \"architecto\",
    \"account_type\": \"PAYMENT\",
    \"account_branch\": \"ngzm\",
    \"account_number\": \"architecto\",
    \"totp_code\": \"ngzmiy\"
}"

DELETE api/v1/external/pix/keys/{key}

DELETE

https://api.brotaspay.com.br

/api/v1/external/pix/keys/{key}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

key

string

required

The key.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

POST api/v1/external/pix/lookup

POST

https://api.brotaspay.com.br

/api/v1/external/pix/lookup

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

key

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "key": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/external/pix/lookup" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"key\": \"architecto\"
}"

POST api/v1/external/pix/transfer

POST

https://api.brotaspay.com.br

/api/v1/external/pix/transfer

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

initialization_type

string

required

Must be one of:

Key
StaticQrCode
DynamicQrCode
Manual

Example:

Key

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.

pix_key

string

Example:

architecto

end_to_end_id

string

Example:

architecto

receiver_reconciliation_id

string

Example:

architecto

sender

object

account_type

string

required

Example:

architecto

account_branch

string

required

Example:

architecto

account_number

string

required

Example:

architecto

document_number

string

required

Example:

architecto

name

string

required

Example:

architecto

recipient

object

document_number

string

Example:

architecto

name

string

Example:

architecto

account_type

string

Example:

architecto

account_branch

string

Example:

architecto

account_number

string

Example:

architecto

bank_ispb

string

Example:

architecto

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/external/pix/transfer" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"initialization_type\": \"Key\",
    \"amount\": 27,
    \"description\": \"Et animi quos velit et fugiat.\",
    \"pix_key\": \"architecto\",
    \"end_to_end_id\": \"architecto\",
    \"receiver_reconciliation_id\": \"architecto\",
    \"sender\": {
        \"account_type\": \"architecto\",
        \"account_branch\": \"architecto\",
        \"account_number\": \"architecto\",
        \"document_number\": \"architecto\",
        \"name\": \"architecto\"
    },
    \"recipient\": {
        \"document_number\": \"architecto\",
        \"name\": \"architecto\",
        \"account_type\": \"architecto\",
        \"account_branch\": \"architecto\",
        \"account_number\": \"architecto\",
        \"bank_ispb\": \"architecto\"
    }
}"

GET api/v1/external/pix/transfer/{authCode}

GET

https://api.brotaspay.com.br

/api/v1/external/pix/transfer/{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_number

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "account_number": "architecto" }

Received response

Example request:

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

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:

NOT_ALLOWED

recipient_name

string

Example:

architecto

expires_at

string

Must be a valid date.

Example:

2026-04-27T00:52:39

payer

object

name

string

required

Example:

architecto

document_number

string

required

Example:

architecto

type

string

required

Must be one of:

CUSTOMER
BUSINESS

Example:

BUSINESS

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": "NOT_ALLOWED", "recipient_name": "architecto", "expires_at": "2026-04-27T00:52:39", "payer": { "name": "architecto", "document_number": "architecto", "type": "BUSINESS", "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\": \"NOT_ALLOWED\",
    \"recipient_name\": \"architecto\",
    \"expires_at\": \"2026-04-27T00:52:39\",
    \"payer\": {
        \"name\": \"architecto\",
        \"document_number\": \"architecto\",
        \"type\": \"BUSINESS\",
        \"address\": {
            \"city\": \"architecto\",
            \"state\": \"architecto\",
            \"zip_code\": \"architecto\",
            \"address_line\": \"architecto\",
            \"neighborhood\": \"architecto\"
        }
    }
}"

POST api/v1/external/pix/qrcode/decode

POST

https://api.brotaspay.com.br

/api/v1/external/pix/qrcode/decode

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

code

string

required

Example:

architecto

city_code

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "code": "architecto", "city_code": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/external/pix/qrcode/decode" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"architecto\",
    \"city_code\": \"architecto\"
}"

POST api/v1/external/pix/claims

POST

https://api.brotaspay.com.br

/api/v1/external/pix/claims

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

type

string

required

Must be one of:

OWNERSHIP
PORTABILITY

Example:

OWNERSHIP

key_type

string

required

Must be one of:

CPF
CNPJ
EMAIL
PHONE

Example:

CNPJ

key_value

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "type": "OWNERSHIP", "key_type": "CNPJ", "key_value": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/external/pix/claims" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"OWNERSHIP\",
    \"key_type\": \"CNPJ\",
    \"key_value\": \"architecto\"
}"

GET api/v1/external/pix/claims

GET

https://api.brotaspay.com.br

/api/v1/external/pix/claims

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/pix/claims" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

POST api/v1/external/pix/claims/{id}/confirm

POST

https://api.brotaspay.com.br

/api/v1/external/pix/claims/{id}/confirm

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the claim.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/external/pix/claims/architecto/confirm" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/external/pix/claims/{id}/complete

POST

https://api.brotaspay.com.br

/api/v1/external/pix/claims/{id}/complete

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the claim.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/external/pix/claims/architecto/complete" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/external/pix/claims/{id}/cancel

POST

https://api.brotaspay.com.br

/api/v1/external/pix/claims/{id}/cancel

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the claim.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/external/pix/claims/architecto/cancel" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/external/pix/totp

POST

https://api.brotaspay.com.br

/api/v1/external/pix/totp

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

operation

string

required

Must be one of:

RegisterEntry
Ownership
Portability

Example:

Ownership

key_type

string

required

Example:

architecto

key_value

string

required

Example:

architecto

pix_key_claim_id

string

Example:

architecto

Auth

Bearer

Headers

Body

{ "operation": "Ownership", "key_type": "architecto", "key_value": "architecto", "pix_key_claim_id": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/external/pix/totp" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"operation\": \"Ownership\",
    \"key_type\": \"architecto\",
    \"key_value\": \"architecto\",
    \"pix_key_claim_id\": \"architecto\"
}"

POST api/v1/external/ted/transfer

POST

https://api.brotaspay.com.br

/api/v1/external/ted/transfer

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 255 characters.

Example:

Et animi quos velit et fugiat.

sender

object

document

string

required

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

Example:

dljnikhwaykcmy

name

string

required

Example:

architecto

branch

string

required

Example:

architecto

account

string

required

Example:

architecto

recipient

object

document

string

required

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

Example:

ngzmiyvdljnikh

name

string

required

Example:

architecto

bank_code

string

required

Example:

architecto

branch

string

required

Example:

architecto

account

string

required

Example:

architecto

account_type

string

Must be one of:

CHECKING
SAVINGS

Example:

SAVINGS

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/external/ted/transfer" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"amount\": 27,
    \"description\": \"Et animi quos velit et fugiat.\",
    \"sender\": {
        \"document\": \"dljnikhwaykcmy\",
        \"name\": \"architecto\",
        \"branch\": \"architecto\",
        \"account\": \"architecto\"
    },
    \"recipient\": {
        \"document\": \"ngzmiyvdljnikh\",
        \"name\": \"architecto\",
        \"bank_code\": \"architecto\",
        \"branch\": \"architecto\",
        \"account\": \"architecto\",
        \"account_type\": \"SAVINGS\"
    }
}"

GET api/v1/external/ted/transactions

GET

https://api.brotaspay.com.br

/api/v1/external/ted/transactions

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

account_number

string

required

Example:

architecto

account_branch

string

required

Example:

architecto

Auth

Bearer

Headers

Body

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

Received response

Example request:

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

Example response:

GET api/v1/external/ted/transactions/{authCode}

GET

https://api.brotaspay.com.br

/api/v1/external/ted/transactions/{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_number

string

required

Example:

architecto

account_branch

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

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

Received response

Example request:

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

Example response:

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:

PIX

Auth

Bearer

Headers

Body

{ "product": "PIX" }

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\": \"PIX\"
}"

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-04-27

close_payment

string

required

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

Example:

2026-04-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:

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-04-27", "close_payment": "2026-04-27", "type": "Levy", "payer": { "document": "aykcmyuwpwlvqw", "name": "r", "trade_name": "s", "address": { "zip_code": "itcpscql", "address_line": "d", "neighborhood": "z", "city": "s", "state": "nr" } }, "interest": { "start_date": "2026-04-27", "value": 25, "type": "Percent" }, "fine": { "start_date": "2026-04-27", "value": 19, "type": "Percent" }, "discount": { "limit_date": "2026-04-27", "value": 16, "type": "FixedPercentUntilLimitDate" } }

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-04-27\",
    \"close_payment\": \"2026-04-27\",
    \"type\": \"Levy\",
    \"payer\": {
        \"document\": \"aykcmyuwpwlvqw\",
        \"name\": \"r\",
        \"trade_name\": \"s\",
        \"address\": {
            \"zip_code\": \"itcpscql\",
            \"address_line\": \"d\",
            \"neighborhood\": \"z\",
            \"city\": \"s\",
            \"state\": \"nr\"
        }
    },
    \"interest\": {
        \"start_date\": \"2026-04-27\",
        \"value\": 25,
        \"type\": \"Percent\"
    },
    \"fine\": {
        \"start_date\": \"2026-04-27\",
        \"value\": 19,
        \"type\": \"Percent\"
    },
    \"discount\": {
        \"limit_date\": \"2026-04-27\",
        \"value\": 16,
        \"type\": \"FixedPercentUntilLimitDate\"
    }
}"

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-04-27

end_date

string

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

Example:

2026-04-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-04-27", "end_date": "2026-04-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/external/boletos" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-04-27\",
    \"end_date\": \"2026-04-27\",
    \"page\": 16,
    \"per_page\": 22,
    \"order_column\": \"createdAt\",
    \"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/validate

POST

https://api.brotaspay.com.br

/api/v1/external/payments/validate

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

code

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "code": "architecto" }

Received response

Example request:

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

POST api/v1/external/payments/confirm

POST

https://api.brotaspay.com.br

/api/v1/external/payments/confirm

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Example:

architecto

bank_branch

string

required

Example:

architecto

bank_account

string

required

Example:

architecto

amount

number

required

Must be at least 0.01.

Example:

description

string

Example:

Eius et animi quos velit et.

Auth

Bearer

Headers

Body

{ "id": "architecto", "bank_branch": "architecto", "bank_account": "architecto", "amount": 39, "description": "Eius et animi quos velit et." }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/external/payments/confirm" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"bank_branch\": \"architecto\",
    \"bank_account\": \"architecto\",
    \"amount\": 39,
    \"description\": \"Eius et animi quos velit et.\"
}"

GET api/v1/external/payments

GET

https://api.brotaspay.com.br

/api/v1/external/payments

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

account_branch

string

required

Example:

architecto

account_number

string

required

Example:

architecto

page

integer

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

Example:

Auth

Bearer

Headers

Body

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

Received response

Example request:

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

Example response:

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

GET

https://api.brotaspay.com.br

/api/v1/external/payments/{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/payments/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/cards

GET

https://api.brotaspay.com.br

/api/v1/external/cards

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/cards" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

POST api/v1/external/cards

POST

https://api.brotaspay.com.br

/api/v1/external/cards

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

type

string

required

Must be one of:

Virtual
Physical

Example:

Physical

document_number

string

required

Example:

architecto

card_name

string

required

Example:

architecto

alias

string

required

Example:

architecto

bank_agency

string

required

Example:

architecto

bank_account

string

required

Example:

architecto

program_id

string

required

Example:

architecto

password

string

required

Must be 4 characters.

Example:

ngzm

address

object

zip_code

string

This field is required when address is present.

Example:

architecto

address_line

string

This field is required when address is present.

Example:

architecto

building_number

string

This field is required when address is present.

Example:

architecto

neighborhood

string

This field is required when address is present.

Example:

architecto

city

string

This field is required when address is present.

Example:

architecto

state

string

This field is required when address is present.

Example:

architecto

country

string

This field is required when address is present.

Example:

architecto

complement

string

Example:

architecto

Auth

Bearer

Headers

Body

{ "type": "Physical", "document_number": "architecto", "card_name": "architecto", "alias": "architecto", "bank_agency": "architecto", "bank_account": "architecto", "program_id": "architecto", "password": "ngzm", "address": { "zip_code": "architecto", "address_line": "architecto", "building_number": "architecto", "neighborhood": "architecto", "city": "architecto", "state": "architecto", "country": "architecto", "complement": "architecto" } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/external/cards" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"Physical\",
    \"document_number\": \"architecto\",
    \"card_name\": \"architecto\",
    \"alias\": \"architecto\",
    \"bank_agency\": \"architecto\",
    \"bank_account\": \"architecto\",
    \"program_id\": \"architecto\",
    \"password\": \"ngzm\",
    \"address\": {
        \"zip_code\": \"architecto\",
        \"address_line\": \"architecto\",
        \"building_number\": \"architecto\",
        \"neighborhood\": \"architecto\",
        \"city\": \"architecto\",
        \"state\": \"architecto\",
        \"country\": \"architecto\",
        \"complement\": \"architecto\"
    }
}"

GET api/v1/external/cards/{proxy}

GET

https://api.brotaspay.com.br

/api/v1/external/cards/{proxy}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

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/cards/architecto" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/external/cards/{proxy}/security-data

GET

https://api.brotaspay.com.br

/api/v1/external/cards/{proxy}/security-data

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

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/cards/architecto/security-data" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/external/cards/{proxy}/next-status

GET

https://api.brotaspay.com.br

/api/v1/external/cards/{proxy}/next-status

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

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/cards/architecto/next-status" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/external/cards/{proxy}/tracking

GET

https://api.brotaspay.com.br

/api/v1/external/cards/{proxy}/tracking

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

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/cards/architecto/tracking" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET api/v1/external/cards/{proxy}/transactions

GET

https://api.brotaspay.com.br

/api/v1/external/cards/{proxy}/transactions

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

string

required

Example:

architecto

Body Parameters

account_branch

string

required

Example:

architecto

account_number

string

required

Example:

architecto

page

integer

Must be at least 1.

Example:

items_per_page

integer

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

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "account_branch": "architecto", "account_number": "architecto", "page": 22, "items_per_page": 7 }

Received response

Example request:

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

Example response:

PATCH api/v1/external/cards/{proxy}/activate

PATCH

https://api.brotaspay.com.br

/api/v1/external/cards/{proxy}/activate

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

string

required

Example:

architecto

Body Parameters

activate_code

string

required

Example:

architecto

password

string

required

Must be 4 characters.

Example:

ngzm

Auth

Bearer

Headers

URL Parameters

Body

{ "activate_code": "architecto", "password": "ngzm" }

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/external/cards/architecto/activate" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"activate_code\": \"architecto\",
    \"password\": \"ngzm\"
}"

PATCH api/v1/external/cards/{proxy}/status

PATCH

https://api.brotaspay.com.br

/api/v1/external/cards/{proxy}/status

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

string

required

Example:

architecto

Body Parameters

action

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "action": "architecto" }

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/external/cards/architecto/status" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"action\": \"architecto\"
}"

PATCH api/v1/external/cards/{proxy}/password

PATCH

https://api.brotaspay.com.br

/api/v1/external/cards/{proxy}/password

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

string

required

Example:

architecto

Body Parameters

password

string

required

Must be 4 characters.

Example:

bngz

Auth

Bearer

Headers

URL Parameters

Body

{ "password": "bngz" }

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/external/cards/architecto/password" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"bngz\"
}"

PATCH api/v1/external/cards/{proxy}/contactless

PATCH

https://api.brotaspay.com.br

/api/v1/external/cards/{proxy}/contactless

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

string

required

Example:

architecto

Body Parameters

allow_contactless

boolean

required

Example:

false

Auth

Bearer

Headers

URL Parameters

Body

{ "allow_contactless": false }

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/external/cards/architecto/contactless" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"allow_contactless\": false
}"

PATCH api/v1/external/cards/{proxy}/address

PATCH

https://api.brotaspay.com.br

/api/v1/external/cards/{proxy}/address

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

string

required

Example:

architecto

Body Parameters

zip_code

string

required

Example:

architecto

address_line

string

required

Example:

architecto

building_number

string

required

Example:

architecto

neighborhood

string

required

Example:

architecto

city

string

required

Example:

architecto

state

string

required

Example:

architecto

country

string

required

Example:

architecto

complement

string

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request PATCH \
    "https://api.brotaspay.com.br/api/v1/external/cards/architecto/address" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"zip_code\": \"architecto\",
    \"address_line\": \"architecto\",
    \"building_number\": \"architecto\",
    \"neighborhood\": \"architecto\",
    \"city\": \"architecto\",
    \"state\": \"architecto\",
    \"country\": \"architecto\",
    \"complement\": \"architecto\"
}"

POST api/v1/external/cards/{proxy}/reissue

POST

https://api.brotaspay.com.br

/api/v1/external/cards/{proxy}/reissue

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

proxy

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

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:

|]|{+-

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\": \"|]|{+-\"
}"

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/accounts

GET

https://api.brotaspay.com.br

/api/v1/admin/accounts

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-04-27T00:52:39

end_date

string

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

Example:

2052-05-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:

type_user

string

Must be one of:

PF
PJ

Example:

status

string

Must be one of:

ACTIVE
CLOSE
CLOSED
INACTIVE
DELETED
JUDICIAL_BLOCK

Example:

INACTIVE

order_column

string

Must be one of:

createdAt
status

Example:

status

order_direction

string

Must be one of:

ASC
DESC

Example:

ASC

Auth

Bearer

Headers

Body

{ "start_date": "2026-04-27T00:52:39", "end_date": "2052-05-20", "page": 22, "per_page": 7, "search": "z", "type_user": "PF", "status": "INACTIVE", "order_column": "status", "order_direction": "ASC" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/accounts" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-04-27T00:52:39\",
    \"end_date\": \"2052-05-20\",
    \"page\": 22,
    \"per_page\": 7,
    \"search\": \"z\",
    \"type_user\": \"PF\",
    \"status\": \"INACTIVE\",
    \"order_column\": \"status\",
    \"order_direction\": \"ASC\"
}"

Example response:

GET api/v1/admin/accounts/limits

GET

https://api.brotaspay.com.br

/api/v1/admin/accounts/limits

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

document

string

required

Example:

architecto

feature_name

string

required

Must be one of:

SPI
SPB
Cardholder
PayBill
Withdrawn

Example:

Cardholder

Auth

Bearer

Headers

Body

{ "document": "architecto", "feature_name": "Cardholder" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/accounts/limits" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"document\": \"architecto\",
    \"feature_name\": \"Cardholder\"
}"

Example response:

GET api/v1/admin/accounts/{accountId}

GET

https://api.brotaspay.com.br

/api/v1/admin/accounts/{accountId}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

accountId

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

Example response:

GET api/v1/admin/accounts/{accountNumber}/statement

GET

https://api.brotaspay.com.br

/api/v1/admin/accounts/{accountNumber}/statement

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

accountNumber

string

required

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-04-27

end_date

string

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

Example:

2026-04-27

context

string

Must be one of:

Pix
Ted
Boleto
Payment
Authorization
Slc
SLC

Example:

Ted

direction

string

Must be one of:

IN
OUT
in
out

Example:

OUT

per_page

integer

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

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "start_date": "2026-04-27", "end_date": "2026-04-27", "context": "Ted", "direction": "OUT", "per_page": 1 }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/accounts/architecto/statement" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-04-27\",
    \"end_date\": \"2026-04-27\",
    \"context\": \"Ted\",
    \"direction\": \"OUT\",
    \"per_page\": 1
}"

Example response:

POST api/v1/admin/accounts/unblock

POST

https://api.brotaspay.com.br

/api/v1/admin/accounts/unblock

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

onboarding_id

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "onboarding_id": "architecto" }

Received response

Example request:

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

DELETE api/v1/admin/accounts

DELETE

https://api.brotaspay.com.br

/api/v1/admin/accounts

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

onboarding_id

string

required

Example:

architecto

reason

string

required

Must be one of:

HOLDER_REQUEST
COMMERCIAL_DISAGREEMENT

Example:

COMMERCIAL_DISAGREEMENT

notes

string

Must not be greater than 1000 characters.

Example:

Auth

Bearer

Headers

Body

{ "onboarding_id": "architecto", "reason": "COMMERCIAL_DISAGREEMENT", "notes": "n" }

Received response

Example request:

curl --request DELETE \
    "https://api.brotaspay.com.br/api/v1/admin/accounts" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"onboarding_id\": \"architecto\",
    \"reason\": \"COMMERCIAL_DISAGREEMENT\",
    \"notes\": \"n\"
}"

GET api/v1/admin/onboarding

GET

https://api.brotaspay.com.br

/api/v1/admin/onboarding

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-04-27T00:52:39

end_date

string

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

Example:

2052-05-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:

type_user

string

Must be one of:

PF
PJ

Example:

status

string

Must be one of:

APPROVED
PRE_REGISTER
PENDING_APPROVAL
BLACKLISTED
REPROVED

Example:

PENDING_APPROVAL

order_column

string

Must be one of:

createdAt
registerName

Example:

createdAt

order_direction

string

Must be one of:

ASC
DESC

Example:

DESC

Auth

Bearer

Headers

Body

{ "start_date": "2026-04-27T00:52:39", "end_date": "2052-05-20", "page": 22, "per_page": 7, "search": "z", "type_user": "PF", "status": "PENDING_APPROVAL", "order_column": "createdAt", "order_direction": "DESC" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/onboarding" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-04-27T00:52:39\",
    \"end_date\": \"2052-05-20\",
    \"page\": 22,
    \"per_page\": 7,
    \"search\": \"z\",
    \"type_user\": \"PF\",
    \"status\": \"PENDING_APPROVAL\",
    \"order_column\": \"createdAt\",
    \"order_direction\": \"DESC\"
}"

Example response:

GET api/v1/admin/onboarding/{onboardingId}

GET

https://api.brotaspay.com.br

/api/v1/admin/onboarding/{onboardingId}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

onboardingId

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/onboarding/architecto" \
    --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-04-27T00:52:39

end_date

string

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

Example:

2052-05-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:

transaction_type_code

string

Must be one of:

pix
ted
p2p
payment
slc

Example:

slc

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:

IN_PROCESS

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-04-27T00:52:39", "end_date": "2052-05-20", "page": 22, "per_page": 7, "search": "z", "direction": "IN", "transaction_type_code": "slc", "status": "IN_PROCESS", "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-04-27T00:52:39\",
    \"end_date\": \"2052-05-20\",
    \"page\": 22,
    \"per_page\": 7,
    \"search\": \"z\",
    \"direction\": \"IN\",
    \"transaction_type_code\": \"slc\",
    \"status\": \"IN_PROCESS\",
    \"order_column\": \"createdAt\",
    \"order_direction\": \"DESC\"
}"

Example response:

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-04-27

end_date

string

required

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

Example:

2026-04-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-04-27", "end_date": "2026-04-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-04-27\",
    \"end_date\": \"2026-04-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:

Enabled

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": "Enabled", "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\": \"Enabled\",
    \"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:

Boleto

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": "Boleto", "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\": \"Boleto\",
    \"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:

name

order_direction

string

Must be one of:

ASC
DESC

Example:

DESC

Auth

Bearer

Headers

Body

{ "page": 16, "per_page": 22, "search": "g", "order_column": "name", "order_direction": "DESC" }

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\": \"name\",
    \"order_direction\": \"DESC\"
}"

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/phphdm5pqqbkttfa9xeFUR

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/phphdm5pqqbkttfa9xeFUR"

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/php3r6qpumhm7nrfBvJ9lb

plan_default

boolean

required

Example:

true

availability

boolean

required

Example:

true

visibility

boolean

required

Example:

false

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=1"\
    --form "availability=1"\
    --form "visibility="\
    --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/php3r6qpumhm7nrfBvJ9lb"

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/tariffs

GET

https://api.brotaspay.com.br

/api/v1/admin/tariffs

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-04-27T00:52:39

end_date

string

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

Example:

2052-05-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:

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-04-27T00:52:39", "end_date": "2052-05-20", "page": 22, "per_page": 7, "search": "z", "order_column": "createdAt", "order_direction": "DESC" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/tariffs" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-04-27T00:52:39\",
    \"end_date\": \"2052-05-20\",
    \"page\": 22,
    \"per_page\": 7,
    \"search\": \"z\",
    \"order_column\": \"createdAt\",
    \"order_direction\": \"DESC\"
}"

Example response:

POST api/v1/admin/tariffs

POST

https://api.brotaspay.com.br

/api/v1/admin/tariffs

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

account

string

required

Example:

architecto

amount

number

required

Must be at least 0.01.

Example:

description

string

Must not be greater than 255 characters.

Example:

Animi quos velit et fugiat.

apply_immediately

boolean

required

Example:

true

duedate

string

This field is required when apply_immediately is false. Must be a valid date. Must be a date after today.

Example:

2052-05-20

Auth

Bearer

Headers

Body

{ "account": "architecto", "amount": 39, "description": "Animi quos velit et fugiat.", "apply_immediately": true, "duedate": "2052-05-20" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/tariffs" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"account\": \"architecto\",
    \"amount\": 39,
    \"description\": \"Animi quos velit et fugiat.\",
    \"apply_immediately\": true,
    \"duedate\": \"2052-05-20\"
}"

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

GET

https://api.brotaspay.com.br

/api/v1/admin/tariffs/{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 tariff.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

Example response:

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

DELETE

https://api.brotaspay.com.br

/api/v1/admin/tariffs/{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 tariff.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

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

string

required

The ID of the user.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.brotaspay.com.br/api/v1/admin/users/architecto" \
    --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\"
}"

GET api/v1/admin/cards

GET

https://api.brotaspay.com.br

/api/v1/admin/cards

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-04-27T00:52:39

end_date

string

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

Example:

2052-05-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:

type

string

Must be one of:

Virtual
Physical

Example:

Virtual

order_column

string

Must be one of:

createdAt
status

Example:

createdAt

order_direction

string

Must be one of:

ASC
DESC

Example:

DESC

Auth

Bearer

Headers

Body

{ "start_date": "2026-04-27T00:52:39", "end_date": "2052-05-20", "page": 22, "per_page": 7, "search": "z", "type": "Virtual", "order_column": "createdAt", "order_direction": "DESC" }

Received response

Example request:

curl --request GET \
    --get "https://api.brotaspay.com.br/api/v1/admin/cards" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-04-27T00:52:39\",
    \"end_date\": \"2052-05-20\",
    \"page\": 22,
    \"per_page\": 7,
    \"search\": \"z\",
    \"type\": \"Virtual\",
    \"order_column\": \"createdAt\",
    \"order_direction\": \"DESC\"
}"

Example response:

PATCH api/v1/admin/cards/{cardId}/status

PATCH

https://api.brotaspay.com.br

/api/v1/admin/cards/{cardId}/status

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

cardId

string

required

Example:

architecto

Body Parameters

action

string

required

Must be one of:

Accept
Reject
Cancel
Block
Unblock

Example:

Unblock

Auth

Bearer

Headers

URL Parameters

Body

{ "action": "Unblock" }

Received response

Example request:

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

POST api/v1/admin/cards/no-name/batch

POST

https://api.brotaspay.com.br

/api/v1/admin/cards/no-name/batch

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

card_quantity

integer

required

Must be at least 1.

Example:

payment_day

integer

required

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

Example:

address

object

required

zip_code

string

required

Example:

architecto

address

string

required

Example:

architecto

number

string

required

Example:

architecto

neighborhood

string

required

Example:

architecto

city

string

required

Example:

architecto

state

string

required

Must be 2 characters.

Example:

country

string

required

Must be 2 characters.

Example:

complement

string

Example:

architecto

Auth

Bearer

Headers

Body

{ "card_quantity": 16, "payment_day": 22, "address": { "zip_code": "architecto", "address": "architecto", "number": "architecto", "neighborhood": "architecto", "city": "architecto", "state": "ng", "country": "zm", "complement": "architecto" } }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/cards/no-name/batch" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"card_quantity\": 16,
    \"payment_day\": 22,
    \"address\": {
        \"zip_code\": \"architecto\",
        \"address\": \"architecto\",
        \"number\": \"architecto\",
        \"neighborhood\": \"architecto\",
        \"city\": \"architecto\",
        \"state\": \"ng\",
        \"country\": \"zm\",
        \"complement\": \"architecto\"
    }
}"

POST api/v1/admin/cards/no-name/activate

POST

https://api.brotaspay.com.br

/api/v1/admin/cards/no-name/activate

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

activation_code

string

required

Example:

architecto

onboarding_id

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "activation_code": "architecto", "onboarding_id": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/v1/admin/cards/no-name/activate" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"activation_code\": \"architecto\",
    \"onboarding_id\": \"architecto\"
}"

POST api/brotaspay/kyc_processar/{type}

POST

https://api.brotaspay.com.br

/api/brotaspay/kyc_processar/{type}

requires authentication

Headers

Authorization

Example:

Bearer {SEU_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

type

string

required

Example:

pf|pj

Body Parameters

hash

string

required

Example:

architecto

tipo

string

required

Must be one of:

selfie
documento

Example:

selfie

documentType

string

required

Example:

architecto

documentSide

string

required

Must be one of:

FRONT
BACK

Example:

FRONT

provider

string

required

Must be one of:

UNICO_CHECK
BANKLY

Example:

BANKLY

base64

string

required

Example:

architecto

encrypted

string

providerMetadata

string

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "hash": "architecto", "tipo": "selfie", "documentType": "architecto", "documentSide": "FRONT", "provider": "BANKLY", "base64": "architecto", "encrypted": null, "providerMetadata": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.brotaspay.com.br/api/brotaspay/kyc_processar/pf|pj" \
    --header "Authorization: Bearer {SEU_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"hash\": \"architecto\",
    \"tipo\": \"selfie\",
    \"documentType\": \"architecto\",
    \"documentSide\": \"FRONT\",
    \"provider\": \"BANKLY\",
    \"base64\": \"architecto\",
    \"providerMetadata\": \"architecto\"
}"

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\"
}"

BrotasPay — Referência da API

BrotasPay — Referência da API

Introduction

Authenticating requests

Admin · Growth & Retenção

Visão consolidada

Headers

Body Parameters

Funil de ativação

Headers

Query Parameters

Body Parameters

Churn e retenção

Headers

Query Parameters

Body Parameters

Coortes de retenção semanal

Headers

Query Parameters

Body Parameters

NPS — Net Promoter Score

Headers

Query Parameters

Body Parameters

Lista de respostas NPS

Headers

Body Parameters

Endpoints

GET api/v1/user

Headers

POST api/v1/auth/login

Headers

Body Parameters

POST api/v1/auth/verify-2fa

Headers

Body Parameters

POST api/v1/auth/forgot-password

Headers

Body Parameters

POST api/v1/auth/reset-password

Headers

Body Parameters

POST api/v1/auth/logout

Headers

POST api/v1/auth/2fa/enable

Headers

Body Parameters

POST api/v1/auth/2fa/confirm

Headers

Body Parameters

POST api/v1/auth/2fa/disable

Headers

Body Parameters

GET api/v1/auth/2fa/status

Headers

POST api/v1/onboarding/pf

Headers

Body Parameters

POST api/v1/onboarding/pf/documents

Headers

Body Parameters

POST api/v1/onboarding/pf/complete

Headers

Body Parameters

POST api/v1/onboarding/pj/mei

Headers

Body Parameters

POST api/v1/onboarding/pj/documents

Headers

Body Parameters

POST api/v1/onboarding/pj/representative

Headers

Body Parameters

POST api/v1/onboarding/pj/enterprise

Headers

Body Parameters

GET api/v1/onboarding/status

Headers

GET api/v1/pix/keys

Headers