6 - Movimentação de conta

6.1 - Saldo em conta

Este endpoint permite consultar o saldo disponível da conta do cliente autenticado. Além do saldo atual para movimentação, a resposta também retorna informações relacionadas a investimentos, incluindo valores investidos, em investimento e o total consolidado, bem como o identificador único do cliente

[GET] /api/v1/account/balance

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String
amount	Valor disponível	String
amount_investment	Valor em investimento	String
amount_invested	Valor investido	String
amount_investment_total	Valor total em investimentos	String
individual_id	ID do cliente	String

{
    "amount_investment": "0.00",
    "amount_invested": "0.00",
    "amount_investment_total": "0.00",
    "amount": "3.79",
    "success": true,
    "message": "",
    "code": 200,
    "individual_id": "40af4a6a-1dc3-4b73-89a9-d58163af06aa"
}

6.2 - Listar gráfico transacional

Este endpoint retorna o histórico consolidado de movimentações financeiras por mês, permitindo a construção de gráficos transacionais. Para cada período são disponibilizados os valores totais de créditos e débitos registrados na conta, facilitando a visualização da evolução das movimentações financeiras ao longo do tempo.

[GET] /api/v1/account/monthlytransamount

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[RESPONSES]

Código	Descrição
200	Sucesso
500	Erro interno da aplicação

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
data	Lista de movimentações mensais	Array
data.[].ano	Ano da movimentação	Number
data.[].mes	Mês da movimentação	Number
data.[].debit	Valor total de débitos	Number
data.[].credit	Valor total de créditos	Number

{
    "success": true,
    "code": 200,
    "data": [
        {
            "ano": 2026,
            "mes": 6,
            "debit": 3.81,
            "credit": 8
        },
        {
            "ano": 2026,
            "mes": 5,
            "debit": 4.57,
            "credit": 5
        }
    ]
}

Propriedade	Descrição	Tipo
success	Status da operação	Boolean
code	Código do erro	Number
message	Mensagem de erro retornada	String

{
    "success": false,
    "code": 500,
    "message": "Um erro desconhecido ocorreu"
}

6.3 - Lista de extratos

Este endpoint retorna a lista de extratos e movimentações financeiras da conta do cliente autenticado. É possível utilizar filtros para refinar a consulta por período, tipo de transação, ordenação e texto de pesquisa. A resposta contém informações detalhadas de cada movimentação, incluindo valores, saldos antes e após a transação, dados de origem e destino, comprovantes, identificadores da operação e informações complementares relacionadas ao tipo de transação realizada.

[GET] /api/v1/statements

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
startDate (QueryParam)	Data inicial	Não	String
endDate (QueryParam)	Data final	Não	String
limit (QueryParam)	Limite	Não	String
type_transaction (QueryParam)	Tipo de transação	Não	String
direction (QueryParam)	Direção (‘asc’, ‘desc’)	Não	String
searchtext (QueryParam)	Pesquisa	Não	String

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
id_statement	ID do extrato	String
description	Descrição da transação	String
description_customer	Descrição exibida ao cliente	String
day_transaction	Dia da transação	String
datetime	Data e hora da transação	String
credit_flag	Indicador de crédito (1) ou débito (0)	Number
amount	Valor da transação	Number
amount_before	Saldo anterior	Number
amount_after	Saldo posterior	Number
type_transaction	Tipo da transação	String
proof_url	URL do comprovante	String
type_operation	Código da operação	Number
target_name	Nome do favorecido	String
target_cpf	CPF do favorecido	String
target_cnpj	CNPJ do favorecido	String
target_agency	Agência do favorecido	String
target_bank	Banco do favorecido	String
target_digit	Dígito da conta do favorecido	String
target_type_account	Tipo de conta do favorecido	String
target_baccount	Número da conta do favorecido	String
origin_name	Nome do pagador/remetente	String
origin_cpf	CPF do pagador/remetente	String
origin_cnpj	CNPJ do pagador/remetente	String
origin_agency	Agência do pagador/remetente	String
origin_bank	Banco do pagador/remetente	String
origin_baccount	Número da conta do pagador/remetente	String
origin_digit	Dígito da conta do pagador/remetente	String
digitable_line	Linha digitável	String
barcode	Código de barras	String
status	Status da transação	Number
endtoend	Identificador EndToEnd da transação Pix	String
psp	Prestador de Serviço de Pagamento (PSP)	String
psi	Sistema de liquidação utilizado	String
recharge_statecode	Código do estado da recarga	String
recharge_target	Destino da recarga	String
recharge_str_success	Mensagem de sucesso da recarga	String
multa	Valor da multa	Number
desconto	Valor do desconto	Number
abatimento	Valor do abatimento	Number
juros	Valor dos juros	Number
due_date	Data de vencimento	String
final_recipient_name	Nome do destinatário final	String
final_recipient_cpf	CPF do destinatário final	String
final_recipient_cnpj	CNPJ do destinatário final	String
infracao	Indicador de infração	Boolean
motivo_infracao	Motivo da infração	String
schedule	Indica se a transação foi agendada	Boolean
scheduled_to	Data agendada para execução	String
reference_id	Identificador de referência	String
microtime	Data e hora com precisão de microssegundos	String

