Home

Os métodos consumidos pela aplicação móvel estão listados por fluxo e tela segundo as tabelas abaixo:

Account

MétodoAçãoTelaTipo
FindAccountDashboardBusca as informações iniciais de conta para a tela inicial do aplicativoTela inicialPOST
FindAccountListByLoginBusca uma lista de contas pelo login informadoN/APOST
FindAccountBalanceBusca o saldo de uma contaN/APOST
FindBankStatementBusca o extrato da contaTela inicial > ExtratoPOST
FindBankStatementDetailsBusca os detalhes de uma transação no extratoTela inicial > Extrato > DetalhesPOST
FindBankStatementMonthlySummaryBusca os valores de entradas e saídas do mêsN/APOST
FindAccountListByTaxIdBusca uma lista de contas com o CPF/CNPJ informadoTransferência > Transferir para conta bancáriaPOST
FixingChangeAltera o estado de favorito de uma contaTela inicial > Configurações > Ver TodasPOST
FindAccountByPhoneNumberBusca uma lista de contas de acordo com número de telefone informadoTransferência > Transferir dinheiro pelo celularPOST
FindAccountOperationLimitListBusca uma lista de limites de operações cadastradas para a operação informadaPIX > Meus limites PIXPOST
ChangeAccountOperationLimitCria uma solicitação para mudança de limite para a operação especificadaPIX > Meus limites PIX > Editar LimitePOST
FindAccountOperationLimitBusca o limite cadastrado para a operação informadaN/APOST
FindAccountOperationBusca o identificador externo de uma operaçãoN/APOST
FindRateByOperationTypeBusca o valor de uma taxa cadastrada para a operação informadaTela "Conferir Dados" de operações financeirasPOST

Address

MétodoAçãoTelaTipo
FindAddressByZipCodeBusca as informações de endereço baseado no CEP informadoConfigurações > Informações Pessoais > Endereço > EditarPOST

Auth

MétodoAçãoTelaTipo
LoginRealiza o login gerando o Token de sessãoLoginPOST
GETCria o Token de aplicação utilizado em toda requisiçãoN/AGET
GetTimeBusca o horário atual do servidorN/AGET
SendUserInformationCompartilha informações do usuário para que seja gerado um Token para autenticação externaEmpréstimoPOST

AuthorizationToken

MétodoAçãoTelaTipo
POSTCria um Token de autorização para validação de operaçõesComponente para geração de TokenPOST
ValidateAuthorizationTokenValida um Token inserido para a conta informadaTelas de Operações financeirasPOST
GenerateUnauthenticatedAuthorizationTokenCria um Token de autorização para fluxos anteriores ao loginRecuperação de senhaPOST
ValidateUnauthenticatedAuthorizationTokenValida um Token inserido para fluxos anteriores ao loginRecuperação de senhaPOST

Bank

MétodoAçãoTelaTipo
FindBanksBusca a lista de bancos possíveis para uma transferência bancáriaTransferência > Transferir para conta bancáriaPOST

BoletoPayment

MétodoAçãoTelaTipo
POSTCria uma requisição de operação para pagamento de boleto bancário ou concessionáriaPagamento > Tela "Conferir Dados"POST
FindBoletoInfoBusca as informações de um boleto com base no barcode ou linha digitável informadaPagamentoPOST
FindExpectedBoletoPaymentDateBusca a próxima data útil válida para um pagamento de boletoPagamentoPOST
FindScanLicenseKeyBusca a chave de licença para utilização da biblioteca de leitura de código de barrasPagamentoGET

Card

MétodoAçãoTelaTipo
VerifyCardValida se os dados informados estão de acordo com os dados cadastrados para o identificador do cartão informadoCartão > Associar cartãoPOST
FindCardBusca as informações de um cartão a partir do identificador informadoCartão > Selecionar cartãoPOST
FindCardListBusca a lista de cartões associados a contaCartãoPOST
ActivateCria uma requisição de ativação de cartãoCartão > Selecionar cartãoPOST
BlockCria uma requisição para bloqueio temporário de um cartãoCartão > Bloqueio temporárioPOST
UnblockCria uma requisição para desbloqueio temporário de um cartãoCartão > Bloqueio temporárioPOST
ChangePinCardCria uma requisição para alteração da senha de um cartãoCartão > Alterar senhaPOST
BindUnnamedCardCria uma requisição para vinculação de um cartão não-nominalCartão > Associar cartãoPOST
InactivateAndReissueCria uma requisição para inativar um cartão e solicitar segunda viaCartão > Cancelar e 2ª via > Cancelar e solicitar 2ª viaPOST
CancelCardCria uma requisição para cancelamento de um cartãoCartão > Cancelar e 2ª via > Cancelar cartãoPOST
UpdateCardContactlessCria uma requisição de ativação/desativação da funcionalidade de aproximação para um cartãoCartão > Desativar contactlessPOST

Device

MétodoAçãoTelaTipo
POSTRegistra um Token único para identificação do dispositivo para utilização no envio de notificações do tipo PUSHTela inicialPOST

DigitalWithdrawal

MétodoAçãoTelaTipo
CreateDigitalWithdrawalCria uma requisição de operação para Saque DigitalSaque digitalPOST
FindInfosByTokenDigitalWithdrawalBusca informações associadas ao Token do QR Code lidoSaque igital > Ler QR CodePOST
AuthorizeDigitalWithdrawalAutoriza a operação de saque digitalSaque digital > Ler QR CodePOST

Favored

MétodoAçãoTelaTipo
POSTCria um registro de "Conta recente" para futuras transaçõesN/APOST
FindFavoredListByAccountIdAndOperationTypeBusca uma lista de "Contas recentes" para o tipo de operação informadoTelas de operações financeirasPOST

FutureTransactions

