openapi: 3.0.3
info:
title: 'MeuPagamento API Documentation'
description: ''
version: 1.0.0
servers:
-
url: '{{ config("app.url") }}'
tags:
-
name: 'API Tokens'
description: "\nGerenciamento de tokens de API para autenticação"
-
name: 'Autenticação Social'
description: "Inicia o processo de autenticação com um provedor social (Google, Apple ou Facebook).\nRetorna a URL de redirecionamento para o provedor social."
-
name: Endpoints
description: ''
-
name: Extrato
description: ''
-
name: Financiamento
description: ''
-
name: 'My Charges'
description: "\nEndpoints para visualização de cobranças do usuário autenticado.\nAs cobranças são vinculadas dinamicamente por email (verificado ou social login) ou telefone (verificado)."
-
name: 'PIX Manual'
description: "\nGerenciamento de pagamentos PIX Manual"
-
name: 'Pagamentos Manuais'
description: ''
-
name: Payments
description: "\nGerenciamento de pagamentos do sistema"
-
name: Plans
description: "\nGerenciamento de planos de usuários"
-
name: Recipients
description: ''
-
name: 'RelayO Webhooks'
description: 'Recebimento de eventos do RelayO (WhatsApp)'
-
name: 'RelayO WhatsApp Management'
description: 'Lista todas as instâncias WhatsApp disponíveis no RelayO e sincroniza com o banco local.'
-
name: 'Subscription Adjustments'
description: 'Lançamentos variáveis por período de uma assinatura.'
-
name: Subscriptions
description: 'Endpoints para gerenciamento de assinaturas recorrentes.'
-
name: System
description: "\nInformações do sistema"
-
name: Users
description: "\nGerenciamento de usuários do sistema"
-
name: 'Verificação de E-mail'
description: 'Endpoints para verificação de e-mail via código'
-
name: 'Verificação de Telefone'
description: 'Endpoints para verificação de telefone via SMS/WhatsApp'
components:
securitySchemes:
default:
type: http
scheme: bearer
description: 'You can retrieve your token by visiting your dashboard and clicking Generate API token.'
security:
-
default: []
paths:
/api/v1/tokens:
get:
summary: 'Listar tokens de API do usuário'
operationId: listarTokensDeAPIDoUsurio
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Tokens de API obtidos com sucesso'
data:
-
id: 1
name: 'My API Token'
abilities:
- '*'
expires_at: '2024-12-31T23:59:59.000000Z'
created_at: '2024-01-01T00:00:00.000000Z'
last_used_at: '2024-01-15T10:30:00.000000Z'
is_active: true
properties:
message:
type: string
example: 'Tokens de API obtidos com sucesso'
data:
type: array
example:
-
id: 1
name: 'My API Token'
abilities:
- '*'
expires_at: '2024-12-31T23:59:59.000000Z'
created_at: '2024-01-01T00:00:00.000000Z'
last_used_at: '2024-01-15T10:30:00.000000Z'
is_active: true
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'My API Token'
abilities:
type: array
example:
- '*'
items:
type: string
expires_at:
type: string
example: '2024-12-31T23:59:59.000000Z'
created_at:
type: string
example: '2024-01-01T00:00:00.000000Z'
last_used_at:
type: string
example: '2024-01-15T10:30:00.000000Z'
is_active:
type: boolean
example: true
tags:
- 'API Tokens'
post:
summary: 'Criar novo token de API'
operationId: criarNovoTokenDeAPI
description: ''
parameters: []
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Token de API criado com sucesso'
data:
token: 1|abcdef123456...
name: 'My API Token'
abilities:
- read
- write
expires_at: '2024-12-31T23:59:59.000000Z'
properties:
message:
type: string
example: 'Token de API criado com sucesso'
data:
type: object
properties:
token:
type: string
example: 1|abcdef123456...
name:
type: string
example: 'My API Token'
abilities:
type: array
example:
- read
- write
items:
type: string
expires_at:
type: string
example: '2024-12-31T23:59:59.000000Z'
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'The given data was invalid.'
errors:
name:
- 'Nome do token é obrigatório'
properties:
message:
type: string
example: 'The given data was invalid.'
errors:
type: object
properties:
name:
type: array
example:
- 'Nome do token é obrigatório'
items:
type: string
tags:
- 'API Tokens'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Nome do token.'
example: 'My API Token'
abilities:
type: array
description: 'Opcional. Permissões do token.'
example:
- read
- write
items:
type: string
expires_at:
type: string
description: 'Opcional. Data de expiração do token.'
example: '2024-12-31T23:59:59Z'
required:
- name
delete:
summary: 'Revogar todos os tokens de API do usuário'
operationId: revogarTodosOsTokensDeAPIDoUsurio
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'API Tokens'
/api/v1/tokens/current:
get:
summary: 'Obter informações do token atual'
operationId: obterInformaesDoTokenAtual
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'API Tokens'
'/api/v1/tokens/{tokenId}':
delete:
summary: 'Revogar token de API'
operationId: revogarTokenDeAPI
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'API Tokens'
parameters:
-
in: path
name: tokenId
description: ''
example: architecto
required: true
schema:
type: string
'/api/v1/auth/social/redirect/{provider}':
get:
summary: 'Redirecionar para o provedor social'
operationId: redirecionarParaOProvedorSocial
description: ''
parameters: []
responses:
200:
description: success
content:
application/json:
schema:
type: object
example:
success: true
data:
redirect_url: 'https://accounts.google.com/oauth/authorize?...'
provider: google
properties:
success:
type: boolean
example: true
data:
type: object
properties:
redirect_url:
type: string
example: 'https://accounts.google.com/oauth/authorize?...'
provider:
type: string
example: google
500:
description: error
content:
application/json:
schema:
type: object
example:
success: false
message: 'Erro ao iniciar autenticação social'
error: 'Provedor social não suportado: twitter'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Erro ao iniciar autenticação social'
error:
type: string
example: 'Provedor social não suportado: twitter'
tags:
- 'Autenticação Social'
parameters:
-
in: path
name: provider
description: 'O provedor social. Valores aceitos: google, apple, facebook'
example: architecto
required: true
schema:
type: string
'/api/v1/auth/social/callback/{provider}':
get:
summary: 'Processar callback do provedor social'
operationId: processarCallbackDoProvedorSocial
description: ''
parameters: []
responses:
200:
description: success
content:
application/json:
schema:
type: object
example:
success: true
message: 'Login realizado com sucesso'
data:
user:
id: 1
name: 'João Silva'
email: joao@example.com
avatar_url: 'https://lh3.googleusercontent.com/...'
social_provider: google
user_type: debtor
is_verified: true
created_at: '2025-01-27T10:00:00.000000Z'
updated_at: '2025-01-27T10:00:00.000000Z'
token: 1|abcdef123456...
token_type: Bearer
properties:
success:
type: boolean
example: true
message:
type: string
example: 'Login realizado com sucesso'
data:
type: object
properties:
user:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'João Silva'
email:
type: string
example: joao@example.com
avatar_url:
type: string
example: 'https://lh3.googleusercontent.com/...'
social_provider:
type: string
example: google
user_type:
type: string
example: debtor
is_verified:
type: boolean
example: true
created_at:
type: string
example: '2025-01-27T10:00:00.000000Z'
updated_at:
type: string
example: '2025-01-27T10:00:00.000000Z'
token:
type: string
example: 1|abcdef123456...
token_type:
type: string
example: Bearer
400:
description: ''
content:
application/json:
schema:
oneOf:
-
description: invalid_code
type: object
example:
success: false
message: 'Código de autorização não fornecido'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Código de autorização não fornecido'
-
description: invalid_state
type: object
example:
success: false
message: 'Sessão expirada. Tente novamente.'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Sessão expirada. Tente novamente.'
500:
description: error
content:
application/json:
schema:
type: object
example:
success: false
message: 'Erro ao processar autenticação social'
error: 'Erro interno do servidor'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Erro ao processar autenticação social'
error:
type: string
example: 'Erro interno do servidor'
tags:
- 'Autenticação Social'
parameters:
-
in: path
name: provider
description: 'O provedor social. Valores aceitos: google, apple, facebook'
example: architecto
required: true
schema:
type: string
/api/v1/auth/social/connected-accounts:
get:
summary: 'Listar contas sociais conectadas'
operationId: listarContasSociaisConectadas
description: ''
parameters: []
responses:
200:
description: success
content:
application/json:
schema:
type: object
example:
success: true
data:
connected_accounts:
-
provider: google
connected_at: '2025-01-27T10:00:00.000000Z'
avatar_url: 'https://lh3.googleusercontent.com/...'
has_social_login: true
social_provider: google
properties:
success:
type: boolean
example: true
data:
type: object
properties:
connected_accounts:
type: array
example:
-
provider: google
connected_at: '2025-01-27T10:00:00.000000Z'
avatar_url: 'https://lh3.googleusercontent.com/...'
items:
type: object
properties:
provider:
type: string
example: google
connected_at:
type: string
example: '2025-01-27T10:00:00.000000Z'
avatar_url:
type: string
example: 'https://lh3.googleusercontent.com/...'
has_social_login:
type: boolean
example: true
social_provider:
type: string
example: google
500:
description: error
content:
application/json:
schema:
type: object
example:
success: false
message: 'Erro ao listar contas sociais'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Erro ao listar contas sociais'
tags:
- 'Autenticação Social'
'/api/v1/auth/social/disconnect/{provider}':
post:
summary: 'Desconectar conta social'
operationId: desconectarContaSocial
description: ''
parameters: []
responses:
200:
description: success
content:
application/json:
schema:
type: object
example:
success: true
message: 'Conta social desconectada com sucesso'
properties:
success:
type: boolean
example: true
message:
type: string
example: 'Conta social desconectada com sucesso'
400:
description: ''
content:
application/json:
schema:
oneOf:
-
description: invalid_provider
type: object
example:
success: false
message: 'Provedor social inválido'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Provedor social inválido'
-
description: not_connected
type: object
example:
success: false
message: 'Usuário não possui login com este provedor'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Usuário não possui login com este provedor'
500:
description: error
content:
application/json:
schema:
type: object
example:
success: false
message: 'Erro ao desconectar conta social'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Erro ao desconectar conta social'
tags:
- 'Autenticação Social'
parameters:
-
in: path
name: provider
description: 'O provedor social a ser desconectado. Valores aceitos: google, apple, facebook'
example: architecto
required: true
schema:
type: string
/api/v1/health:
get:
summary: ''
operationId: getApiV1Health
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: ok
properties:
status:
type: string
example: ok
tags:
- Endpoints
/api/v1/test:
get:
summary: ''
operationId: getApiV1Test
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Test endpoint working'
properties:
message:
type: string
example: 'Test endpoint working'
tags:
- Endpoints
/api/v1/auth/register:
post:
summary: 'Register a new user'
operationId: registerANewUser
description: ''
parameters: []
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'User registered successfully'
user:
id: 1
name: 'João Silva'
email: joao@example.com
phone: '11999999999'
user_type: individual
is_active: true
properties:
message:
type: string
example: 'User registered successfully'
user:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'João Silva'
email:
type: string
example: joao@example.com
phone:
type: string
example: '11999999999'
user_type:
type: string
example: individual
is_active:
type: boolean
example: true
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Validation failed'
errors:
name:
- 'Nome é obrigatório'
email:
- 'Email é obrigatório'
password:
- 'Senha é obrigatória'
properties:
message:
type: string
example: 'Validation failed'
errors:
type: object
properties:
name:
type: array
example:
- 'Nome é obrigatório'
items:
type: string
email:
type: array
example:
- 'Email é obrigatório'
items:
type: string
password:
type: array
example:
- 'Senha é obrigatória'
items:
type: string
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Nome completo do usuário.'
example: 'João Silva'
email:
type: string
description: 'Email do usuário.'
example: joao@example.com
password:
type: string
description: 'Senha do usuário (mínimo 8 caracteres).'
example: password123
password_confirmation:
type: string
description: 'Confirmação da senha.'
example: password123
phone:
type: string
description: 'Opcional. Telefone do usuário.'
example: '11999999999'
document:
type: string
description: 'Opcional. Documento do usuário.'
example: '12345678901'
user_type:
type: string
description: 'Opcional. Tipo do usuário.'
example: individual
required:
- name
- email
- password
- password_confirmation
/api/v1/auth/login:
post:
summary: 'Login user'
operationId: loginUser
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Login successful'
user:
id: 1
name: 'João Silva'
email: joao@example.com
phone: '11999999999'
user_type: individual
is_active: true
token: 1|abcdef123456...
properties:
message:
type: string
example: 'Login successful'
user:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'João Silva'
email:
type: string
example: joao@example.com
phone:
type: string
example: '11999999999'
user_type:
type: string
example: individual
is_active:
type: boolean
example: true
token:
type: string
example: 1|abcdef123456...
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Credenciais inválidas'
properties:
message:
type: string
example: 'Credenciais inválidas'
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'Email do usuário.'
example: joao@example.com
password:
type: string
description: 'Senha do usuário.'
example: password123
required:
- email
- password
/api/v1/auth/reset-password:
post:
summary: 'Reset password'
operationId: resetPassword
description: ''
parameters: []
responses:
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Validation failed'
errors:
email:
- 'The email field is required.'
properties:
message:
type: string
example: 'Validation failed'
errors:
type: object
properties:
email:
type: array
example:
- 'The email field is required.'
items:
type: string
tags:
- Endpoints
/api/v1/auth/verify-reset-token:
post:
summary: 'Verify password reset token'
operationId: verifyPasswordResetToken
description: ''
parameters: []
responses:
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Validation failed'
errors:
email:
- 'The email field is required.'
token:
- 'The token field is required.'
properties:
message:
type: string
example: 'Validation failed'
errors:
type: object
properties:
email:
type: array
example:
- 'The email field is required.'
items:
type: string
token:
type: array
example:
- 'The token field is required.'
items:
type: string
tags:
- Endpoints
/api/v1/auth/update-password-with-token:
post:
summary: 'Update password with reset token'
operationId: updatePasswordWithResetToken
description: ''
parameters: []
responses:
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Validation failed'
errors:
email:
- 'The email field is required.'
token:
- 'The token field is required.'
password:
- 'The password field is required.'
properties:
message:
type: string
example: 'Validation failed'
errors:
type: object
properties:
email:
type: array
example:
- 'The email field is required.'
items:
type: string
token:
type: array
example:
- 'The token field is required.'
items:
type: string
password:
type: array
example:
- 'The password field is required.'
items:
type: string
tags:
- Endpoints
/api/v1/auth/logout:
post:
summary: 'Logout user'
operationId: logoutUser
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/auth/me:
get:
summary: 'Get authenticated user'
operationId: getAuthenticatedUser
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/user:
get:
summary: ''
operationId: getApiV1User
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/recipients:
get:
summary: 'Display a listing of recipients.'
operationId: displayAListingOfRecipients
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
post:
summary: 'Store a newly created recipient.'
operationId: storeANewlyCreatedRecipient
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/recipients/validate-document:
post:
summary: 'Validate document.'
operationId: validateDocument
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
'/api/v1/recipients/{id}':
get:
summary: 'Display the specified recipient.'
operationId: displayTheSpecifiedRecipient
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
put:
summary: 'Update the specified recipient.'
operationId: updateTheSpecifiedRecipient
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
delete:
summary: 'Remove the specified recipient.'
operationId: removeTheSpecifiedRecipient
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the recipient.'
example: '564'
required: true
schema:
type: string
'/api/v1/recipients/{id}/history':
get:
summary: 'Get recipient history.'
operationId: getRecipientHistory
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the recipient.'
example: '564'
required: true
schema:
type: string
/api/v1/charges:
get:
summary: 'Listar cobranças'
operationId: listarCobranas
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
post:
summary: 'Criar nova cobrança'
operationId: criarNovaCobrana
description: ''
parameters: []
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Cobrança criada com sucesso'
data:
id: 1
description: 'Pagamento de serviços'
amount: 100.5
due_date: '2024-12-31'
status: pending
recipient_id: 1
created_at: '2024-01-01T00:00:00.000000Z'
properties:
message:
type: string
example: 'Cobrança criada com sucesso'
data:
type: object
properties:
id:
type: integer
example: 1
description:
type: string
example: 'Pagamento de serviços'
amount:
type: number
example: 100.5
due_date:
type: string
example: '2024-12-31'
status:
type: string
example: pending
recipient_id:
type: integer
example: 1
created_at:
type: string
example: '2024-01-01T00:00:00.000000Z'
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'The given data was invalid.'
errors:
description:
- 'Descrição é obrigatória'
amount:
- 'Valor é obrigatório'
properties:
message:
type: string
example: 'The given data was invalid.'
errors:
type: object
properties:
description:
type: array
example:
- 'Descrição é obrigatória'
items:
type: string
amount:
type: array
example:
- 'Valor é obrigatório'
items:
type: string
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
description:
type: string
description: 'Descrição da cobrança'
example: 'Pagamento de serviços'
amount:
type: numeric
description: 'Valor da cobrança'
example: '100.50'
due_date:
type: date
description: 'Data de vencimento'
example: '2024-12-31'
recipient_id:
type: integer
description: 'ID do destinatário'
example: 1
installments:
type: integer
description: 'Opcional. Número de parcelas'
example: 3
payment_methods:
type: array
description: 'Opcional. Métodos de pagamento aceitos'
example:
- pix
- credit_card
items:
type: string
metadata:
type: object
description: 'Opcional. Metadados adicionais'
example:
order_id: '12345'
properties: { }
required:
- description
- amount
- due_date
- recipient_id
/api/v1/charges/test:
post:
summary: ''
operationId: postApiV1ChargesTest
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/charges/new:
post:
summary: ''
operationId: postApiV1ChargesNew
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/charges/metrics:
get:
summary: 'Obter métricas de cobranças'
operationId: obterMtricasDeCobranas
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/charges/summary:
get:
summary: 'Obter resumo das cobranças (alias para statistics)'
operationId: obterResumoDasCobranasaliasParaStatistics
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/charges/statistics:
get:
summary: 'Obter estatísticas das cobranças'
operationId: obterEstatsticasDasCobranas
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
'/api/v1/charges/{id}':
get:
summary: 'Obter cobrança específica'
operationId: obterCobranaEspecfica
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
put:
summary: 'Atualizar cobrança'
operationId: atualizarCobrana
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the charge.'
example: architecto
required: true
schema:
type: string
'/api/v1/charges/{id}/cancel':
post:
summary: 'Cancelar cobrança'
operationId: cancelarCobrana
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the charge.'
example: architecto
required: true
schema:
type: string
'/api/v1/charges/{id}/resend':
post:
summary: 'Reenviar notificação de cobrança'
operationId: reenviarNotificaoDeCobrana
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Notificação reenviada com sucesso'
data:
id: ''
channel: email
properties:
message:
type: string
example: 'Notificação reenviada com sucesso'
data:
type: object
properties:
id:
type: string
example: ''
channel:
type: string
example: email
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
channel:
type: string
description: 'Canal de notificação. Ex.: email|sms|whatsapp'
example: email
required:
- channel
parameters:
-
in: path
name: id
description: 'The ID of the charge.'
example: architecto
required: true
schema:
type: string
'/api/v1/charges/{id}/payment-link':
post:
summary: 'Gerar link de pagamento'
operationId: gerarLinkDePagamento
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the charge.'
example: architecto
required: true
schema:
type: string
'/api/v1/charges/{id}/fees':
get:
summary: 'Calcular taxas'
operationId: calcularTaxas
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the charge.'
example: architecto
required: true
schema:
type: string
'/api/v1/charges/{id}/pending-installments':
get:
summary: 'Obter parcelas pendentes de uma cobrança'
operationId: obterParcelasPendentesDeUmaCobrana
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the charge.'
example: architecto
required: true
schema:
type: string
'/api/v1/charges/{id}/financial-summary':
get:
summary: 'Obter resumo financeiro da cobrança'
operationId: obterResumoFinanceiroDaCobrana
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the charge.'
example: architecto
required: true
schema:
type: string
/api/v1/dashboard/metrics:
get:
summary: 'Obter métricas gerais do dashboard'
operationId: obterMtricasGeraisDoDashboard
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/dashboard/charges:
get:
summary: 'Obter métricas de cobranças'
operationId: obterMtricasDeCobranas
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/dashboard/payments:
get:
summary: 'Obter métricas de pagamentos'
operationId: obterMtricasDePagamentos
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/dashboard/users:
get:
summary: 'Obter métricas de usuários'
operationId: obterMtricasDeUsurios
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/dashboard/debtors:
get:
summary: 'Obter métricas de devedores'
operationId: obterMtricasDeDevedores
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/dashboard/revenue:
get:
summary: 'Obter métricas de receita'
operationId: obterMtricasDeReceita
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/dashboard/performance:
get:
summary: 'Obter métricas de performance'
operationId: obterMtricasDePerformance
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
'/api/v1/dashboard/chart/{type}':
get:
summary: 'Obter dados para gráficos'
operationId: obterDadosParaGrficos
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: type
description: ''
example: architecto
required: true
schema:
type: string
/api/v1/dashboard/activities:
get:
summary: 'Obter atividades recentes'
operationId: obterAtividadesRecentes
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/dashboard/alerts:
get:
summary: 'Obter alertas e notificações'
operationId: obterAlertasENotificaes
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/dashboard/realtime:
get:
summary: 'Obter métricas em tempo real'
operationId: obterMtricasEmTempoReal
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/dashboard/usage:
get:
summary: 'Obter estatísticas de uso'
operationId: obterEstatsticasDeUso
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/dashboard/summary:
get:
summary: 'Obter resumo completo do dashboard'
operationId: obterResumoCompletoDoDashboard
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/dashboard/ledger:
get:
summary: 'Obter métricas do extrato'
operationId: obterMtricasDoExtrato
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/dashboard/ledger/summary:
get:
summary: 'Obter resumo do extrato'
operationId: obterResumoDoExtrato
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/dashboard/clear-cache:
post:
summary: 'Limpar cache do dashboard'
operationId: limparCacheDoDashboard
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/calculator/calculate:
get:
summary: 'Calcular taxas e valores de pagamento'
operationId: calcularTaxasEValoresDePagamento
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/calculator/fees:
get:
summary: 'Calcular apenas taxas (método simplificado)'
operationId: calcularApenasTaxasmtodoSimplificado
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/calculator/payment-methods:
get:
summary: 'Obter métodos de pagamento disponíveis'
operationId: obterMtodosDePagamentoDisponveis
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/manual-payments/methods:
get:
summary: 'Obter métodos de pagamento manual disponíveis'
operationId: obterMtodosDePagamentoManualDisponveis
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/manual-payments/validate:
post:
summary: 'Validar dados de pagamento manual'
operationId: validarDadosDePagamentoManual
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/v1/ledger/summary:
get:
summary: 'Get ledger summary for dashboard'
operationId: getLedgerSummaryForDashboard
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
'/api/v1/ledger/{id}':
get:
summary: 'Get specific ledger entry'
operationId: getSpecificLedgerEntry
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the ledger.'
example: 1
required: true
schema:
type: integer
/api/v1/bank-accounts:
get:
summary: ''
operationId: getApiV1BankAccounts
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
post:
summary: ''
operationId: postApiV1BankAccounts
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
'/api/v1/bank-accounts/{id}':
get:
summary: ''
operationId: getApiV1BankAccountsId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
put:
summary: ''
operationId: putApiV1BankAccountsId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
delete:
summary: ''
operationId: deleteApiV1BankAccountsId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the bank account.'
example: '564'
required: true
schema:
type: string
/api/v1/penalty-settings:
get:
summary: ''
operationId: getApiV1PenaltySettings
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
put:
summary: ''
operationId: putApiV1PenaltySettings
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
'/api/v1/public/charge/{id}':
get:
summary: 'Exibir cobrança pública por ID (ULID)'
operationId: exibirCobranaPblicaPorIDULID
description: ''
parameters: []
responses:
404:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Cobrança não encontrada'
error: CHARGE_NOT_FOUND
properties:
message:
type: string
example: 'Cobrança não encontrada'
error:
type: string
example: CHARGE_NOT_FOUND
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the charge.'
example: architecto
required: true
schema:
type: string
/api/v1/public/calculator/calculate:
get:
summary: 'Calcular taxas e valores de pagamento'
operationId: calcularTaxasEValoresDePagamento
description: ''
parameters: []
responses:
422:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Parâmetros inválidos'
errors:
total_amount:
- 'The total amount field is required.'
installments:
- 'The installments field is required.'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Parâmetros inválidos'
errors:
type: object
properties:
total_amount:
type: array
example:
- 'The total amount field is required.'
items:
type: string
installments:
type: array
example:
- 'The installments field is required.'
items:
type: string
tags:
- Endpoints
/api/v1/public/calculator/fees:
get:
summary: 'Calcular apenas taxas (método simplificado)'
operationId: calcularApenasTaxasmtodoSimplificado
description: ''
parameters: []
responses:
422:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Parâmetros inválidos'
errors:
total_amount:
- 'The total amount field is required.'
installments:
- 'The installments field is required.'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Parâmetros inválidos'
errors:
type: object
properties:
total_amount:
type: array
example:
- 'The total amount field is required.'
items:
type: string
installments:
type: array
example:
- 'The installments field is required.'
items:
type: string
tags:
- Endpoints
/api/v1/public/calculator/payment-methods:
get:
summary: 'Obter métodos de pagamento disponíveis'
operationId: obterMtodosDePagamentoDisponveis
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
-
value: pix
name: PIX
description: 'Pagamento instantâneo via PIX'
fee_percentage: '0.9900'
min_fee: '0.30'
max_fee: null
is_instant: true
requires_qr_code: true
is_card: false
is_manual: false
metadata:
icon: pix
color: '#32BCAD'
gateway: pix
-
value: pix_manual
name: 'PIX Manual'
description: 'PIX com confirmação manual'
fee_percentage: '0.0000'
min_fee: '0.00'
max_fee: null
is_instant: true
requires_qr_code: true
is_card: false
is_manual: true
metadata:
icon: pix
color: '#32BCAD'
gateway: pix_manual
-
value: credit_card
name: 'Cartão de Crédito'
description: 'Pagamento com cartão de crédito'
fee_percentage: '3.4900'
min_fee: '0.50'
max_fee: null
is_instant: true
requires_qr_code: false
is_card: true
is_manual: false
metadata:
icon: credit-card
color: '#007BFF'
gateway: stripe
supports_installments: true
-
value: debit_card
name: 'Cartão de Débito'
description: 'Pagamento com cartão de débito'
fee_percentage: '1.9900'
min_fee: '0.30'
max_fee: null
is_instant: true
requires_qr_code: false
is_card: true
is_manual: false
metadata:
icon: credit-card
color: '#28A745'
gateway: stripe
supports_installments: false
-
value: bank_slip
name: 'Boleto Bancário'
description: 'Pagamento via boleto bancário'
fee_percentage: '1.4500'
min_fee: '0.30'
max_fee: null
is_instant: false
requires_qr_code: false
is_card: false
is_manual: false
metadata:
icon: barcode
color: '#FFC107'
gateway: boleto
processing_days: 1
-
value: manual
name: 'Pagamento Manual'
description: 'Pagamento com confirmação manual'
fee_percentage: '0.0000'
min_fee: '0.00'
max_fee: null
is_instant: true
requires_qr_code: false
is_card: false
is_manual: true
metadata:
icon: hand
color: '#6C757D'
gateway: manual
message: 'Métodos de pagamento obtidos com sucesso'
properties:
success:
type: boolean
example: true
data:
type: array
example:
-
value: pix
name: PIX
description: 'Pagamento instantâneo via PIX'
fee_percentage: '0.9900'
min_fee: '0.30'
max_fee: null
is_instant: true
requires_qr_code: true
is_card: false
is_manual: false
metadata:
icon: pix
color: '#32BCAD'
gateway: pix
-
value: pix_manual
name: 'PIX Manual'
description: 'PIX com confirmação manual'
fee_percentage: '0.0000'
min_fee: '0.00'
max_fee: null
is_instant: true
requires_qr_code: true
is_card: false
is_manual: true
metadata:
icon: pix
color: '#32BCAD'
gateway: pix_manual
-
value: credit_card
name: 'Cartão de Crédito'
description: 'Pagamento com cartão de crédito'
fee_percentage: '3.4900'
min_fee: '0.50'
max_fee: null
is_instant: true
requires_qr_code: false
is_card: true
is_manual: false
metadata:
icon: credit-card
color: '#007BFF'
gateway: stripe
supports_installments: true
-
value: debit_card
name: 'Cartão de Débito'
description: 'Pagamento com cartão de débito'
fee_percentage: '1.9900'
min_fee: '0.30'
max_fee: null
is_instant: true
requires_qr_code: false
is_card: true
is_manual: false
metadata:
icon: credit-card
color: '#28A745'
gateway: stripe
supports_installments: false
-
value: bank_slip
name: 'Boleto Bancário'
description: 'Pagamento via boleto bancário'
fee_percentage: '1.4500'
min_fee: '0.30'
max_fee: null
is_instant: false
requires_qr_code: false
is_card: false
is_manual: false
metadata:
icon: barcode
color: '#FFC107'
gateway: boleto
processing_days: 1
-
value: manual
name: 'Pagamento Manual'
description: 'Pagamento com confirmação manual'
fee_percentage: '0.0000'
min_fee: '0.00'
max_fee: null
is_instant: true
requires_qr_code: false
is_card: false
is_manual: true
metadata:
icon: hand
color: '#6C757D'
gateway: manual
items:
type: object
properties:
value:
type: string
example: pix
name:
type: string
example: PIX
description:
type: string
example: 'Pagamento instantâneo via PIX'
fee_percentage:
type: string
example: '0.9900'
min_fee:
type: string
example: '0.30'
max_fee:
type: string
example: null
is_instant:
type: boolean
example: true
requires_qr_code:
type: boolean
example: true
is_card:
type: boolean
example: false
is_manual:
type: boolean
example: false
metadata:
type: object
properties:
icon:
type: string
example: pix
color:
type: string
example: '#32BCAD'
gateway:
type: string
example: pix
message:
type: string
example: 'Métodos de pagamento obtidos com sucesso'
tags:
- Endpoints
/api/v1/banks:
get:
summary: ''
operationId: getApiV1Banks
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
current_page: 1
data:
-
id: 116
COMPE: '237'
ISPB: '60746948'
Document: 60.746.948/0001-12
LongName: 'Banco Bradesco S.A.'
ShortName: 'BCO BRADESCO S.A.'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 1
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: 'Banco folha e Destinatário'
Products: 'Capital de Giro,Cheque Especial,Consignado,Imobiliário,Pessoal,Troca de Modalidade,Veículos'
Url: 'https://www.bradesco.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 1
COMPE: '001'
ISPB: '00000000'
Document: 00.000.000/0001-91
LongName: 'Banco do Brasil S.A.'
ShortName: 'BCO DO BRASIL S.A.'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 1
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: 'Banco folha e Destinatário'
Products: 'Capital de Giro,Cheque Especial,Consignado,Imobiliário,Outros Créditos,Pessoal,Troca de Modalidade,Veículos'
Url: 'https://www.bb.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 17
COMPE: '033'
ISPB: '90400888'
Document: 90.400.888/0001-42
LongName: 'BANCO SANTANDER (BRASIL) S.A.'
ShortName: 'BCO SANTANDER (BRASIL) S.A.'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 1
DetectaFlow: 1
PCR: 1
PCRP: 1
SalaryPortability: 'Banco folha e Destinatário'
Products: 'Capital de Giro,Cheque Especial,Consignado,Imobiliário,Pessoal,Troca de Modalidade,Veículos'
Url: 'https://www.santander.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 57
COMPE: '104'
ISPB: '00360305'
Document: 00.360.305/0001-04
LongName: 'Caixa Econômica Federal'
ShortName: 'CAIXA ECONOMICA FEDERAL'
Network: 'Caixa Econômica Federal'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 1
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: 'Banco folha e Destinatário'
Products: 'Capital de Giro,Cheque Especial,Consignado,Imobiário,Pessoal,Troca de Modalidade,Veículos'
Url: 'https://caixa.gov.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 180
COMPE: '341'
ISPB: '60701190'
Document: 60.701.190/0001-04
LongName: 'ITAÚ UNIBANCO S.A.'
ShortName: 'ITAÚ UNIBANCO S.A.'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 1
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: 'Banco folha e Destinatário'
Products: 'Capital de Giro,Cheque Especial,Consignado,Imobiliário,Outros Créditos,Pessoal,Troca de Modalidade,Veículos'
Url: 'https://www.itau.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 403
COMPE: '644'
ISPB: '54647259'
Document: 54.647.259/0001-58
LongName: '321 SOCIEDADE DE CRÉDITO DIRETO S.A.'
ShortName: '321 SCD S.A.'
Network: null
Type: null
PixType: Internet
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2024-06-13'
DatePixStarted: null
DateRegistered: '2024-06-07 12:08:28'
DateUpdated: '2024-06-07 12:08:28'
created_at: null
updated_at: null
-
id: 475
COMPE: '769'
ISPB: '24313102'
Document: 24.313.102/0001-25
LongName: '99PAY INSTITUICAO DE PAGAMENTO S.A.'
ShortName: '99PAY IP S.A.'
Network: null
Type: DRCT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2025-08-18'
DatePixStarted: '2025-08-18 10:10:00'
DateRegistered: '2025-08-18 12:09:55'
DateUpdated: '2025-08-19 12:09:19'
created_at: null
updated_at: null
-
id: 359
COMPE: '574'
ISPB: '48756121'
Document: 48.756.121/0001-94
LongName: 'A55 SOCIEDADE DE CRÉDITO DIRETO S.A.'
ShortName: 'A55 SCD S.A.'
Network: null
Type: DRCT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2025-02-21'
DatePixStarted: '2025-02-21 11:00:00'
DateRegistered: '2025-02-17 12:08:34'
DateUpdated: '2025-02-18 12:08:11'
created_at: null
updated_at: null
-
id: 230
COMPE: '406'
ISPB: '37715993'
Document: 37.715.993/0001-98
LongName: 'ACCREDITO - SOCIEDADE DE CRÉDITO DIRETO S.A.'
ShortName: 'ACCREDITO SCD S.A.'
Network: null
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2020-11-27'
DatePixStarted: '2023-03-15 10:00:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 175
COMPE: '332'
ISPB: '13140088'
Document: 13.140.088/0001-99
LongName: 'ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO'
ShortName: 'ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO'
Network: null
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: 'Banco folha e Destinatário'
Products: null
Url: null
DateOperationStarted: '2019-08-16'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2022-12-13 12:06:52'
created_at: null
updated_at: null
-
id: 414
COMPE: '663'
ISPB: '44782130'
Document: 44.782.130/0001-07
LongName: 'ACTUAL DISTRIBUIDORA DE TÍTULOS E VALORES MOBILIÁRIOS S.A.'
ShortName: 'ACTUAL DTVM S.A.'
Network: null
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2024-12-16'
DatePixStarted: null
DateRegistered: '2024-12-10 12:09:00'
DateUpdated: '2024-12-10 12:09:00'
created_at: null
updated_at: null
-
id: 64
COMPE: '117'
ISPB: '92856905'
Document: 92.856.905/0001-86
LongName: 'ADVANCED CORRETORA DE CÂMBIO LTDA'
ShortName: 'ADVANCED CC LTDA'
Network: null
Type: null
PixType: Internet
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: 'https://advancedcorretora.com.br/'
DateOperationStarted: '2011-10-03'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2021-05-05 09:11:12'
created_at: null
updated_at: null
-
id: 132
COMPE: '272'
ISPB: '00250699'
Document: 00.250.699/0001-48
LongName: 'AGK CORRETORA DE CAMBIO S.A.'
ShortName: 'AGK CC S.A.'
Network: null
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2018-11-21'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2021-05-05 09:11:12'
created_at: null
updated_at: null
-
id: 353
COMPE: '565'
ISPB: '74014747'
Document: 74.014.747/0001-35
LongName: 'ÁGORA CORRETORA DE TITULOS E VALORES MOBILIARIOS S.A.'
ShortName: 'ÁGORA CTVM S.A.'
Network: null
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2023-11-20'
DatePixStarted: null
DateRegistered: '2023-11-14 12:06:11'
DateUpdated: '2023-11-14 12:06:11'
created_at: null
updated_at: null
-
id: 383
COMPE: '599'
ISPB: '36321990'
Document: 36.321.990/0001-07
LongName: 'AGORACRED S/A SOCIEDADE DE CRÉDITO, FINANCIAMENTO E INVESTIMENTO'
ShortName: 'AGORACRED S/A SCFI'
Network: null
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2024-08-07'
DatePixStarted: null
DateRegistered: '2024-08-05 12:07:23'
DateUpdated: '2024-08-05 12:07:23'
created_at: null
updated_at: null
-
id: 184
COMPE: '349'
ISPB: '27214112'
Document: 27.214.112/0001-00
LongName: 'AL5 S.A. CRÉDITO, FINANCIAMENTO E INVESTIMENTO'
ShortName: 'AL5 S.A. CFI'
Network: null
Type: IDRT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: 'Banco folha e Destinatário'
Products: 'Capital de Giro,Consignado,Imobiliário,Outros,Pessoal,Troca de Modalidade,Veículos'
Url: null
DateOperationStarted: '2019-10-24'
DatePixStarted: '2023-08-01 15:22:55'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2023-10-21 12:05:56'
created_at: null
updated_at: null
-
id: 358
COMPE: '572'
ISPB: '51414521'
Document: 51.414.521/0001-26
LongName: 'ALL IN CRED SOCIEDADE DE CREDITO DIRETO S.A.'
ShortName: 'ALL IN CRED SCD S.A.'
Network: null
Type: DRCT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2023-12-22'
DatePixStarted: '2024-12-10 11:00:00'
DateRegistered: '2023-12-18 12:06:50'
DateUpdated: '2024-12-05 12:08:35'
created_at: null
updated_at: null
-
id: 160
COMPE: '313'
ISPB: '16927221'
Document: 16.927.221/0001-40
LongName: 'AMAZÔNIA CORRETORA DE CÂMBIO LTDA.'
ShortName: 'AMAZÔNIA CC LTDA.'
Network: null
Type: null
PixType: Internet
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2020-08-28'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2021-05-05 09:11:12'
created_at: null
updated_at: null
-
id: 289
COMPE: '482'
ISPB: '42259084'
Document: 42.259.084/0001-22
LongName: 'ARTTA SOCIEDADE DE CRÉDITO DIRETO S.A'
ShortName: 'ARTTA SCD'
Network: null
Type: DRCT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2022-10-11'
DatePixStarted: '2024-12-11 11:00:00'
DateRegistered: '2022-10-04 12:08:42'
DateUpdated: '2025-05-08 12:09:16'
created_at: null
updated_at: null
-
id: 379
COMPE: '594'
ISPB: '48703388'
Document: 48.703.388/0001-13
LongName: 'ASA SOCIEDADE DE CRÉDITO FINANCIAMENTO E INVESTIMENTO S.A.'
ShortName: 'ASA SCFI S.A.'
Network: null
Type: DRCT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2024-03-11'
DatePixStarted: '2024-07-05 09:00:00'
DateRegistered: '2024-03-05 12:06:35'
DateUpdated: '2025-08-27 12:09:03'
created_at: null
updated_at: null
-
id: 273
COMPE: '461'
ISPB: '19540550'
Document: 19.540.550/0001-21
LongName: 'ASAAS GESTÃO FINANCEIRA INSTITUIÇÃO DE PAGAMENTO S.A.'
ShortName: 'ASAAS IP S.A.'
Network: null
Type: DRCT
PixType: Internet
Charge: 1
CreditDocument: 0
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2021-10-29'
DatePixStarted: '2021-11-01 09:00:00'
DateRegistered: '2021-11-22 11:00:23'
DateUpdated: '2025-09-20 12:08:16'
created_at: null
updated_at: null
-
id: 304
COMPE: '513'
ISPB: '44728700'
Document: 44.728.700/0001-72
LongName: 'ATF SOCIEDADE DE CRÉDITO DIRETO S.A.'
ShortName: 'ATF SCD S.A.'
Network: null
Type: IDRT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 0
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2022-12-02'
DatePixStarted: '2025-04-25 10:36:24'
DateRegistered: '2022-11-30 12:07:13'
DateUpdated: '2025-04-25 23:36:40'
created_at: null
updated_at: null
-
id: 316
COMPE: '527'
ISPB: '44478623'
Document: 44.478.623/0001-40
LongName: 'ATICCA - SOCIEDADE DE CRÉDITO DIRETO S.A.'
ShortName: 'ATICCA SCD S.A.'
Network: null
Type: DRCT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 0
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2023-02-06'
DatePixStarted: '2025-06-04 10:00:00'
DateRegistered: '2023-03-03 14:56:55'
DateUpdated: '2025-05-08 12:09:18'
created_at: null
updated_at: null
-
id: 100
COMPE: '188'
ISPB: '33775974'
Document: 33.775.974/0001-04
LongName: 'ATIVA INVESTIMENTOS S.A. CORRETORA DE TÍTULOS, CÂMBIO E VALORES'
ShortName: 'ATIVA S.A. INVESTIMENTOS CCTVM'
Network: null
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2017-07-28'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2021-05-05 09:11:12'
created_at: null
updated_at: null
-
id: 299
COMPE: '508'
ISPB: '61384004'
Document: 61.384.004/0001-05
LongName: 'AVENUE SECURITIES DISTRIBUIDORA DE TÍTULOS E VALORES MOBILIÁRIOS LTDA.'
ShortName: 'AVENUE SECURITIES DTVM LTDA.'
Network: null
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2022-08-18'
DatePixStarted: null
DateRegistered: '2022-08-13 12:30:35'
DateUpdated: '2022-08-13 12:30:35'
created_at: null
updated_at: null
-
id: 351
COMPE: '562'
ISPB: '18684408'
Document: 18.684.408/0001-95
LongName: 'AZIMUT BRASIL DISTRIBUIDORA DE TÍTULOS E VALORES MOBILIÁRIOS LTDA'
ShortName: 'AZIMUT BRASIL DTVM LTDA'
Network: null
Type: IDRT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2024-01-08'
DatePixStarted: '2025-01-27 08:12:51'
DateRegistered: '2024-01-09 12:06:15'
DateUpdated: '2025-01-27 12:34:41'
created_at: null
updated_at: null
-
id: 275
COMPE: '463'
ISPB: '40434681'
Document: 40.434.681/0001-10
LongName: 'AZUMI DISTRIBUIDORA DE TíTULOS E VALORES MOBILIáRIOS LTDA.'
ShortName: 'AZUMI DTVM'
Network: null
Type: null
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2021-12-21'
DatePixStarted: null
DateRegistered: '2022-01-05 11:00:34'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 119
COMPE: '246'
ISPB: '28195667'
Document: 28.195.667/0001-06
LongName: 'Banco ABC Brasil S.A.'
ShortName: 'BCO ABC BRASIL S.A.'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: 'Capital de Giro,Cheque Especial,Consignado,Outros Créditos,Pessoal,Troca de Modalidade'
Url: 'https://www.abcbrasil.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 32
COMPE: '075'
ISPB: '03532415'
Document: 03.532.415/0001-02
LongName: 'BANCO ABN AMRO CLEARING S.A.'
ShortName: 'BANCO ABN AMRO CLEARING S.A.'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: 'https://www.abnamro.com'
DateOperationStarted: '2005-11-11'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-06-24 12:07:23'
created_at: null
updated_at: null
-
id: 150
COMPE: '299'
ISPB: '04814563'
Document: 04.814.563/0001-74
LongName: 'BANCO AFINZ S.A. - BANCO MÚLTIPLO'
ShortName: 'BCO AFINZ S.A. - BM'
Network: null
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 0
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 0
SalaryPortability: null
Products: 'Consignado,Pessoal e Veículos'
Url: null
DateOperationStarted: '2018-12-03'
DatePixStarted: '2023-05-15 10:00:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 67
COMPE: '121'
ISPB: '10664513'
Document: 10.664.513/0001-50
LongName: 'Banco Agibank S.A.'
ShortName: 'BCO AGIBANK S.A.'
Network: 'Banco Comercial'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 1
PCR: 1
PCRP: 1
SalaryPortability: Destinatário
Products: 'Cheque Especial,Consignado,Pessoal,Troca de Modalidade'
Url: 'https://www.agibank.com.br'
DateOperationStarted: '2012-04-04'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 15
COMPE: '025'
ISPB: '03323840'
Document: 03.323.840/0001-83
LongName: 'Banco Alfa S.A.'
ShortName: 'BCO ALFA S.A.'
Network: 'Banco Comercial'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: 'Consignado,Pessoal,Veículos'
Url: null
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 27
COMPE: '065'
ISPB: '48795256'
Document: 48.795.256/0001-69
LongName: 'Banco AndBank (Brasil) S.A.'
ShortName: 'BCO ANDBANK S.A.'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: 0
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: 'Capita de Giro PJ,Crédito Consignado,Crédito Imobiliário,Crédito Pessoal,Financiamento de Veículos,Troca de Modalidade'
Url: null
DateOperationStarted: '2002-04-22'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2025-06-17 12:10:04'
created_at: null
updated_at: null
-
id: 110
COMPE: '213'
ISPB: '54403563'
Document: 54.403.563/0001-50
LongName: 'Banco Arbi S.A.'
ShortName: 'BCO ARBI S.A.'
Network: 'Banco Comercial'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: 'Banco folha e Destinatário'
Products: Consignado
Url: 'https://www.bancoarbi.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 50
COMPE: '096'
ISPB: '00997185'
Document: 00.997.185/0001-50
LongName: 'Banco B3 S.A.'
ShortName: 'BCO B3 S.A.'
Network: 'Banco Comercial'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 0
SalaryPortability: null
Products: null
Url: 'https://www.bmfbovespa.com.br/bancobmfbovespa/'
DateOperationStarted: '2004-11-12'
DatePixStarted: '2023-09-11 11:00:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 14
COMPE: '024'
ISPB: '10866788'
Document: 10.866.788/0001-77
LongName: 'Banco Bandepe S.A.'
ShortName: 'BCO BANDEPE S.A.'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: 'https://www.santander.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2021-05-05 09:11:12'
created_at: null
updated_at: null
-
id: 173
COMPE: '330'
ISPB: '00556603'
Document: 00.556.603/0001-74
LongName: 'BANCO BARI DE INVESTIMENTOS E FINANCIAMENTOS S.A.'
ShortName: 'BANCO BARI S.A.'
Network: null
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 0
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: 'Consignado,Imobiliário,Pessoal,Troca de Modalidade,Veículos'
Url: null
DateOperationStarted: '2019-07-22'
DatePixStarted: '2021-02-25 09:00:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 176
COMPE: '334'
ISPB: '15124464'
Document: 15.124.464/0001-87
LongName: 'BANCO BESA S.A.'
ShortName: 'BANCO BESA S.A.'
Network: null
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2023-02-22'
DatePixStarted: null
DateRegistered: '2023-03-03 14:56:55'
DateUpdated: '2023-03-03 14:56:55'
created_at: null
updated_at: null
-
id: 396
COMPE: '630'
ISPB: '58497702'
Document: 58.497.702/0001-02
LongName: 'BANCO BLUEBANK S.A.'
ShortName: 'BCO BLUEBANK S.A.'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2025-03-24 17:11:52'
created_at: null
updated_at: null
-
id: 121
COMPE: '250'
ISPB: '50585090'
Document: 50.585.090/0001-06
LongName: 'BANCO BMG CONSIGNADO S.A.'
ShortName: 'BANCO BMG CONSIGNADO S.A.'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2002-04-22'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-07-30 12:30:20'
created_at: null
updated_at: null
-
id: 162
COMPE: '318'
ISPB: '61186680'
Document: 61.186.680/0001-74
LongName: 'Banco BMG S.A.'
ShortName: 'BCO BMG S.A.'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: 'Banco folha e Destinatário'
Products: 'Consignado,Imobiliário,Pessoal,Troca de Modalidade,Veículos'
Url: 'https://www.bancobmg.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 115
COMPE: '233'
ISPB: '62421979'
Document: 62.421.979/0001-29
LongName: 'BANCO BMG SOLUÇÕES FINANCEIRAS S.A.'
ShortName: 'BANCO BMG SOLUÇÕES FINANCEIRAS S.A.'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2002-04-22'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2025-04-08 12:08:49'
created_at: null
updated_at: null
-
id: 461
COMPE: '752'
ISPB: '01522368'
Document: 01.522.368/0001-82
LongName: 'Banco BNP Paribas Brasil S.A.'
ShortName: 'BCO BNP PARIBAS BRASIL S A'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: 'Capital de Giro,Consiginado,Outros Créditos,Pessoal,Troca de Modalidade,veículos'
Url: 'https://www.bnpparibas.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2024-06-24 09:00:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 59
COMPE: '107'
ISPB: '15114366'
Document: 15.114.366/0001-69
LongName: 'Banco Bocom BBM S.A.'
ShortName: 'BCO BOCOM BBM S.A.'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 0
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2002-04-22'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 25
COMPE: '063'
ISPB: '04184779'
Document: 04.184.779/0001-01
LongName: 'Banco Bradescard S.A.'
ShortName: 'BANCO BRADESCARD'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: 'Imobiliário,Pessoal,Troca de Modalidade,Veículos'
Url: null
DateOperationStarted: '2002-04-22'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2025-02-25 12:08:29'
created_at: null
updated_at: null
-
id: 18
COMPE: '036'
ISPB: '06271464'
Document: 06.271.464/0001-19
LongName: 'Banco Bradesco BBI S.A.'
ShortName: 'BCO BBI S.A.'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: 'https://www.bradescobbi.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2021-05-05 09:11:12'
created_at: null
updated_at: null
-
id: 68
COMPE: '122'
ISPB: '33147315'
Document: 33.147.315/0001-15
LongName: 'Banco Bradesco BERJ S.A.'
ShortName: 'BCO BRADESCO BERJ S.A.'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2011-11-08'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2022-06-23 13:48:15'
created_at: null
updated_at: null
-
id: 219
COMPE: '394'
ISPB: '07207996'
Document: 07.207.996/0001-50
LongName: 'Banco Bradesco Financiamentos S.A.'
ShortName: 'BCO BRADESCO FINANC. S.A.'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: 'Consignado,Pessoal,Troca de Modalidade,Veículos'
Url: 'https://www.bradescofinanciamentos.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2023-10-21 12:05:56'
created_at: null
updated_at: null
-
id: 205
COMPE: '378'
ISPB: '01852137'
Document: 01.852.137/0001-37
LongName: 'BANCO BRASILEIRO DE CRÉDITO SOCIEDADE ANÔNIMA'
ShortName: 'BCO BRASILEIRO DE CRÉDITO S.A.'
Network: null
Type: DRCT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: 'Capita de Giro PJ,Crédito Pessoal,Financiamento de Veículos,Outros,Troca de Modalidade'
Url: null
DateOperationStarted: '2020-09-11'
DatePixStarted: '2024-03-18 06:00:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-08-31 12:29:47'
created_at: null
updated_at: null
-
id: 112
COMPE: '218'
ISPB: '71027866'
Document: 71.027.866/0001-34
LongName: 'Banco BS2 S.A.'
ShortName: 'BCO BS2 S.A.'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 0
SalaryPortability: Destinatário
Products: Consignado
Url: 'https://www.bs2.com/banco/'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
first_page_url: 'https://api.meupagamento.com.br/api/v1/banks?page=1'
from: 1
last_page: 10
last_page_url: 'https://api.meupagamento.com.br/api/v1/banks?page=10'
links:
-
url: null
label: '« Previous'
page: null
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=1'
label: '1'
page: 1
active: true
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=2'
label: '2'
page: 2
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=3'
label: '3'
page: 3
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=4'
label: '4'
page: 4
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=5'
label: '5'
page: 5
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=6'
label: '6'
page: 6
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=7'
label: '7'
page: 7
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=8'
label: '8'
page: 8
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=9'
label: '9'
page: 9
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=10'
label: '10'
page: 10
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=2'
label: 'Next »'
page: 2
active: false
next_page_url: 'https://api.meupagamento.com.br/api/v1/banks?page=2'
path: 'https://api.meupagamento.com.br/api/v1/banks'
per_page: 50
prev_page_url: null
to: 50
total: 476
properties:
current_page:
type: integer
example: 1
data:
type: array
example:
-
id: 116
COMPE: '237'
ISPB: '60746948'
Document: 60.746.948/0001-12
LongName: 'Banco Bradesco S.A.'
ShortName: 'BCO BRADESCO S.A.'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 1
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: 'Banco folha e Destinatário'
Products: 'Capital de Giro,Cheque Especial,Consignado,Imobiliário,Pessoal,Troca de Modalidade,Veículos'
Url: 'https://www.bradesco.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 1
COMPE: '001'
ISPB: '00000000'
Document: 00.000.000/0001-91
LongName: 'Banco do Brasil S.A.'
ShortName: 'BCO DO BRASIL S.A.'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 1
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: 'Banco folha e Destinatário'
Products: 'Capital de Giro,Cheque Especial,Consignado,Imobiliário,Outros Créditos,Pessoal,Troca de Modalidade,Veículos'
Url: 'https://www.bb.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 17
COMPE: '033'
ISPB: '90400888'
Document: 90.400.888/0001-42
LongName: 'BANCO SANTANDER (BRASIL) S.A.'
ShortName: 'BCO SANTANDER (BRASIL) S.A.'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 1
DetectaFlow: 1
PCR: 1
PCRP: 1
SalaryPortability: 'Banco folha e Destinatário'
Products: 'Capital de Giro,Cheque Especial,Consignado,Imobiliário,Pessoal,Troca de Modalidade,Veículos'
Url: 'https://www.santander.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 57
COMPE: '104'
ISPB: '00360305'
Document: 00.360.305/0001-04
LongName: 'Caixa Econômica Federal'
ShortName: 'CAIXA ECONOMICA FEDERAL'
Network: 'Caixa Econômica Federal'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 1
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: 'Banco folha e Destinatário'
Products: 'Capital de Giro,Cheque Especial,Consignado,Imobiário,Pessoal,Troca de Modalidade,Veículos'
Url: 'https://caixa.gov.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 180
COMPE: '341'
ISPB: '60701190'
Document: 60.701.190/0001-04
LongName: 'ITAÚ UNIBANCO S.A.'
ShortName: 'ITAÚ UNIBANCO S.A.'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 1
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: 'Banco folha e Destinatário'
Products: 'Capital de Giro,Cheque Especial,Consignado,Imobiliário,Outros Créditos,Pessoal,Troca de Modalidade,Veículos'
Url: 'https://www.itau.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 403
COMPE: '644'
ISPB: '54647259'
Document: 54.647.259/0001-58
LongName: '321 SOCIEDADE DE CRÉDITO DIRETO S.A.'
ShortName: '321 SCD S.A.'
Network: null
Type: null
PixType: Internet
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2024-06-13'
DatePixStarted: null
DateRegistered: '2024-06-07 12:08:28'
DateUpdated: '2024-06-07 12:08:28'
created_at: null
updated_at: null
-
id: 475
COMPE: '769'
ISPB: '24313102'
Document: 24.313.102/0001-25
LongName: '99PAY INSTITUICAO DE PAGAMENTO S.A.'
ShortName: '99PAY IP S.A.'
Network: null
Type: DRCT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2025-08-18'
DatePixStarted: '2025-08-18 10:10:00'
DateRegistered: '2025-08-18 12:09:55'
DateUpdated: '2025-08-19 12:09:19'
created_at: null
updated_at: null
-
id: 359
COMPE: '574'
ISPB: '48756121'
Document: 48.756.121/0001-94
LongName: 'A55 SOCIEDADE DE CRÉDITO DIRETO S.A.'
ShortName: 'A55 SCD S.A.'
Network: null
Type: DRCT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2025-02-21'
DatePixStarted: '2025-02-21 11:00:00'
DateRegistered: '2025-02-17 12:08:34'
DateUpdated: '2025-02-18 12:08:11'
created_at: null
updated_at: null
-
id: 230
COMPE: '406'
ISPB: '37715993'
Document: 37.715.993/0001-98
LongName: 'ACCREDITO - SOCIEDADE DE CRÉDITO DIRETO S.A.'
ShortName: 'ACCREDITO SCD S.A.'
Network: null
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2020-11-27'
DatePixStarted: '2023-03-15 10:00:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 175
COMPE: '332'
ISPB: '13140088'
Document: 13.140.088/0001-99
LongName: 'ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO'
ShortName: 'ACESSO SOLUÇÕES DE PAGAMENTO S.A. - INSTITUIÇÃO DE PAGAMENTO'
Network: null
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: 'Banco folha e Destinatário'
Products: null
Url: null
DateOperationStarted: '2019-08-16'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2022-12-13 12:06:52'
created_at: null
updated_at: null
-
id: 414
COMPE: '663'
ISPB: '44782130'
Document: 44.782.130/0001-07
LongName: 'ACTUAL DISTRIBUIDORA DE TÍTULOS E VALORES MOBILIÁRIOS S.A.'
ShortName: 'ACTUAL DTVM S.A.'
Network: null
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2024-12-16'
DatePixStarted: null
DateRegistered: '2024-12-10 12:09:00'
DateUpdated: '2024-12-10 12:09:00'
created_at: null
updated_at: null
-
id: 64
COMPE: '117'
ISPB: '92856905'
Document: 92.856.905/0001-86
LongName: 'ADVANCED CORRETORA DE CÂMBIO LTDA'
ShortName: 'ADVANCED CC LTDA'
Network: null
Type: null
PixType: Internet
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: 'https://advancedcorretora.com.br/'
DateOperationStarted: '2011-10-03'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2021-05-05 09:11:12'
created_at: null
updated_at: null
-
id: 132
COMPE: '272'
ISPB: '00250699'
Document: 00.250.699/0001-48
LongName: 'AGK CORRETORA DE CAMBIO S.A.'
ShortName: 'AGK CC S.A.'
Network: null
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2018-11-21'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2021-05-05 09:11:12'
created_at: null
updated_at: null
-
id: 353
COMPE: '565'
ISPB: '74014747'
Document: 74.014.747/0001-35
LongName: 'ÁGORA CORRETORA DE TITULOS E VALORES MOBILIARIOS S.A.'
ShortName: 'ÁGORA CTVM S.A.'
Network: null
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2023-11-20'
DatePixStarted: null
DateRegistered: '2023-11-14 12:06:11'
DateUpdated: '2023-11-14 12:06:11'
created_at: null
updated_at: null
-
id: 383
COMPE: '599'
ISPB: '36321990'
Document: 36.321.990/0001-07
LongName: 'AGORACRED S/A SOCIEDADE DE CRÉDITO, FINANCIAMENTO E INVESTIMENTO'
ShortName: 'AGORACRED S/A SCFI'
Network: null
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2024-08-07'
DatePixStarted: null
DateRegistered: '2024-08-05 12:07:23'
DateUpdated: '2024-08-05 12:07:23'
created_at: null
updated_at: null
-
id: 184
COMPE: '349'
ISPB: '27214112'
Document: 27.214.112/0001-00
LongName: 'AL5 S.A. CRÉDITO, FINANCIAMENTO E INVESTIMENTO'
ShortName: 'AL5 S.A. CFI'
Network: null
Type: IDRT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: 'Banco folha e Destinatário'
Products: 'Capital de Giro,Consignado,Imobiliário,Outros,Pessoal,Troca de Modalidade,Veículos'
Url: null
DateOperationStarted: '2019-10-24'
DatePixStarted: '2023-08-01 15:22:55'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2023-10-21 12:05:56'
created_at: null
updated_at: null
-
id: 358
COMPE: '572'
ISPB: '51414521'
Document: 51.414.521/0001-26
LongName: 'ALL IN CRED SOCIEDADE DE CREDITO DIRETO S.A.'
ShortName: 'ALL IN CRED SCD S.A.'
Network: null
Type: DRCT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2023-12-22'
DatePixStarted: '2024-12-10 11:00:00'
DateRegistered: '2023-12-18 12:06:50'
DateUpdated: '2024-12-05 12:08:35'
created_at: null
updated_at: null
-
id: 160
COMPE: '313'
ISPB: '16927221'
Document: 16.927.221/0001-40
LongName: 'AMAZÔNIA CORRETORA DE CÂMBIO LTDA.'
ShortName: 'AMAZÔNIA CC LTDA.'
Network: null
Type: null
PixType: Internet
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2020-08-28'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2021-05-05 09:11:12'
created_at: null
updated_at: null
-
id: 289
COMPE: '482'
ISPB: '42259084'
Document: 42.259.084/0001-22
LongName: 'ARTTA SOCIEDADE DE CRÉDITO DIRETO S.A'
ShortName: 'ARTTA SCD'
Network: null
Type: DRCT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2022-10-11'
DatePixStarted: '2024-12-11 11:00:00'
DateRegistered: '2022-10-04 12:08:42'
DateUpdated: '2025-05-08 12:09:16'
created_at: null
updated_at: null
-
id: 379
COMPE: '594'
ISPB: '48703388'
Document: 48.703.388/0001-13
LongName: 'ASA SOCIEDADE DE CRÉDITO FINANCIAMENTO E INVESTIMENTO S.A.'
ShortName: 'ASA SCFI S.A.'
Network: null
Type: DRCT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2024-03-11'
DatePixStarted: '2024-07-05 09:00:00'
DateRegistered: '2024-03-05 12:06:35'
DateUpdated: '2025-08-27 12:09:03'
created_at: null
updated_at: null
-
id: 273
COMPE: '461'
ISPB: '19540550'
Document: 19.540.550/0001-21
LongName: 'ASAAS GESTÃO FINANCEIRA INSTITUIÇÃO DE PAGAMENTO S.A.'
ShortName: 'ASAAS IP S.A.'
Network: null
Type: DRCT
PixType: Internet
Charge: 1
CreditDocument: 0
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2021-10-29'
DatePixStarted: '2021-11-01 09:00:00'
DateRegistered: '2021-11-22 11:00:23'
DateUpdated: '2025-09-20 12:08:16'
created_at: null
updated_at: null
-
id: 304
COMPE: '513'
ISPB: '44728700'
Document: 44.728.700/0001-72
LongName: 'ATF SOCIEDADE DE CRÉDITO DIRETO S.A.'
ShortName: 'ATF SCD S.A.'
Network: null
Type: IDRT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 0
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2022-12-02'
DatePixStarted: '2025-04-25 10:36:24'
DateRegistered: '2022-11-30 12:07:13'
DateUpdated: '2025-04-25 23:36:40'
created_at: null
updated_at: null
-
id: 316
COMPE: '527'
ISPB: '44478623'
Document: 44.478.623/0001-40
LongName: 'ATICCA - SOCIEDADE DE CRÉDITO DIRETO S.A.'
ShortName: 'ATICCA SCD S.A.'
Network: null
Type: DRCT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 0
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2023-02-06'
DatePixStarted: '2025-06-04 10:00:00'
DateRegistered: '2023-03-03 14:56:55'
DateUpdated: '2025-05-08 12:09:18'
created_at: null
updated_at: null
-
id: 100
COMPE: '188'
ISPB: '33775974'
Document: 33.775.974/0001-04
LongName: 'ATIVA INVESTIMENTOS S.A. CORRETORA DE TÍTULOS, CÂMBIO E VALORES'
ShortName: 'ATIVA S.A. INVESTIMENTOS CCTVM'
Network: null
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2017-07-28'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2021-05-05 09:11:12'
created_at: null
updated_at: null
-
id: 299
COMPE: '508'
ISPB: '61384004'
Document: 61.384.004/0001-05
LongName: 'AVENUE SECURITIES DISTRIBUIDORA DE TÍTULOS E VALORES MOBILIÁRIOS LTDA.'
ShortName: 'AVENUE SECURITIES DTVM LTDA.'
Network: null
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2022-08-18'
DatePixStarted: null
DateRegistered: '2022-08-13 12:30:35'
DateUpdated: '2022-08-13 12:30:35'
created_at: null
updated_at: null
-
id: 351
COMPE: '562'
ISPB: '18684408'
Document: 18.684.408/0001-95
LongName: 'AZIMUT BRASIL DISTRIBUIDORA DE TÍTULOS E VALORES MOBILIÁRIOS LTDA'
ShortName: 'AZIMUT BRASIL DTVM LTDA'
Network: null
Type: IDRT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2024-01-08'
DatePixStarted: '2025-01-27 08:12:51'
DateRegistered: '2024-01-09 12:06:15'
DateUpdated: '2025-01-27 12:34:41'
created_at: null
updated_at: null
-
id: 275
COMPE: '463'
ISPB: '40434681'
Document: 40.434.681/0001-10
LongName: 'AZUMI DISTRIBUIDORA DE TíTULOS E VALORES MOBILIáRIOS LTDA.'
ShortName: 'AZUMI DTVM'
Network: null
Type: null
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2021-12-21'
DatePixStarted: null
DateRegistered: '2022-01-05 11:00:34'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 119
COMPE: '246'
ISPB: '28195667'
Document: 28.195.667/0001-06
LongName: 'Banco ABC Brasil S.A.'
ShortName: 'BCO ABC BRASIL S.A.'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: 'Capital de Giro,Cheque Especial,Consignado,Outros Créditos,Pessoal,Troca de Modalidade'
Url: 'https://www.abcbrasil.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 32
COMPE: '075'
ISPB: '03532415'
Document: 03.532.415/0001-02
LongName: 'BANCO ABN AMRO CLEARING S.A.'
ShortName: 'BANCO ABN AMRO CLEARING S.A.'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: 'https://www.abnamro.com'
DateOperationStarted: '2005-11-11'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-06-24 12:07:23'
created_at: null
updated_at: null
-
id: 150
COMPE: '299'
ISPB: '04814563'
Document: 04.814.563/0001-74
LongName: 'BANCO AFINZ S.A. - BANCO MÚLTIPLO'
ShortName: 'BCO AFINZ S.A. - BM'
Network: null
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 0
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 0
SalaryPortability: null
Products: 'Consignado,Pessoal e Veículos'
Url: null
DateOperationStarted: '2018-12-03'
DatePixStarted: '2023-05-15 10:00:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 67
COMPE: '121'
ISPB: '10664513'
Document: 10.664.513/0001-50
LongName: 'Banco Agibank S.A.'
ShortName: 'BCO AGIBANK S.A.'
Network: 'Banco Comercial'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 1
PCR: 1
PCRP: 1
SalaryPortability: Destinatário
Products: 'Cheque Especial,Consignado,Pessoal,Troca de Modalidade'
Url: 'https://www.agibank.com.br'
DateOperationStarted: '2012-04-04'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 15
COMPE: '025'
ISPB: '03323840'
Document: 03.323.840/0001-83
LongName: 'Banco Alfa S.A.'
ShortName: 'BCO ALFA S.A.'
Network: 'Banco Comercial'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: 'Consignado,Pessoal,Veículos'
Url: null
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 27
COMPE: '065'
ISPB: '48795256'
Document: 48.795.256/0001-69
LongName: 'Banco AndBank (Brasil) S.A.'
ShortName: 'BCO ANDBANK S.A.'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: 0
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: 'Capita de Giro PJ,Crédito Consignado,Crédito Imobiliário,Crédito Pessoal,Financiamento de Veículos,Troca de Modalidade'
Url: null
DateOperationStarted: '2002-04-22'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2025-06-17 12:10:04'
created_at: null
updated_at: null
-
id: 110
COMPE: '213'
ISPB: '54403563'
Document: 54.403.563/0001-50
LongName: 'Banco Arbi S.A.'
ShortName: 'BCO ARBI S.A.'
Network: 'Banco Comercial'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: 'Banco folha e Destinatário'
Products: Consignado
Url: 'https://www.bancoarbi.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 50
COMPE: '096'
ISPB: '00997185'
Document: 00.997.185/0001-50
LongName: 'Banco B3 S.A.'
ShortName: 'BCO B3 S.A.'
Network: 'Banco Comercial'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 0
SalaryPortability: null
Products: null
Url: 'https://www.bmfbovespa.com.br/bancobmfbovespa/'
DateOperationStarted: '2004-11-12'
DatePixStarted: '2023-09-11 11:00:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 14
COMPE: '024'
ISPB: '10866788'
Document: 10.866.788/0001-77
LongName: 'Banco Bandepe S.A.'
ShortName: 'BCO BANDEPE S.A.'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: 'https://www.santander.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2021-05-05 09:11:12'
created_at: null
updated_at: null
-
id: 173
COMPE: '330'
ISPB: '00556603'
Document: 00.556.603/0001-74
LongName: 'BANCO BARI DE INVESTIMENTOS E FINANCIAMENTOS S.A.'
ShortName: 'BANCO BARI S.A.'
Network: null
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 0
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: 'Consignado,Imobiliário,Pessoal,Troca de Modalidade,Veículos'
Url: null
DateOperationStarted: '2019-07-22'
DatePixStarted: '2021-02-25 09:00:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 176
COMPE: '334'
ISPB: '15124464'
Document: 15.124.464/0001-87
LongName: 'BANCO BESA S.A.'
ShortName: 'BANCO BESA S.A.'
Network: null
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2023-02-22'
DatePixStarted: null
DateRegistered: '2023-03-03 14:56:55'
DateUpdated: '2023-03-03 14:56:55'
created_at: null
updated_at: null
-
id: 396
COMPE: '630'
ISPB: '58497702'
Document: 58.497.702/0001-02
LongName: 'BANCO BLUEBANK S.A.'
ShortName: 'BCO BLUEBANK S.A.'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2025-03-24 17:11:52'
created_at: null
updated_at: null
-
id: 121
COMPE: '250'
ISPB: '50585090'
Document: 50.585.090/0001-06
LongName: 'BANCO BMG CONSIGNADO S.A.'
ShortName: 'BANCO BMG CONSIGNADO S.A.'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2002-04-22'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-07-30 12:30:20'
created_at: null
updated_at: null
-
id: 162
COMPE: '318'
ISPB: '61186680'
Document: 61.186.680/0001-74
LongName: 'Banco BMG S.A.'
ShortName: 'BCO BMG S.A.'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: 'Banco folha e Destinatário'
Products: 'Consignado,Imobiliário,Pessoal,Troca de Modalidade,Veículos'
Url: 'https://www.bancobmg.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 115
COMPE: '233'
ISPB: '62421979'
Document: 62.421.979/0001-29
LongName: 'BANCO BMG SOLUÇÕES FINANCEIRAS S.A.'
ShortName: 'BANCO BMG SOLUÇÕES FINANCEIRAS S.A.'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2002-04-22'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2025-04-08 12:08:49'
created_at: null
updated_at: null
-
id: 461
COMPE: '752'
ISPB: '01522368'
Document: 01.522.368/0001-82
LongName: 'Banco BNP Paribas Brasil S.A.'
ShortName: 'BCO BNP PARIBAS BRASIL S A'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: null
Products: 'Capital de Giro,Consiginado,Outros Créditos,Pessoal,Troca de Modalidade,veículos'
Url: 'https://www.bnpparibas.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2024-06-24 09:00:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 59
COMPE: '107'
ISPB: '15114366'
Document: 15.114.366/0001-69
LongName: 'Banco Bocom BBM S.A.'
ShortName: 'BCO BOCOM BBM S.A.'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 0
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2002-04-22'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
-
id: 25
COMPE: '063'
ISPB: '04184779'
Document: 04.184.779/0001-01
LongName: 'Banco Bradescard S.A.'
ShortName: 'BANCO BRADESCARD'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: 'Imobiliário,Pessoal,Troca de Modalidade,Veículos'
Url: null
DateOperationStarted: '2002-04-22'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2025-02-25 12:08:29'
created_at: null
updated_at: null
-
id: 18
COMPE: '036'
ISPB: '06271464'
Document: 06.271.464/0001-19
LongName: 'Banco Bradesco BBI S.A.'
ShortName: 'BCO BBI S.A.'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: 'https://www.bradescobbi.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2021-05-05 09:11:12'
created_at: null
updated_at: null
-
id: 68
COMPE: '122'
ISPB: '33147315'
Document: 33.147.315/0001-15
LongName: 'Banco Bradesco BERJ S.A.'
ShortName: 'BCO BRADESCO BERJ S.A.'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: null
Url: null
DateOperationStarted: '2011-11-08'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2022-06-23 13:48:15'
created_at: null
updated_at: null
-
id: 219
COMPE: '394'
ISPB: '07207996'
Document: 07.207.996/0001-50
LongName: 'Banco Bradesco Financiamentos S.A.'
ShortName: 'BCO BRADESCO FINANC. S.A.'
Network: 'Banco Múltiplo'
Type: null
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: 'Consignado,Pessoal,Troca de Modalidade,Veículos'
Url: 'https://www.bradescofinanciamentos.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: null
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2023-10-21 12:05:56'
created_at: null
updated_at: null
-
id: 205
COMPE: '378'
ISPB: '01852137'
Document: 01.852.137/0001-37
LongName: 'BANCO BRASILEIRO DE CRÉDITO SOCIEDADE ANÔNIMA'
ShortName: 'BCO BRASILEIRO DE CRÉDITO S.A.'
Network: null
Type: DRCT
PixType: RSFN
Charge: null
CreditDocument: null
LegalCheque: 0
DetectaFlow: 0
PCR: null
PCRP: null
SalaryPortability: null
Products: 'Capita de Giro PJ,Crédito Pessoal,Financiamento de Veículos,Outros,Troca de Modalidade'
Url: null
DateOperationStarted: '2020-09-11'
DatePixStarted: '2024-03-18 06:00:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-08-31 12:29:47'
created_at: null
updated_at: null
-
id: 112
COMPE: '218'
ISPB: '71027866'
Document: 71.027.866/0001-34
LongName: 'Banco BS2 S.A.'
ShortName: 'BCO BS2 S.A.'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 0
DetectaFlow: 0
PCR: 1
PCRP: 0
SalaryPortability: Destinatário
Products: Consignado
Url: 'https://www.bs2.com/banco/'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
items:
type: object
properties:
id:
type: integer
example: 116
COMPE:
type: string
example: '237'
ISPB:
type: string
example: '60746948'
Document:
type: string
example: 60.746.948/0001-12
LongName:
type: string
example: 'Banco Bradesco S.A.'
ShortName:
type: string
example: 'BCO BRADESCO S.A.'
Network:
type: string
example: 'Banco Múltiplo'
Type:
type: string
example: DRCT
PixType:
type: string
example: RSFN
Charge:
type: integer
example: 1
CreditDocument:
type: integer
example: 1
LegalCheque:
type: integer
example: 1
DetectaFlow:
type: integer
example: 0
PCR:
type: integer
example: 1
PCRP:
type: integer
example: 1
SalaryPortability:
type: string
example: 'Banco folha e Destinatário'
Products:
type: string
example: 'Capital de Giro,Cheque Especial,Consignado,Imobiliário,Pessoal,Troca de Modalidade,Veículos'
Url:
type: string
example: 'https://www.bradesco.com.br'
DateOperationStarted:
type: string
example: '2002-04-22'
DatePixStarted:
type: string
example: '2020-11-03 06:30:00'
DateRegistered:
type: string
example: '2021-05-05 09:11:12'
DateUpdated:
type: string
example: '2024-05-15 16:49:45'
created_at:
type: string
example: null
updated_at:
type: string
example: null
first_page_url:
type: string
example: 'https://api.meupagamento.com.br/api/v1/banks?page=1'
from:
type: integer
example: 1
last_page:
type: integer
example: 10
last_page_url:
type: string
example: 'https://api.meupagamento.com.br/api/v1/banks?page=10'
links:
type: array
example:
-
url: null
label: '« Previous'
page: null
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=1'
label: '1'
page: 1
active: true
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=2'
label: '2'
page: 2
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=3'
label: '3'
page: 3
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=4'
label: '4'
page: 4
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=5'
label: '5'
page: 5
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=6'
label: '6'
page: 6
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=7'
label: '7'
page: 7
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=8'
label: '8'
page: 8
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=9'
label: '9'
page: 9
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=10'
label: '10'
page: 10
active: false
-
url: 'https://api.meupagamento.com.br/api/v1/banks?page=2'
label: 'Next »'
page: 2
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Previous'
page:
type: string
example: null
active:
type: boolean
example: false
next_page_url:
type: string
example: 'https://api.meupagamento.com.br/api/v1/banks?page=2'
path:
type: string
example: 'https://api.meupagamento.com.br/api/v1/banks'
per_page:
type: integer
example: 50
prev_page_url:
type: string
example: null
to:
type: integer
example: 50
total:
type: integer
example: 476
tags:
- Endpoints
/api/v1/banks/statistics:
get:
summary: 'Estatísticas de uso dos bancos'
operationId: estatsticasDeUsoDosBancos
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
most_used_banks:
-
id: 125
COMPE: '260'
LongName: 'NU PAGAMENTOS S.A. - INSTITUIÇÃO DE PAGAMENTO'
ShortName: 'NU PAGAMENTOS - IP'
PixType: RSFN
usage_count: 1
default_count: 1
-
id: 17
COMPE: '033'
LongName: 'BANCO SANTANDER (BRASIL) S.A.'
ShortName: 'BCO SANTANDER (BRASIL) S.A.'
PixType: RSFN
usage_count: 1
default_count: 0
-
id: 57
COMPE: '104'
LongName: 'Caixa Econômica Federal'
ShortName: 'CAIXA ECONOMICA FEDERAL'
PixType: RSFN
usage_count: 1
default_count: 1
-
id: 220
COMPE: '395'
LongName: "F.D'GOLD - DISTRIBUIDORA DE TÍTULOS E VALORES MOBILIÁRIOS LTDA."
ShortName: 'F D GOLD DTVM LTDA'
PixType: Internet
usage_count: 0
default_count: 0
-
id: 108
COMPE: '208'
LongName: 'Banco BTG Pactual S.A.'
ShortName: 'BANCO BTG PACTUAL S.A.'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 476
COMPE: '772'
LongName: 'COOPERATIVA DE CRÉDITO MÚTUO DOS EMPREGADOS DO CENTRO UNIVERSITÁRIO NEWTON PAIVA LTDA. - CREDIPAIVA'
ShortName: 'CC MECUNP'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 364
COMPE: '579'
LongName: 'QUADRA SOCIEDADE DE CRÉDITO DIRETO S.A.'
ShortName: 'QUADRA SCD'
PixType: Internet
usage_count: 0
default_count: 0
-
id: 252
COMPE: '435'
LongName: 'DELCRED SOCIEDADE DE CRÉDITO DIRETO S.A.'
ShortName: 'DELCRED SCD S.A.'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 140
COMPE: '283'
LongName: 'RB INVESTIMENTOS DISTRIBUIDORA DE TITULOS E VALORES MOBILIARIOS LIMITADA'
ShortName: 'RB INVESTIMENTOS DTVM LTDA.'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 28
COMPE: '066'
LongName: 'BANCO MORGAN STANLEY S.A.'
ShortName: 'BCO MORGAN STANLEY S.A.'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 396
COMPE: '630'
LongName: 'BANCO BLUEBANK S.A.'
ShortName: 'BCO BLUEBANK S.A.'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 284
COMPE: '475'
LongName: 'Banco Yamaha Motor do Brasil S.A.'
ShortName: 'BCO YAMAHA MOTOR S.A.'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 172
COMPE: '329'
LongName: 'QI Sociedade de Crédito Direto S.A.'
ShortName: 'QI SCD S.A.'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 60
COMPE: '108'
LongName: 'PORTOCRED S.A. - CREDITO, FINANCIAMENTO E INVESTIMENTO'
ShortName: 'PORTOCRED S.A. - CFI'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 428
COMPE: '679'
LongName: 'PAY INSTITUICAO DE PAGAMENTO S.A.'
ShortName: 'PAY IP S.A.'
PixType: Internet
usage_count: 0
default_count: 0
-
id: 316
COMPE: '527'
LongName: 'ATICCA - SOCIEDADE DE CRÉDITO DIRETO S.A.'
ShortName: 'ATICCA SCD S.A.'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 204
COMPE: '377'
LongName: 'BMS SOCIEDADE DE CRÉDITO DIRETO S.A.'
ShortName: 'BMS SCD S.A.'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 92
COMPE: '159'
LongName: 'Casa do Crédito S.A. Sociedade de Crédito ao Microempreendedor'
ShortName: 'CASA CREDITO S.A. SCM'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 460
COMPE: '751'
LongName: 'Scotiabank Brasil S.A. Banco Múltiplo'
ShortName: 'SCOTIABANK BRASIL'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 348
COMPE: '559'
LongName: 'KANASTRA FINANCEIRA S.A, CREDITO, FINANCIAMENTO E INVESTIMENTO'
ShortName: 'KANASTRA CFI'
PixType: RSFN
usage_count: 0
default_count: 0
total_banks: 476
total_accounts: 3
properties:
most_used_banks:
type: array
example:
-
id: 125
COMPE: '260'
LongName: 'NU PAGAMENTOS S.A. - INSTITUIÇÃO DE PAGAMENTO'
ShortName: 'NU PAGAMENTOS - IP'
PixType: RSFN
usage_count: 1
default_count: 1
-
id: 17
COMPE: '033'
LongName: 'BANCO SANTANDER (BRASIL) S.A.'
ShortName: 'BCO SANTANDER (BRASIL) S.A.'
PixType: RSFN
usage_count: 1
default_count: 0
-
id: 57
COMPE: '104'
LongName: 'Caixa Econômica Federal'
ShortName: 'CAIXA ECONOMICA FEDERAL'
PixType: RSFN
usage_count: 1
default_count: 1
-
id: 220
COMPE: '395'
LongName: "F.D'GOLD - DISTRIBUIDORA DE TÍTULOS E VALORES MOBILIÁRIOS LTDA."
ShortName: 'F D GOLD DTVM LTDA'
PixType: Internet
usage_count: 0
default_count: 0
-
id: 108
COMPE: '208'
LongName: 'Banco BTG Pactual S.A.'
ShortName: 'BANCO BTG PACTUAL S.A.'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 476
COMPE: '772'
LongName: 'COOPERATIVA DE CRÉDITO MÚTUO DOS EMPREGADOS DO CENTRO UNIVERSITÁRIO NEWTON PAIVA LTDA. - CREDIPAIVA'
ShortName: 'CC MECUNP'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 364
COMPE: '579'
LongName: 'QUADRA SOCIEDADE DE CRÉDITO DIRETO S.A.'
ShortName: 'QUADRA SCD'
PixType: Internet
usage_count: 0
default_count: 0
-
id: 252
COMPE: '435'
LongName: 'DELCRED SOCIEDADE DE CRÉDITO DIRETO S.A.'
ShortName: 'DELCRED SCD S.A.'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 140
COMPE: '283'
LongName: 'RB INVESTIMENTOS DISTRIBUIDORA DE TITULOS E VALORES MOBILIARIOS LIMITADA'
ShortName: 'RB INVESTIMENTOS DTVM LTDA.'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 28
COMPE: '066'
LongName: 'BANCO MORGAN STANLEY S.A.'
ShortName: 'BCO MORGAN STANLEY S.A.'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 396
COMPE: '630'
LongName: 'BANCO BLUEBANK S.A.'
ShortName: 'BCO BLUEBANK S.A.'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 284
COMPE: '475'
LongName: 'Banco Yamaha Motor do Brasil S.A.'
ShortName: 'BCO YAMAHA MOTOR S.A.'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 172
COMPE: '329'
LongName: 'QI Sociedade de Crédito Direto S.A.'
ShortName: 'QI SCD S.A.'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 60
COMPE: '108'
LongName: 'PORTOCRED S.A. - CREDITO, FINANCIAMENTO E INVESTIMENTO'
ShortName: 'PORTOCRED S.A. - CFI'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 428
COMPE: '679'
LongName: 'PAY INSTITUICAO DE PAGAMENTO S.A.'
ShortName: 'PAY IP S.A.'
PixType: Internet
usage_count: 0
default_count: 0
-
id: 316
COMPE: '527'
LongName: 'ATICCA - SOCIEDADE DE CRÉDITO DIRETO S.A.'
ShortName: 'ATICCA SCD S.A.'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 204
COMPE: '377'
LongName: 'BMS SOCIEDADE DE CRÉDITO DIRETO S.A.'
ShortName: 'BMS SCD S.A.'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 92
COMPE: '159'
LongName: 'Casa do Crédito S.A. Sociedade de Crédito ao Microempreendedor'
ShortName: 'CASA CREDITO S.A. SCM'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 460
COMPE: '751'
LongName: 'Scotiabank Brasil S.A. Banco Múltiplo'
ShortName: 'SCOTIABANK BRASIL'
PixType: RSFN
usage_count: 0
default_count: 0
-
id: 348
COMPE: '559'
LongName: 'KANASTRA FINANCEIRA S.A, CREDITO, FINANCIAMENTO E INVESTIMENTO'
ShortName: 'KANASTRA CFI'
PixType: RSFN
usage_count: 0
default_count: 0
items:
type: object
properties:
id:
type: integer
example: 125
COMPE:
type: string
example: '260'
LongName:
type: string
example: 'NU PAGAMENTOS S.A. - INSTITUIÇÃO DE PAGAMENTO'
ShortName:
type: string
example: 'NU PAGAMENTOS - IP'
PixType:
type: string
example: RSFN
usage_count:
type: integer
example: 1
default_count:
type: integer
example: 1
total_banks:
type: integer
example: 476
total_accounts:
type: integer
example: 3
tags:
- Endpoints
'/api/v1/banks/{id}':
get:
summary: ''
operationId: getApiV1BanksId
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
id: 1
COMPE: '001'
ISPB: '00000000'
Document: 00.000.000/0001-91
LongName: 'Banco do Brasil S.A.'
ShortName: 'BCO DO BRASIL S.A.'
Network: 'Banco Múltiplo'
Type: DRCT
PixType: RSFN
Charge: 1
CreditDocument: 1
LegalCheque: 1
DetectaFlow: 0
PCR: 1
PCRP: 1
SalaryPortability: 'Banco folha e Destinatário'
Products: 'Capital de Giro,Cheque Especial,Consignado,Imobiliário,Outros Créditos,Pessoal,Troca de Modalidade,Veículos'
Url: 'https://www.bb.com.br'
DateOperationStarted: '2002-04-22'
DatePixStarted: '2020-11-03 06:30:00'
DateRegistered: '2021-05-05 09:11:12'
DateUpdated: '2024-05-15 16:49:45'
created_at: null
updated_at: null
properties:
id:
type: integer
example: 1
COMPE:
type: string
example: '001'
ISPB:
type: string
example: '00000000'
Document:
type: string
example: 00.000.000/0001-91
LongName:
type: string
example: 'Banco do Brasil S.A.'
ShortName:
type: string
example: 'BCO DO BRASIL S.A.'
Network:
type: string
example: 'Banco Múltiplo'
Type:
type: string
example: DRCT
PixType:
type: string
example: RSFN
Charge:
type: integer
example: 1
CreditDocument:
type: integer
example: 1
LegalCheque:
type: integer
example: 1
DetectaFlow:
type: integer
example: 0
PCR:
type: integer
example: 1
PCRP:
type: integer
example: 1
SalaryPortability:
type: string
example: 'Banco folha e Destinatário'
Products:
type: string
example: 'Capital de Giro,Cheque Especial,Consignado,Imobiliário,Outros Créditos,Pessoal,Troca de Modalidade,Veículos'
Url:
type: string
example: 'https://www.bb.com.br'
DateOperationStarted:
type: string
example: '2002-04-22'
DatePixStarted:
type: string
example: '2020-11-03 06:30:00'
DateRegistered:
type: string
example: '2021-05-05 09:11:12'
DateUpdated:
type: string
example: '2024-05-15 16:49:45'
created_at:
type: string
example: null
updated_at:
type: string
example: null
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the bank.'
example: 1
required: true
schema:
type: integer
/api/v1/webhooks/pagarme:
post:
summary: 'Processar webhook do PagarMe'
operationId: processarWebhookDoPagarMe
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Webhook recebido e será processado'
properties:
status:
type: string
example: success
message:
type: string
example: 'Webhook recebido e será processado'
tags:
- Endpoints
/api/v1/webhooks/stripe:
post:
summary: 'Processar webhook do Stripe'
operationId: processarWebhookDoStripe
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Webhook recebido e será processado'
properties:
status:
type: string
example: success
message:
type: string
example: 'Webhook recebido e será processado'
tags:
- Endpoints
/api/v1/webhooks/mercadopago:
post:
summary: 'Processar webhook do Mercado Pago'
operationId: processarWebhookDoMercadoPago
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Webhook recebido e será processado'
properties:
status:
type: string
example: success
message:
type: string
example: 'Webhook recebido e será processado'
tags:
- Endpoints
'/api/v1/webhooks/{gateway}':
post:
summary: 'Processar webhook genérico'
operationId: processarWebhookGenrico
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
message: 'Webhook recebido e será processado'
properties:
status:
type: string
example: success
message:
type: string
example: 'Webhook recebido e será processado'
tags:
- Endpoints
parameters:
-
in: path
name: gateway
description: ''
example: architecto
required: true
schema:
type: string
/api/register:
post:
summary: 'Register a new user'
operationId: registerANewUser
description: ''
parameters: []
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'User registered successfully'
user:
id: 1
name: 'João Silva'
email: joao@example.com
phone: '11999999999'
user_type: individual
is_active: true
properties:
message:
type: string
example: 'User registered successfully'
user:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'João Silva'
email:
type: string
example: joao@example.com
phone:
type: string
example: '11999999999'
user_type:
type: string
example: individual
is_active:
type: boolean
example: true
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Validation failed'
errors:
name:
- 'Nome é obrigatório'
email:
- 'Email é obrigatório'
password:
- 'Senha é obrigatória'
properties:
message:
type: string
example: 'Validation failed'
errors:
type: object
properties:
name:
type: array
example:
- 'Nome é obrigatório'
items:
type: string
email:
type: array
example:
- 'Email é obrigatório'
items:
type: string
password:
type: array
example:
- 'Senha é obrigatória'
items:
type: string
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Nome completo do usuário.'
example: 'João Silva'
email:
type: string
description: 'Email do usuário.'
example: joao@example.com
password:
type: string
description: 'Senha do usuário (mínimo 8 caracteres).'
example: password123
password_confirmation:
type: string
description: 'Confirmação da senha.'
example: password123
phone:
type: string
description: 'Opcional. Telefone do usuário.'
example: '11999999999'
document:
type: string
description: 'Opcional. Documento do usuário.'
example: '12345678901'
user_type:
type: string
description: 'Opcional. Tipo do usuário.'
example: individual
required:
- name
- email
- password
- password_confirmation
/api/login:
post:
summary: 'Login user'
operationId: loginUser
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Login successful'
user:
id: 1
name: 'João Silva'
email: joao@example.com
phone: '11999999999'
user_type: individual
is_active: true
token: 1|abcdef123456...
properties:
message:
type: string
example: 'Login successful'
user:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'João Silva'
email:
type: string
example: joao@example.com
phone:
type: string
example: '11999999999'
user_type:
type: string
example: individual
is_active:
type: boolean
example: true
token:
type: string
example: 1|abcdef123456...
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Credenciais inválidas'
properties:
message:
type: string
example: 'Credenciais inválidas'
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'Email do usuário.'
example: joao@example.com
password:
type: string
description: 'Senha do usuário.'
example: password123
required:
- email
- password
/api/v1/ledger:
get:
summary: 'Listar extrato do credor (com filtro opcional por cobrança)'
operationId: listarExtratoDoCredorcomFiltroOpcionalPorCobrana
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Extrato
/api/v1/financings:
get:
summary: ''
operationId: getApiV1Financings
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Financiamento
post:
summary: ''
operationId: postApiV1Financings
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Financiamento
/api/v1/financings/simulate:
post:
summary: ''
operationId: postApiV1FinancingsSimulate
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Financiamento
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
interest_rate_monthly:
type: number
description: 'Taxa ao mês. Aceita 0.02 (2%) ou 2 (2%).'
example: 4326.41688
required:
- interest_rate_monthly
'/api/v1/financings/{id}':
get:
summary: ''
operationId: getApiV1FinancingsId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Financiamento
parameters:
-
in: path
name: id
description: 'The ID of the financing.'
example: architecto
required: true
schema:
type: string
'/api/v1/financings/{id}/generate-charge':
post:
summary: ''
operationId: postApiV1FinancingsIdGenerateCharge
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Financiamento
parameters:
-
in: path
name: id
description: 'The ID of the financing.'
example: architecto
required: true
schema:
type: string
'/api/v1/financings/{id}/anticipate':
post:
summary: ''
operationId: postApiV1FinancingsIdAnticipate
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Financiamento
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
count:
type: integer
description: 'Número de parcelas a antecipar. Exemplo: 3'
example: 16
amount:
type: number
description: 'Valor para antecipar. Exemplo: 1500.00'
example: 4326.41688
parameters:
-
in: path
name: id
description: 'The ID of the financing.'
example: architecto
required: true
schema:
type: string
'/api/v1/financings/{id}/anticipate/apply':
post:
summary: ''
operationId: postApiV1FinancingsIdAnticipateApply
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Financiamento
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
amount:
type: number
description: 'Valor a antecipar. Exemplo: 1500.00'
example: 4326.41688
mode:
type: string
description: 'Estratégia: reduce_term ou reduce_installment'
example: architecto
manual_payment_method:
type: string
description: 'Opcional. Método para registrar pagamento manual'
example: architecto
manual_payment_notes:
type: string
description: 'Opcional. Observações do pagamento'
example: architecto
manual_payment_date:
type: date
description: 'Opcional. Data do pagamento manual'
example: architecto
required:
- amount
- mode
parameters:
-
in: path
name: id
description: 'The ID of the financing.'
example: architecto
required: true
schema:
type: string
/api/v1/my-charges:
get:
summary: 'Listar cobranças do usuário'
operationId: listarCobranasDoUsurio
description: "Lista todas as cobranças vinculadas ao usuário autenticado.\nAs cobranças são vinculadas por:\n- Email verificado OU login social\n- Telefone verificado"
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'My Charges'
/api/v1/my-charges/statistics:
get:
summary: 'Obter estatísticas das cobranças'
operationId: obterEstatsticasDasCobranas
description: 'Retorna estatísticas das cobranças do usuário autenticado.'
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'My Charges'
'/api/v1/my-charges/{id}':
get:
summary: 'Visualizar cobrança específica'
operationId: visualizarCobranaEspecfica
description: 'Exibe detalhes de uma cobrança específica do usuário autenticado.'
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'My Charges'
parameters:
-
in: path
name: id
description: 'The ID of the my charge.'
example: architecto
required: true
schema:
type: string
/api/v1/pix-manual/create:
post:
summary: 'Criar pagamento PIX Manual'
operationId: criarPagamentoPIXManual
description: ''
parameters: []
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Pagamento PIX Manual criado com sucesso'
data:
id: 1
charge_id: 1
installment_id: 1
amount: 10000
status: pending
payment_method: pix_manual
pix_key: PIX-000001-20240101120000
pix_manual_confirmation_code: ABC12345
created_at: '2024-01-01T00:00:00.000000Z'
properties:
message:
type: string
example: 'Pagamento PIX Manual criado com sucesso'
data:
type: object
properties:
id:
type: integer
example: 1
charge_id:
type: integer
example: 1
installment_id:
type: integer
example: 1
amount:
type: integer
example: 10000
status:
type: string
example: pending
payment_method:
type: string
example: pix_manual
pix_key:
type: string
example: PIX-000001-20240101120000
pix_manual_confirmation_code:
type: string
example: ABC12345
created_at:
type: string
example: '2024-01-01T00:00:00.000000Z'
tags:
- 'PIX Manual'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
charge_id:
type: integer
description: 'ID da cobrança.'
example: 1
installment_id:
type: integer
description: 'ID da parcela.'
example: 1
pix_manual_amount:
type: number
description: 'Opcional. Valor do pagamento.'
example: 100.0
pix_key:
type: string
description: 'Opcional. Chave PIX.'
example: '12345678901'
pix_manual_notes:
type: string
description: 'Opcional. Observações.'
example: 'Pagamento via PIX'
pix_manual_date:
type: string
description: 'Opcional. Data do pagamento.'
example: '2024-01-01'
required:
- charge_id
- installment_id
'/api/v1/pix-manual/{id}/confirm':
post:
summary: 'Confirmar pagamento PIX Manual'
operationId: confirmarPagamentoPIXManual
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Pagamento PIX Manual confirmado com sucesso'
data:
id: 1
status: approved
pix_manual_confirmed_at: '2024-01-01T00:00:00.000000Z'
properties:
message:
type: string
example: 'Pagamento PIX Manual confirmado com sucesso'
data:
type: object
properties:
id:
type: integer
example: 1
status:
type: string
example: approved
pix_manual_confirmed_at:
type: string
example: '2024-01-01T00:00:00.000000Z'
tags:
- 'PIX Manual'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
confirmation_code:
type: string
description: 'Opcional. Código de confirmação.'
example: ABC12345
confirmation_notes:
type: string
description: 'Opcional. Observações da confirmação.'
example: 'Pagamento confirmado'
parameters:
-
in: path
name: id
description: 'ID do pagamento.'
example: 1
required: true
schema:
type: integer
'/api/v1/pix-manual/{id}/cancel':
post:
summary: 'Cancelar pagamento PIX Manual'
operationId: cancelarPagamentoPIXManual
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Pagamento PIX Manual cancelado com sucesso'
data:
id: 1
status: cancelled
pix_manual_cancelled_at: '2024-01-01T00:00:00.000000Z'
properties:
message:
type: string
example: 'Pagamento PIX Manual cancelado com sucesso'
data:
type: object
properties:
id:
type: integer
example: 1
status:
type: string
example: cancelled
pix_manual_cancelled_at:
type: string
example: '2024-01-01T00:00:00.000000Z'
tags:
- 'PIX Manual'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
reason:
type: string
description: 'Opcional. Motivo do cancelamento.'
example: 'Pagamento não realizado'
parameters:
-
in: path
name: id
description: 'ID do pagamento.'
example: 1
required: true
schema:
type: integer
/api/v1/pix-manual/pending:
get:
summary: 'Listar pagamentos PIX Manual pendentes'
operationId: listarPagamentosPIXManualPendentes
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Pagamentos PIX Manual pendentes obtidos com sucesso'
data:
-
id: 1
charge_id: 1
installment_id: 1
amount: 10000
status: pending
pix_key: PIX-000001-20240101120000
pix_manual_confirmation_code: ABC12345
created_at: '2024-01-01T00:00:00.000000Z'
properties:
message:
type: string
example: 'Pagamentos PIX Manual pendentes obtidos com sucesso'
data:
type: array
example:
-
id: 1
charge_id: 1
installment_id: 1
amount: 10000
status: pending
pix_key: PIX-000001-20240101120000
pix_manual_confirmation_code: ABC12345
created_at: '2024-01-01T00:00:00.000000Z'
items:
type: object
properties:
id:
type: integer
example: 1
charge_id:
type: integer
example: 1
installment_id:
type: integer
example: 1
amount:
type: integer
example: 10000
status:
type: string
example: pending
pix_key:
type: string
example: PIX-000001-20240101120000
pix_manual_confirmation_code:
type: string
example: ABC12345
created_at:
type: string
example: '2024-01-01T00:00:00.000000Z'
tags:
- 'PIX Manual'
/api/v1/pix-manual/statistics:
get:
summary: 'Estatísticas de PIX Manual'
operationId: estatsticasDePIXManual
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Estatísticas de PIX Manual obtidas com sucesso'
data:
total_payments: 10
pending_payments: 3
approved_payments: 6
cancelled_payments: 1
total_amount: 100000
pending_amount: 30000
approved_amount: 60000
properties:
message:
type: string
example: 'Estatísticas de PIX Manual obtidas com sucesso'
data:
type: object
properties:
total_payments:
type: integer
example: 10
pending_payments:
type: integer
example: 3
approved_payments:
type: integer
example: 6
cancelled_payments:
type: integer
example: 1
total_amount:
type: integer
example: 100000
pending_amount:
type: integer
example: 30000
approved_amount:
type: integer
example: 60000
tags:
- 'PIX Manual'
'/api/v1/charges/{id}/manual-payment':
post:
summary: 'Processar quitação manual de parcelas'
operationId: processarQuitaoManualDeParcelas
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Pagamentos processados com sucesso'
data:
payments:
-
id: 123
installment_id: 456
amount: 300.0
payment_method: manual
status: approved
charge:
id: 01K5T9B6R8XCBSZ0FXZGH9RKC7
properties:
message:
type: string
example: 'Pagamentos processados com sucesso'
data:
type: object
properties:
payments:
type: array
example:
-
id: 123
installment_id: 456
amount: 300
payment_method: manual
status: approved
items:
type: object
properties:
id:
type: integer
example: 123
installment_id:
type: integer
example: 456
amount:
type: number
example: 300.0
payment_method:
type: string
example: manual
status:
type: string
example: approved
charge:
type: object
properties:
id:
type: string
example: 01K5T9B6R8XCBSZ0FXZGH9RKC7
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Uma ou mais parcelas já foram quitadas'
properties:
message:
type: string
example: 'Uma ou mais parcelas já foram quitadas'
tags:
- 'Pagamentos Manuais'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
installment_ids:
type: array
description: 'IDs das parcelas a serem quitadas. Exemplo: [123, 456]'
example:
- architecto
items:
type: string
manual_payment_method:
type: string
description: 'Método do pagamento manual. Um de: dinheiro, transferencia, pix, pix_manual, cheque, deposito, outros. Exemplo: pix_manual'
example: architecto
manual_payment_notes:
type: string
description: 'Observações do pagamento manual. Máx 1000 caracteres. Exemplo: Pagamento manual da parcela 1'
example: architecto
manual_payment_date:
type: date
description: 'Data em que o pagamento foi realizado. Não pode ser futura. Exemplo: 2025-09-23'
example: architecto
manual_payment_amount:
type: number
description: 'Valor do pagamento. Se omitido, assume o valor da parcela.'
example: 4326.41688
required:
- installment_ids
- manual_payment_method
parameters:
-
in: path
name: id
description: 'ULID da cobrança. Exemplo: 01K5T9B6R8XCBSZ0FXZGH9RKC7'
example: architecto
required: true
schema:
type: string
'/api/v1/charges/{id}/manual-payment/automatic-allocation':
post:
summary: 'Alocação automática de pagamento manual (quita + abate)'
operationId: alocaoAutomticaDePagamentoManualquita+Abate
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Alocação automática processada com sucesso'
data:
payments:
-
id: 123
charge_id: 01K5T9B6R8XCBSZ0FXZGH9RKC7
installment_id: 456
amount: 300.0
payment_method: manual
status: approved
manual_payment_method: pix_manual
confirmed_at: '2025-09-23T12:00:00Z'
charge:
id: 01K5T9B6R8XCBSZ0FXZGH9RKC7
installments:
-
id: 456
installment_number: 1
amount: 300.0
status: paid
-
id: 789
installment_number: 2
amount: 300.0
status: paid
-
id: 1011
installment_number: 3
amount: 350.0
status: pending
properties:
message:
type: string
example: 'Alocação automática processada com sucesso'
data:
type: object
properties:
payments:
type: array
example:
-
id: 123
charge_id: 01K5T9B6R8XCBSZ0FXZGH9RKC7
installment_id: 456
amount: 300
payment_method: manual
status: approved
manual_payment_method: pix_manual
confirmed_at: '2025-09-23T12:00:00Z'
items:
type: object
properties:
id:
type: integer
example: 123
charge_id:
type: string
example: 01K5T9B6R8XCBSZ0FXZGH9RKC7
installment_id:
type: integer
example: 456
amount:
type: number
example: 300.0
payment_method:
type: string
example: manual
status:
type: string
example: approved
manual_payment_method:
type: string
example: pix_manual
confirmed_at:
type: string
example: '2025-09-23T12:00:00Z'
charge:
type: object
properties:
id:
type: string
example: 01K5T9B6R8XCBSZ0FXZGH9RKC7
installments:
type: array
example:
-
id: 456
installment_number: 1
amount: 300
status: paid
-
id: 789
installment_number: 2
amount: 300
status: paid
-
id: 1011
installment_number: 3
amount: 350
status: pending
items:
type: object
properties:
id:
type: integer
example: 456
installment_number:
type: integer
example: 1
amount:
type: number
example: 300.0
status:
type: string
example: paid
422:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Erro ao processar alocação automática'
error: 'Valor informado excede o total pendente das parcelas'
properties:
message:
type: string
example: 'Erro ao processar alocação automática'
error:
type: string
example: 'Valor informado excede o total pendente das parcelas'
tags:
- 'Pagamentos Manuais'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
amount:
type: number
description: 'Valor a ser alocado automaticamente entre as parcelas. Exemplo: 650.00'
example: 4326.41688
manual_payment_method:
type: string
description: 'Método do pagamento manual. Um de: dinheiro, transferencia, pix, pix_manual, cheque, deposito, outros. Exemplo: pix_manual'
example: architecto
manual_payment_notes:
type: string
description: 'Observações do pagamento manual. Máx 1000 caracteres. Exemplo: Pagamento manual de 650'
example: architecto
manual_payment_date:
type: date
description: 'Data em que o pagamento foi realizado. Não pode ser futura. Exemplo: 2025-09-23'
example: architecto
required:
- amount
- manual_payment_method
parameters:
-
in: path
name: id
description: 'ULID da cobrança. Exemplo: 01K5T9B6R8XCBSZ0FXZGH9RKC7'
example: architecto
required: true
schema:
type: string
/api/v1/payments:
get:
summary: 'Listar pagamentos'
operationId: listarPagamentos
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Pagamentos obtidos com sucesso'
data:
data:
-
id: 1
charge_id: 1
amount: 10000
status: pending
payment_method: pix
gateway_transaction_id: tx_123456
created_at: '2024-01-01T00:00:00.000000Z'
meta:
total: 100
per_page: 15
current_page: 1
total_pages: 7
properties:
message:
type: string
example: 'Pagamentos obtidos com sucesso'
data:
type: object
properties:
data:
type: array
example:
-
id: 1
charge_id: 1
amount: 10000
status: pending
payment_method: pix
gateway_transaction_id: tx_123456
created_at: '2024-01-01T00:00:00.000000Z'
items:
type: object
properties:
id:
type: integer
example: 1
charge_id:
type: integer
example: 1
amount:
type: integer
example: 10000
status:
type: string
example: pending
payment_method:
type: string
example: pix
gateway_transaction_id:
type: string
example: tx_123456
created_at:
type: string
example: '2024-01-01T00:00:00.000000Z'
meta:
type: object
properties:
total:
type: integer
example: 100
per_page:
type: integer
example: 15
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 7
tags:
- Payments
post:
summary: 'Criar pagamento'
operationId: criarPagamento
description: ''
parameters: []
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Pagamento criado com sucesso'
data:
id: 1
charge_id: 1
amount: 10000
status: pending
payment_method: pix
gateway: pagarme
created_at: '2024-01-01T00:00:00.000000Z'
properties:
message:
type: string
example: 'Pagamento criado com sucesso'
data:
type: object
properties:
id:
type: integer
example: 1
charge_id:
type: integer
example: 1
amount:
type: integer
example: 10000
status:
type: string
example: pending
payment_method:
type: string
example: pix
gateway:
type: string
example: pagarme
created_at:
type: string
example: '2024-01-01T00:00:00.000000Z'
tags:
- Payments
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
charge_id:
type: integer
description: 'ID da cobrança.'
example: 1
amount:
type: integer
description: 'Valor em centavos.'
example: 10000
payment_method:
type: string
description: 'Método de pagamento.'
example: pix
gateway:
type: string
description: 'Gateway de pagamento.'
example: pagarme
metadata:
type: object
description: 'Opcional. Metadados adicionais.'
example: []
properties: { }
required:
- charge_id
- amount
- payment_method
- gateway
/api/v1/payments/statistics:
get:
summary: 'Estatísticas de pagamentos'
operationId: estatsticasDePagamentos
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Estatísticas obtidas com sucesso'
data:
total_payments: 100
total_amount: 1000000
pending_payments: 10
paid_payments: 80
failed_payments: 10
average_amount: 10000
properties:
message:
type: string
example: 'Estatísticas obtidas com sucesso'
data:
type: object
properties:
total_payments:
type: integer
example: 100
total_amount:
type: integer
example: 1000000
pending_payments:
type: integer
example: 10
paid_payments:
type: integer
example: 80
failed_payments:
type: integer
example: 10
average_amount:
type: integer
example: 10000
tags:
- Payments
'/api/v1/payments/{id}':
get:
summary: 'Exibir pagamento'
operationId: exibirPagamento
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Pagamento obtido com sucesso'
data:
id: 1
charge_id: 1
amount: 10000
status: pending
payment_method: pix
gateway: pagarme
created_at: '2024-01-01T00:00:00.000000Z'
properties:
message:
type: string
example: 'Pagamento obtido com sucesso'
data:
type: object
properties:
id:
type: integer
example: 1
charge_id:
type: integer
example: 1
amount:
type: integer
example: 10000
status:
type: string
example: pending
payment_method:
type: string
example: pix
gateway:
type: string
example: pagarme
created_at:
type: string
example: '2024-01-01T00:00:00.000000Z'
tags:
- Payments
put:
summary: 'Atualizar pagamento'
operationId: atualizarPagamento
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Pagamento atualizado com sucesso'
data:
id: 1
charge_id: 1
amount: 10000
status: paid
payment_method: pix
gateway: pagarme
updated_at: '2024-01-01T00:00:00.000000Z'
properties:
message:
type: string
example: 'Pagamento atualizado com sucesso'
data:
type: object
properties:
id:
type: integer
example: 1
charge_id:
type: integer
example: 1
amount:
type: integer
example: 10000
status:
type: string
example: paid
payment_method:
type: string
example: pix
gateway:
type: string
example: pagarme
updated_at:
type: string
example: '2024-01-01T00:00:00.000000Z'
tags:
- Payments
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: 'Opcional. Status do pagamento.'
example: paid
gateway_transaction_id:
type: string
description: 'Opcional. ID da transação no gateway.'
example: tx_123456
metadata:
type: object
description: 'Opcional. Metadados adicionais.'
example: []
properties: { }
parameters:
-
in: path
name: id
description: 'ID do pagamento.'
example: 1
required: true
schema:
type: integer
'/api/v1/payments/{id}/refund':
post:
summary: 'Estornar pagamento'
operationId: estornarPagamento
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Pagamento estornado com sucesso'
data:
id: 1
charge_id: 1
amount: 10000
status: refunded
payment_method: pix
gateway: pagarme
updated_at: '2024-01-01T00:00:00.000000Z'
properties:
message:
type: string
example: 'Pagamento estornado com sucesso'
data:
type: object
properties:
id:
type: integer
example: 1
charge_id:
type: integer
example: 1
amount:
type: integer
example: 10000
status:
type: string
example: refunded
payment_method:
type: string
example: pix
gateway:
type: string
example: pagarme
updated_at:
type: string
example: '2024-01-01T00:00:00.000000Z'
tags:
- Payments
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
reason:
type: string
description: 'Opcional. Motivo do estorno.'
example: 'Solicitação do cliente'
amount:
type: integer
description: 'Opcional. Valor do estorno em centavos.'
example: 10000
parameters:
-
in: path
name: id
description: 'ID do pagamento.'
example: 1
required: true
schema:
type: integer
'/api/v1/payments/{id}/status':
get:
summary: 'Status do pagamento'
operationId: statusDoPagamento
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Status obtido com sucesso'
data:
id: 1
status: paid
gateway_status: approved
last_updated: '2024-01-01T00:00:00.000000Z'
properties:
message:
type: string
example: 'Status obtido com sucesso'
data:
type: object
properties:
id:
type: integer
example: 1
status:
type: string
example: paid
gateway_status:
type: string
example: approved
last_updated:
type: string
example: '2024-01-01T00:00:00.000000Z'
tags:
- Payments
parameters:
-
in: path
name: id
description: 'ID do pagamento.'
example: 1
required: true
schema:
type: integer
/api/v1/plans:
get:
summary: 'Listar planos ativos'
operationId: listarPlanosAtivos
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Plans
/api/v1/plans/me:
get:
summary: 'Meu plano atual'
operationId: meuPlanoAtual
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Plans
/api/v1/plans/assign:
post:
summary: 'Atribuir plano ao usuário autenticado'
operationId: atribuirPlanoAoUsurioAutenticado
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Plans
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
plan_id:
type: integer
description: 'ID do plano'
example: 16
starts_at:
type: date
description: 'Opcional. Data de início'
example: architecto
required:
- plan_id
/api/v1/recipients/search:
get:
summary: 'Search recipients'
operationId: searchRecipients
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 10
name: 'Maria Oliveira'
email: maria@example.com
document: '12345678901'
document_type: cpf
is_active: true
properties:
data:
type: array
example:
-
id: 10
name: 'Maria Oliveira'
email: maria@example.com
document: '12345678901'
document_type: cpf
is_active: true
items:
type: object
properties:
id:
type: integer
example: 10
name:
type: string
example: 'Maria Oliveira'
email:
type: string
example: maria@example.com
document:
type: string
example: '12345678901'
document_type:
type: string
example: cpf
is_active:
type: boolean
example: true
tags:
- Recipients
/api/v1/webhooks/relayo/whatsapp/receive:
post:
summary: 'Recebe eventos do WhatsApp'
operationId: recebeEventosDoWhatsApp
description: 'Endpoint público para receber callbacks do RelayO contendo mensagens e eventos de instância.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
properties:
success:
type: boolean
example: true
tags:
- 'RelayO Webhooks'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
http_params:
type: object
description: 'Conteúdo do evento conforme exemplos fornecidos'
example: []
properties: { }
required:
- http_params
/api/v1/relayo/instances:
get:
summary: 'Lista todas as instâncias WhatsApp'
operationId: listaTodasAsInstnciasWhatsApp
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
-
id: 1
name: 'Instância Principal'
instance_id: relayo_instance_123
status: connected
is_connected: true
last_connected_at: '01/10/2025 22:30:00'
created_at: '01/10/2025 22:00:00'
message: 'Instâncias listadas com sucesso'
properties:
success:
type: boolean
example: true
data:
type: array
example:
-
id: 1
name: 'Instância Principal'
instance_id: relayo_instance_123
status: connected
is_connected: true
last_connected_at: '01/10/2025 22:30:00'
created_at: '01/10/2025 22:00:00'
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'Instância Principal'
instance_id:
type: string
example: relayo_instance_123
status:
type: string
example: connected
is_connected:
type: boolean
example: true
last_connected_at:
type: string
example: '01/10/2025 22:30:00'
created_at:
type: string
example: '01/10/2025 22:00:00'
message:
type: string
example: 'Instâncias listadas com sucesso'
500:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Erro ao listar instâncias'
error: 'Mensagem de erro'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Erro ao listar instâncias'
error:
type: string
example: 'Mensagem de erro'
tags:
- 'RelayO WhatsApp Management'
'/api/v1/relayo/instances/{id}':
get:
summary: 'Obtém detalhes de uma instância específica'
operationId: obtmDetalhesDeUmaInstnciaEspecfica
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
id: 1
name: 'Instância Principal'
instance_id: relayo_instance_123
status: connected
is_connected: true
last_connected_at: '01/10/2025 22:30:00'
created_at: '01/10/2025 22:00:00'
message: 'Instância obtida com sucesso'
properties:
success:
type: boolean
example: true
data:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'Instância Principal'
instance_id:
type: string
example: relayo_instance_123
status:
type: string
example: connected
is_connected:
type: boolean
example: true
last_connected_at:
type: string
example: '01/10/2025 22:30:00'
created_at:
type: string
example: '01/10/2025 22:00:00'
message:
type: string
example: 'Instância obtida com sucesso'
404:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Instância não encontrada'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Instância não encontrada'
tags:
- 'RelayO WhatsApp Management'
parameters:
-
in: path
name: id
description: 'ID da instância'
example: architecto
required: true
schema:
type: string
'/api/v1/relayo/instances/{id}/qrcode':
get:
summary: 'Obtém o QR Code de uma instância'
operationId: obtmOQRCodeDeUmaInstncia
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
qrcode: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...'
status: disconnected
message: 'QR Code obtido com sucesso'
properties:
success:
type: boolean
example: true
data:
type: object
properties:
qrcode:
type: string
example: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...'
status:
type: string
example: disconnected
message:
type: string
example: 'QR Code obtido com sucesso'
tags:
- 'RelayO WhatsApp Management'
parameters:
-
in: path
name: id
description: 'ID da instância'
example: architecto
required: true
schema:
type: string
'/api/v1/relayo/instances/{id}/toggle':
post:
summary: 'Ativa/desativa uma instância'
operationId: ativadesativaUmaInstncia
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
id: 1
is_active: false
message: 'Instância desativada'
properties:
success:
type: boolean
example: true
data:
type: object
properties:
id:
type: integer
example: 1
is_active:
type: boolean
example: false
message:
type: string
example: 'Instância desativada'
tags:
- 'RelayO WhatsApp Management'
parameters:
-
in: path
name: id
description: 'ID da instância'
example: architecto
required: true
schema:
type: string
/api/v1/relayo/instances/sync:
post:
summary: 'Sincroniza as instâncias com o RelayO'
operationId: sincronizaAsInstnciasComORelayO
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
instances_count: 3
message: 'Instâncias sincronizadas com sucesso'
properties:
success:
type: boolean
example: true
data:
type: object
properties:
instances_count:
type: integer
example: 3
message:
type: string
example: 'Instâncias sincronizadas com sucesso'
tags:
- 'RelayO WhatsApp Management'
/api/v1/relayo/status:
get:
summary: 'Verifica o status do serviço RelayO'
operationId: verificaOStatusDoServioRelayO
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
service_available: true
total_instances: 3
connected_instances: 2
status: online
message: 'Status do serviço obtido com sucesso'
properties:
success:
type: boolean
example: true
data:
type: object
properties:
service_available:
type: boolean
example: true
total_instances:
type: integer
example: 3
connected_instances:
type: integer
example: 2
status:
type: string
example: online
message:
type: string
example: 'Status do serviço obtido com sucesso'
tags:
- 'RelayO WhatsApp Management'
/api/v1/relayo/test-message:
post:
summary: 'Testa o envio de uma mensagem'
operationId: testaOEnvioDeUmaMensagem
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
success: true
message_id: msg_123456
message: 'Mensagem enviada com sucesso'
message: 'Mensagem enviada com sucesso'
properties:
success:
type: boolean
example: true
data:
type: object
properties:
success:
type: boolean
example: true
message_id:
type: string
example: msg_123456
message:
type: string
example: 'Mensagem enviada com sucesso'
message:
type: string
example: 'Mensagem enviada com sucesso'
422:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Dados inválidos'
errors:
phone_number:
- 'O campo phone_number é obrigatório.'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Dados inválidos'
errors:
type: object
properties:
phone_number:
type: array
example:
- 'O campo phone_number é obrigatório.'
items:
type: string
tags:
- 'RelayO WhatsApp Management'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
instance_id:
type: string
description: 'ID da instância no RelayO'
example: architecto
phone_number:
type: string
description: 'Número do telefone (10-11 dígitos)'
example: architecto
message:
type: string
description: 'Mensagem a ser enviada (máximo 1000 caracteres)'
example: architecto
required:
- instance_id
- phone_number
- message
'/api/v1/subscriptions/{id}/adjustments':
get:
summary: 'Listar ajustes da assinatura (opcional filtro por período)'
operationId: listarAjustesDaAssinaturaopcionalFiltroPorPerodo
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Subscription Adjustments'
post:
summary: 'Criar ajuste no período'
operationId: criarAjusteNoPerodo
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Subscription Adjustments'
parameters:
-
in: path
name: id
description: 'The ID of the subscription.'
example: architecto
required: true
schema:
type: string
'/api/v1/subscriptions/{id}/adjustments/{adjustmentId}':
put:
summary: 'Atualizar ajuste'
operationId: atualizarAjuste
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Subscription Adjustments'
delete:
summary: 'Remover ajuste'
operationId: removerAjuste
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Subscription Adjustments'
parameters:
-
in: path
name: id
description: 'The ID of the subscription.'
example: architecto
required: true
schema:
type: string
-
in: path
name: adjustmentId
description: ''
example: architecto
required: true
schema:
type: string
/api/v1/subscriptions:
get:
summary: 'Listar assinaturas'
operationId: listarAssinaturas
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Subscriptions
post:
summary: 'Criar assinatura'
operationId: criarAssinatura
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Subscriptions
/api/v1/subscriptions/statistics:
get:
summary: 'Estatísticas das assinaturas do usuário autenticado'
operationId: estatsticasDasAssinaturasDoUsurioAutenticado
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Subscriptions
'/api/v1/subscriptions/{id}':
get:
summary: 'Detalhar assinatura'
operationId: detalharAssinatura
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Subscriptions
patch:
summary: 'Atualizar assinatura'
operationId: atualizarAssinatura
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Subscriptions
parameters:
-
in: path
name: id
description: 'The ID of the subscription.'
example: architecto
required: true
schema:
type: string
'/api/v1/subscriptions/{id}/preview':
get:
summary: 'Prévia de cobrança do período'
operationId: prviaDeCobranaDoPerodo
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Subscriptions
parameters:
-
in: path
name: id
description: 'The ID of the subscription.'
example: architecto
required: true
schema:
type: string
'/api/v1/subscriptions/{id}/generate':
post:
summary: 'Gerar cobrança do período (idempotente)'
operationId: gerarCobranaDoPerodoidempotente
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Subscriptions
parameters:
-
in: path
name: id
description: 'The ID of the subscription.'
example: architecto
required: true
schema:
type: string
'/api/v1/subscriptions/{id}/recalculate':
post:
summary: 'Recalcular cobrança existente do período'
operationId: recalcularCobranaExistenteDoPerodo
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Subscriptions
parameters:
-
in: path
name: id
description: 'The ID of the subscription.'
example: architecto
required: true
schema:
type: string
/api/v1/version:
get:
summary: 'Obter versão do sistema'
operationId: obterVersoDoSistema
description: 'Retorna a versão atual do sistema baseada no Git'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
version: v1.2.3
commit: abc123def456
branch: main
timestamp: '2024-01-01T12:00:00Z'
properties:
version:
type: string
example: v1.2.3
commit:
type: string
example: abc123def456
branch:
type: string
example: main
timestamp:
type: string
example: '2024-01-01T12:00:00Z'
tags:
- System
/api/v1/version/detailed:
get:
summary: 'Obter informações detalhadas da versão'
operationId: obterInformaesDetalhadasDaVerso
description: 'Retorna informações mais detalhadas sobre a versão atual'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
version: v1.2.3
commit: abc123def456
commit_short: abc123d
branch: main
timestamp: '2024-01-01T12:00:00Z'
author: 'Developer Name'
message: 'Commit message'
date: '2024-01-01T10:00:00Z'
properties:
version:
type: string
example: v1.2.3
commit:
type: string
example: abc123def456
commit_short:
type: string
example: abc123d
branch:
type: string
example: main
timestamp:
type: string
example: '2024-01-01T12:00:00Z'
author:
type: string
example: 'Developer Name'
message:
type: string
example: 'Commit message'
date:
type: string
example: '2024-01-01T10:00:00Z'
tags:
- System
/api/v1/users:
get:
summary: 'Listar usuários'
operationId: listarUsurios
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Usuários obtidos com sucesso'
data:
data:
-
id: 1
name: 'João Silva'
email: joao@example.com
status: active
created_at: '2024-01-01T00:00:00.000000Z'
meta:
total: 100
per_page: 15
current_page: 1
total_pages: 7
properties:
message:
type: string
example: 'Usuários obtidos com sucesso'
data:
type: object
properties:
data:
type: array
example:
-
id: 1
name: 'João Silva'
email: joao@example.com
status: active
created_at: '2024-01-01T00:00:00.000000Z'
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'João Silva'
email:
type: string
example: joao@example.com
status:
type: string
example: active
created_at:
type: string
example: '2024-01-01T00:00:00.000000Z'
meta:
type: object
properties:
total:
type: integer
example: 100
per_page:
type: integer
example: 15
current_page:
type: integer
example: 1
total_pages:
type: integer
example: 7
tags:
- Users
/api/v1/users/profile:
get:
summary: 'Obter perfil do usuário autenticado'
operationId: obterPerfilDoUsurioAutenticado
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Users
put:
summary: 'Atualizar perfil do usuário autenticado'
operationId: atualizarPerfilDoUsurioAutenticado
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Users
/api/v1/users/pix-status:
get:
summary: 'Verificar se a chave PIX está ativada'
operationId: verificarSeAChavePIXEstAtivada
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Status da chave PIX obtido com sucesso'
data:
pix_activated: true
chave_pix: '11999999999'
pix_key_type: phone
properties:
message:
type: string
example: 'Status da chave PIX obtido com sucesso'
data:
type: object
properties:
pix_activated:
type: boolean
example: true
chave_pix:
type: string
example: '11999999999'
pix_key_type:
type: string
example: phone
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated
properties:
message:
type: string
example: Unauthenticated
tags:
- Users
/api/v1/users/find:
get:
summary: 'Buscar usuário por CPF ou email'
operationId: buscarUsurioPorCPFOuEmail
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Users
/api/v1/users/verify:
post:
summary: 'Verificar usuário por token'
operationId: verificarUsurioPorToken
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Users
'/api/v1/users/{id}':
get:
summary: 'Obter usuário específico'
operationId: obterUsurioEspecfico
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Users
put:
summary: 'Atualizar usuário'
operationId: atualizarUsurio
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Users
delete:
summary: 'Excluir usuário (soft delete)'
operationId: excluirUsuriosoftDelete
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Usuário excluído com sucesso'
data:
id: 1
name: 'João Silva'
email: joao@example.com
deleted_at: '2024-01-01T00:00:00.000000Z'
properties:
message:
type: string
example: 'Usuário excluído com sucesso'
data:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'João Silva'
email:
type: string
example: joao@example.com
deleted_at:
type: string
example: '2024-01-01T00:00:00.000000Z'
400:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Confirmação inválida'
error: INVALID_CONFIRMATION
properties:
message:
type: string
example: 'Confirmação inválida'
error:
type: string
example: INVALID_CONFIRMATION
404:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Usuário não encontrado'
error: USER_NOT_FOUND
properties:
message:
type: string
example: 'Usuário não encontrado'
error:
type: string
example: USER_NOT_FOUND
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
confirmation:
type: string
description: 'Confirmação da exclusão. Must be "DELETE".'
example: DELETE
reason:
type: string
description: 'optional Motivo da exclusão.'
example: 'Usuário solicitou exclusão de dados'
required:
- confirmation
parameters:
-
in: path
name: id
description: 'The ID of the user.'
example: architecto
required: true
schema:
type: string
'/api/v1/users/{id}/statistics':
get:
summary: 'Obter estatísticas do usuário'
operationId: obterEstatsticasDoUsurio
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Users
parameters:
-
in: path
name: id
description: 'The ID of the user.'
example: architecto
required: true
schema:
type: string
'/api/v1/users/{id}/debtor-charges':
get:
summary: 'Obter cobranças do devedor'
operationId: obterCobranasDoDevedor
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Users
parameters:
-
in: path
name: id
description: 'The ID of the user.'
example: architecto
required: true
schema:
type: string
'/api/v1/users/{id}/debtor-payments':
get:
summary: 'Obter pagamentos do devedor'
operationId: obterPagamentosDoDevedor
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Users
parameters:
-
in: path
name: id
description: 'The ID of the user.'
example: architecto
required: true
schema:
type: string
/api/v1/email-verification/send-code:
post:
summary: 'Enviar código de verificação'
operationId: enviarCdigoDeVerificao
description: "Envia um código de verificação de 6 dígitos para o e-mail do usuário.\nApenas usuários que não fizeram login via redes sociais podem solicitar."
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
message: 'Código de verificação enviado com sucesso'
expires_at: '2024-01-01T12:15:00.000000Z'
properties:
success:
type: boolean
example: true
message:
type: string
example: 'Código de verificação enviado com sucesso'
expires_at:
type: string
example: '2024-01-01T12:15:00.000000Z'
400:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Usuário social não pode solicitar verificação de e-mail'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Usuário social não pode solicitar verificação de e-mail'
422:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Dados inválidos'
errors:
email:
- 'O campo e-mail é obrigatório'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Dados inválidos'
errors:
type: object
properties:
email:
type: array
example:
- 'O campo e-mail é obrigatório'
items:
type: string
tags:
- 'Verificação de E-mail'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'E-mail para envio do código'
example: gbailey@example.net
required:
- email
/api/v1/email-verification/verify-code:
post:
summary: 'Verificar código'
operationId: verificarCdigo
description: 'Verifica o código de verificação enviado para o e-mail.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
message: 'E-mail verificado com sucesso'
email: usuario@exemplo.com
properties:
success:
type: boolean
example: true
message:
type: string
example: 'E-mail verificado com sucesso'
email:
type: string
example: usuario@exemplo.com
400:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Código inválido ou expirado'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Código inválido ou expirado'
tags:
- 'Verificação de E-mail'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 'Código de 6 dígitos recebido'
example: architecto
required:
- code
/api/v1/email-verification/status:
get:
summary: 'Status da verificação'
operationId: statusDaVerificao
description: 'Retorna o status atual da verificação do e-mail do usuário.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
is_verified: true
email: usuario@exemplo.com
verified_at: '2024-01-01T12:00:00.000000Z'
can_request_verification: true
is_social_user: false
properties:
success:
type: boolean
example: true
data:
type: object
properties:
is_verified:
type: boolean
example: true
email:
type: string
example: usuario@exemplo.com
verified_at:
type: string
example: '2024-01-01T12:00:00.000000Z'
can_request_verification:
type: boolean
example: true
is_social_user:
type: boolean
example: false
tags:
- 'Verificação de E-mail'
/api/v1/phone-verification/send-code:
post:
summary: 'Enviar código de verificação'
operationId: enviarCdigoDeVerificao
description: 'Envia um código de verificação de 6 dígitos para o telefone do usuário via WhatsApp.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
message: 'Código de verificação enviado com sucesso'
expires_at: '2024-01-01T12:10:00.000000Z'
properties:
success:
type: boolean
example: true
message:
type: string
example: 'Código de verificação enviado com sucesso'
expires_at:
type: string
example: '2024-01-01T12:10:00.000000Z'
422:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Dados inválidos'
errors:
phone:
- 'O campo telefone é obrigatório'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Dados inválidos'
errors:
type: object
properties:
phone:
type: array
example:
- 'O campo telefone é obrigatório'
items:
type: string
tags:
- 'Verificação de Telefone'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
phone:
type: string
description: 'Telefone para envio do código (formato: 11999999999)'
example: architecto
required:
- phone
/api/v1/phone-verification/verify-code:
post:
summary: 'Verificar código'
operationId: verificarCdigo
description: 'Verifica o código de verificação enviado para o telefone.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
message: 'Telefone verificado com sucesso'
phone: '11999999999'
properties:
success:
type: boolean
example: true
message:
type: string
example: 'Telefone verificado com sucesso'
phone:
type: string
example: '11999999999'
400:
description: ''
content:
application/json:
schema:
type: object
example:
success: false
message: 'Código inválido ou expirado'
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Código inválido ou expirado'
tags:
- 'Verificação de Telefone'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: 'Código de 6 dígitos recebido'
example: architecto
required:
- code
/api/v1/phone-verification/status:
get:
summary: 'Status da verificação'
operationId: statusDaVerificao
description: 'Retorna o status atual da verificação do telefone do usuário.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
is_verified: true
phone: '11999999999'
verified_at: '2024-01-01T12:00:00.000000Z'
properties:
success:
type: boolean
example: true
data:
type: object
properties:
is_verified:
type: boolean
example: true
phone:
type: string
example: '11999999999'
verified_at:
type: string
example: '2024-01-01T12:00:00.000000Z'
tags:
- 'Verificação de Telefone'