{
    "success": "true",
    "code": "200",
    "message": "",
    "current_page": 1,
    "total_pages": 10,
    "per_page": 3,
    "statements": [
        [
            {
                "id_statement": "8f72b4c9-5f1a-4e8b-9a37-2d4f7a9b6c11",
                "description": "Transferência Pix Recebida",
                "description_customer": "Recebimento Pix",
                "day_transaction": "15",
                "datetime": "2026-06-15 14:32:45",
                "credit_flag": 1,
                "amount": 150.75,
                "amount_before": 849.25,
                "amount_after": 1000.00,
                "type_transaction": "Pix",
                "proof_url": "https://exemplo.com/comprovante/8f72b4c9.pdf",
                "type_operation": 65537,
                "target_name": "João Silva Santos",
                "target_cpf": "123.***.***-45",
                "target_cnpj": "",
                "target_agency": "0001",
                "target_bank": "Banco Exemplo",
                "target_digit": "8",
                "target_type_account": "Corrente",
                "target_baccount": "12345678",
                "origin_name": "Maria Fernanda Lima",
                "origin_cpf": "987.***.***-12",
                "origin_cnpj": "",
                "origin_agency": "0002",
                "origin_bank": "Banco Digital",
                "origin_baccount": "87654321",
                "origin_digit": "5",
                "digitable_line": null,
                "barcode": null,
                "status": 1,
                "endtoend": "E123456789202606151432450000000001",
                "psp": "Banco Digital",
                "psi": "SPI",
                "recharge_statecode": null,
                "recharge_target": null,
                "recharge_str_success": null,
                "multa": 0,
                "desconto": 0,
                "abatimento": 0,
                "juros": 0,
                "due_date": null,
                "final_recipient_name": "João Silva Santos",
                "final_recipient_cpf": "123.***.***-45",
                "final_recipient_cnpj": null,
                "infracao": false,
                "motivo_infracao": "",
                "schedule": false,
                "scheduled_to": null,
                "reference_id": "REF-20260615-001",
                "microtime": "2026-06-15 14:32:45.987654"
            }
        ]
    ]
}

6.4 - Consultar transação

Este endpoint permite consultar os detalhes de uma transação específica a partir do seu identificador único. A resposta retorna todas as informações relacionadas à movimentação financeira, incluindo valores, saldos antes e após a operação, dados de origem e destino, comprovantes, identificadores da transação, status e demais informações complementares de acordo com o tipo de operação realizada.