MétodoAçãoTelaTipo
FindFutureTransactionsListBusca uma lista de operações a serem processadas de acordo com o tipo de operação informada (entrada/saída)Agendamentos > Entradas/SaídasPOST
CancelFuturePaymentCria uma requisição de cancelamento de uma operação agendadaAgendamentos > Entradas/SaídasPOST

HashCode

MétodoAçãoTelaTipo
GenerateHashCodeCria uma requisição para geração de um QRCode com valor para recebimento de uma Transferência internaQR Code > Receber de uma conta FitBankPOST
ReadHashCodeBusca as informações bancárias contidas em um HashCode gerado pelo método GenerateHashCodeQR Code > Transferir para contas FitBankPOST

HealthCheck

MétodoAçãoTelaTipo
GETVerifica a disponibilidade da APIN/AGET

InternalTransfer

MétodoAçãoTelaTipo
POSTCria uma requisição de operação para transferência internaTransferência > Transferir para conta bancáriaPOST
PUTAtualiza o status de uma operação de transferência internaN/APUT
FindPendingInternalTransferBusca uma operação de transferência pendente por SMS para um número de telefoneN/APOST
CreatePendingInternalTransferCria uma transferência pendente para um número de telefone informadoN/APOST

LimitedAccount

MétodoAçãoTelaTipo
POSTCria uma requisição para geração de uma conta limitadaN/APOST

MoneyTransfer

MétodoAçãoTelaTipo
POSTCria uma requisição de operação para transferência bancáriaTransferência > Transferir para conta bancáriaPOST
PUTAtualiza o status de uma operação de transferência bancáriaN/APUT
FindExpectedTransferDateBusca a próxima data útil para uma transferência bancáriaTransferência > Data para transferênciaPOST

NewAccount

MétodoAçãoTelaTipo
POSTCria uma requisição para criação de uma conta bancáriaN/APOST

Notification

MétodoAçãoTelaTipo
FindNotificationByAccountIdBusca a lista de notificações enviadas a uma contaTela inicial > NotificaçõesPOST

Onboarding

MétodoAçãoTelaTipo
CheckLivenessValida a autenticidade de um documento RG enviadoN/APOST

Pix:

MétodoAçãoTela
CreatePixOutCria uma requisição de operação de uma transferência PixPix > Transferir > Tela para conferir os dados
CancelPixOutCria uma requisição para cancelamento de um transação Pix agendadaAgendamentos > Saídas > Cancelar
CreatePixKeyCria uma chave PixPix > Minhas chaves PIX
ResendPixKeyTokenReenvia um Token para confirmação de criação de chave PixPix > Registrar Chave Pix
ConfirmPixKeyHoldConfirma Token para criação de chavePix > Registrar Chave Pix
CancelPixKeyCancela chave PixPix > Minhas chaves Pix
FindPixKeyListBusca chaves Pix cadastradas para a contaPix > Minhas chaves Pix
FindInfosPixKeyBusca as informações de uma chave Pix para transferênciaPix > Transferir > Usar Chave Pix
CreateRefundPixInCria uma requisição de operação para devolução PixExtrato > Detalhes (Transação PixIn) > Devolver > Tela para conferir os dados
CreateStaticPixQRCodeCria uma requisição para geração de um QR Code estático para transação PixPix > Cobrar e Receber
FindPixQrCodeBusca as informações de um QR Code gerado para iniciar uma transação PixPix > Cobrar e Receber
FindInfoPixQRCodeBusca as informações bancárias registradas em um QR Code Pix para transaçãoPix > Transferir por QR Code
FindExternalPixKeyClaimBusca quaisquer requisição de reinvindicação de chave PixTela inicial
ReplyExternalPixKeyClaimResponde a uma reinvindicação de chave PixTela inicial
CheckPixInWasRefundedVerifica se uma devolução Pix já foi realizada para a mesma transação de recebimento PixExtrato > Detalhes (Transação PixIn) > Devolver

Tag

MétodoAçãoTelaTipo
FindSuggestionTagListBusca uma lista de de TAGs sugeridas para uma operaçãoN/APOST

TaxPayment

MétodoAçãoTelaTipo
CreateFGTSPaymentCria uma requisição de operação para pagamento de um FGTSPagamentos > Outros pagamentos > FGTSPOST
CreateDARJPaymentCria uma requisição de operação para pagamento de um DARJPagamentos > Outros pagamentos > DARJPOST
CreateGAREPaymentCria uma requisição de operação para pagamento de um GAREPagamentos > Outros pagamentos > GAREPOST

TopUp

MétodoAçãoTelaTipo
POSTCria uma requisição de operação para recarga de um celularRecargaPOST
FindTopUpProductListBusca uma lista de todos os produtos disponíveis para uma recargaN/APOST
FindTopUpProductListByPhoneNumberBusca uma lista de todos os produtos disponíveis para uma recarga para um número de telefone informadoRecarga > Recarregar celularPOST
FindTopUpPeriodicListBusca uma lista de recargas automáticas cadastradasRecargaPOST
CancelTopUpPeriodicCancela uma recarga automática cadastradaRecarga > Recargas automáticasPOST

User

MétodoAçãoTelaTipo
CreateUserInformationCria informações cadastrais para um usuárioN/APOST
FindUserInformationBusca as informações cadastrais de um usuárioN/APOST
UpdateUserInformationAtualiza as informações cadastrais de um usuárioConfigurações > Informações pessoais > Endereço > EditarPOST
ResetPasswordReseta a senha de um usuário de acordo com o CPF informadoEsqueci minha senha > Recuperar senhaPOST
ChangePasswordAtualiza a senha de um usuárioPrimeiro acessoPOST
UpdateUserTermsAtualiza o registro de "Aceite os termos de uso"Termos de usoPOST