[GET] /api/v1/statements/:id

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
id (PathParam)	id da transação	Sim	String

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na consulta	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String
statement	Dados da transação	Object
statement.id_statement	ID da transação	String
statement.description	Descrição da transação	String
statement.description_customer	Descrição exibida ao cliente	String
statement.day_transaction	Dia da transação	String
statement.datetime	Data e hora da transação	String
statement.credit_flag	Indicador de crédito (1) ou débito (0)	Number
statement.amount	Valor da transação	Number
statement.amount_before	Saldo anterior	Number
statement.amount_after	Saldo posterior	Number
statement.type_transaction	Tipo da transação	String
statement.proof_url	URL do comprovante	String
statement.type_operation	Código da operação	Number
statement.target_name	Nome do favorecido	String
statement.target_cpf	CPF do favorecido	String
statement.target_cnpj	CNPJ do favorecido	String
statement.target_agency	Agência do favorecido	String
statement.target_bank	Banco do favorecido	String
statement.target_digit	Dígito da conta do favorecido	String
statement.target_type_account	Tipo de conta do favorecido	String
statement.target_baccount	Número da conta do favorecido	String
statement.origin_name	Nome do remetente	String
statement.origin_cpf	CPF do remetente	String
statement.origin_cnpj	CNPJ do remetente	String
statement.origin_agency	Agência do remetente	String
statement.origin_bank	Banco do remetente	String
statement.origin_baccount	Número da conta do remetente	String
statement.origin_digit	Dígito da conta do remetente	String
statement.digitable_line	Linha digitável	String
statement.barcode	Código de barras	String
statement.status	Status da transação	Number
statement.endtoend	Identificador EndToEnd	String
statement.psp	Prestador de Serviço de Pagamento (PSP)	String
statement.psi	Sistema de liquidação utilizado	String
statement.recharge_statecode	Código do estado da recarga	String
statement.recharge_target	Destino da recarga	String
statement.recharge_str_success	Mensagem de sucesso da recarga	String
statement.multa	Valor da multa	Number
statement.desconto	Valor do desconto	Number
statement.abatimento	Valor do abatimento	Number
statement.juros	Valor dos juros	Number
statement.due_date	Data de vencimento	String
statement.final_recipient_name	Nome do destinatário final	String
statement.final_recipient_cpf	CPF do destinatário final	String
statement.final_recipient_cnpj	CNPJ do destinatário final	String
statement.infracao	Indicador de infração	Boolean
statement.motivo_infracao	Motivo da infração	String
statement.schedule	Indica se a transação foi agendada	Boolean
statement.scheduled_to	Data agendada para execução	String
statement.reference_id	Identificador de referência	String
statement.microtime	Data e hora com microssegundos	String

{
    "success": true,
    "code": 200,
    "message": "Transação consultada",
    "statement": {
        "id_statement": "7c4f8d91-3b2a-4f76-a9d4-12c8b8d6e521",
        "description": "Pagamento Pix",
        "description_customer": "Pagamento de fornecedor",
        "day_transaction": "10",
        "datetime": "2026-06-10 14:25:18",
        "credit_flag": 0,
        "amount": 250.75,
        "amount_before": 1850.90,
        "amount_after": 1600.15,
        "type_transaction": "Pix",
        "proof_url": "https://exemplo.com/comprovantes/7c4f8d91.pdf",
        "type_operation": 65539,
        "target_name": "João da Silva",
        "target_cpf": "123.***.***-45",
        "target_cnpj": "",
        "target_agency": "0001",
        "target_bank": "Banco Exemplo S.A.",
        "target_digit": "8",
        "target_type_account": "Corrente",
        "target_baccount": "12345678",
        "origin_name": "Empresa Exemplo LTDA",
        "origin_cpf": "",
        "origin_cnpj": "12.***.***/0001-99",
        "origin_agency": "0001",
        "origin_bank": "Banco Digital S.A.",
        "origin_baccount": "87654321",
        "origin_digit": "5",
        "digitable_line": null,
        "barcode": null,
        "status": 1,
        "endtoend": "E1234567820260610142518ABCDEFG123",
        "psp": "Banco Digital S.A.",
        "psi": "SPI",
        "recharge_statecode": null,
        "recharge_target": null,
        "recharge_str_success": null,
        "multa": 0,
        "desconto": 0,
        "abatimento": 0,
        "juros": 0,
        "due_date": null,
        "final_recipient_name": "João da Silva",
        "final_recipient_cpf": "123.***.***-45",
        "final_recipient_cnpj": null,
        "infracao": false,
        "motivo_infracao": "",
        "schedule": false,
        "scheduled_to": null,
        "reference_id": "REF-20260610-001",
        "microtime": "2026-06-10 14:25:18.123456"
    }
}

6.5 - Exportar extrato bancário

Este endpoint permite exportar o extrato bancário da conta do cliente em um arquivo para download. A consulta pode ser filtrada por período através das datas inicial e final, e o formato de exportação deve ser informado, sendo suportados os formatos PDF e Excel. Em caso de sucesso, a resposta retorna a URL do arquivo gerado para acesso e download.

[GET] /api/v1/transactions/exports

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
startDate (QueryParam)	Data inicial	Não	String
endDate (QueryParam)	Data final	Não	String
typeExport (QueryParam)	Tipo de exportação (pdf, excel)	Sim	String

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
message	Mensagem da operação	String
code	Código de sucesso	Number
data	Dados retornados	String

{
    "success": "true",
    "message": "Arquivo exportado com sucesso: a8deb7afd8f3d1a8d4fe6a8618d04787.pdf",
    "code": "200",
    "data": "https://testeserver.com/storage/docs-export/09ed27ea-f1d2-4176-bbc4-e60b40cb1e1f/a8deb7afd8f3d1a8d4fe6a8618d04787.pdf"
}

6.6 - P2P

Este endpoint permite realizar uma transferência P2P entre contas da plataforma. Para efetuar a operação, é necessário informar o valor da transferência, o documento do destinatário e, opcionalmente, uma descrição para identificação da transação. Em caso de sucesso, será retornado o identificador único da transação gerada.

⚠️ É necessário realizar a confirmação de token antes de realizar o p2p: 3 - Autenticação de dois fatores pelo endpoint 3.3

[POST] /api/v1/transactions/p2p

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Obrigatório	Tipo
amount	Valor da operação	Sim	Number
target_document	Ex: 12345678910	Sim	String
description	Descrição	Sim	String

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Sucesso na operação	Boolean
code	Código de sucesso	Number
message	Mensagem da operação	String
id_transaction	ID da transação gerada	String

{
    "success": "true",
    "code": "200",
    "message": "Transações efetivada",
    "id_transaction": "ed50474b-f8ff-4d53-85e0-acc352be8445"
}

6.7 - Consultar taxas de transações

Este endpoint permite consultar as taxas aplicáveis a diferentes tipos de transações com base no valor informado. A partir do montante enviado, o sistema calcula e retorna as taxas correspondentes para cada tipo de operação disponível.

[POST] /api/v1/transactions/ratefromamount

[HEADER]

Propriedade	Descrição	Obrigatório	Tipo
Authorization	Bearer {Token Customer}	Sim	Bearer

[PAYLOAD]

Propriedade	Descrição	Tipo
amount	Valor da operação. Ex: 16	String

[RESPONSES]

Código	Descrição
200	Sucesso

Propriedade	Descrição	Tipo
success	Indica sucesso da operação	Boolean
code	Código HTTP da resposta	Number
message	Mensagem da operação	String
rates	Lista de taxas configuradas	Array
rates[].identifier	Identificador do tipo de operação	String
rates[].rate_amount	Valor da taxa aplicada	Number

{
    "success": true,
    "code": 200,
    "message": "Taxas consultadas",
    "rates": [
        {
            "identifier": "boleto",
            "rate_amount": 2.47
        },
        {
            "identifier": "pix_cobranca",
            "rate_amount": 0
        },
        {
            "identifier": "p2p",
            "rate_amount": 0
        },
        {
            "identifier": "pagamento_conta",
            "rate_amount": 0
        }
    ]
}