Métodos
Os métodos consumidos pela aplicação móvel estão listados por fluxo e tela segundo as tabelas abaixo:
Account
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| FindAccountDashboard | Busca as informações iniciais de conta para a tela inicial do aplicativo | Tela inicial | POST |
| FindAccountListByLogin | Busca uma lista de contas pelo login informado | N/A | POST |
| FindAccountBalance | Busca o saldo de uma conta | N/A | POST |
| FindBankStatement | Busca o extrato da conta | Tela inicial > Extrato | POST |
| FindBankStatementDetails | Busca os detalhes de uma transação no extrato | Tela inicial > Extrato > Detalhes | POST |
| FindBankStatementMonthlySummary | Busca os valores de entradas e saídas do mês | N/A | POST |
| FindAccountListByTaxId | Busca uma lista de contas com o CPF/CNPJ informado | Transferência > Transferir para conta bancária | POST |
| FixingChange | Altera o estado de favorito de uma conta | Tela inicial > Configurações > Ver Todas | POST |
| FindAccountByPhoneNumber | Busca uma lista de contas de acordo com número de telefone informado | Transferência > Transferir dinheiro pelo celular | POST |
| FindAccountOperationLimitList | Busca uma lista de limites de operações cadastradas para a operação informada | PIX > Meus limites PIX | POST |
| ChangeAccountOperationLimit | Cria uma solicitação para mudança de limite para a operação especificada | PIX > Meus limites PIX > Editar Limite | POST |
| FindAccountOperationLimit | Busca o limite cadastrado para a operação informada | N/A | POST |
| FindAccountOperation | Busca o identificador externo de uma operação | N/A | POST |
| FindRateByOperationType | Busca o valor de uma taxa cadastrada para a operação informada | Tela "Conferir Dados" de operações financeiras | POST |
Address
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| FindAddressByZipCode | Busca as informações de endereço baseado no CEP informado | Configurações > Informações Pessoais > Endereço > Editar | POST |
Auth
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| Login | Realiza o login gerando o Token de sessão | Login | POST |
| GET | Cria o Token de aplicação utilizado em toda requisição | N/A | GET |
| GetTime | Busca o horário atual do servidor | N/A | GET |
| SendUserInformation | Compartilha informações do usuário para que seja gerado um Token para autenticação externa | Empréstimo | POST |
AuthorizationToken
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| POST | Cria um Token de autorização para validação de operações | Componente para geração de Token | POST |
| ValidateAuthorizationToken | Valida um Token inserido para a conta informada | Telas de Operações financeiras | POST |
| GenerateUnauthenticatedAuthorizationToken | Cria um Token de autorização para fluxos anteriores ao login | Recuperação de senha | POST |
| ValidateUnauthenticatedAuthorizationToken | Valida um Token inserido para fluxos anteriores ao login | Recuperação de senha | POST |
Bank
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| FindBanks | Busca a lista de bancos possíveis para uma transferência bancária | Transferência > Transferir para conta bancária | POST |
BoletoPayment
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| POST | Cria uma requisição de operação para pagamento de boleto bancário ou concessionária | Pagamento > Tela "Conferir Dados" | POST |
| FindBoletoInfo | Busca as informações de um boleto com base no barcode ou linha digitável informada | Pagamento | POST |
| FindExpectedBoletoPaymentDate | Busca a próxima data útil válida para um pagamento de boleto | Pagamento | POST |
| FindScanLicenseKey | Busca a chave de licença para utilização da biblioteca de leitura de código de barras | Pagamento | GET |
Card
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| VerifyCard | Valida se os dados informados estão de acordo com os dados cadastrados para o identificador do cartão informado | Cartão > Associar cartão | POST |
| FindCard | Busca as informações de um cartão a partir do identificador informado | Cartão > Selecionar cartão | POST |
| FindCardList | Busca a lista de cartões associados a conta | Cartão | POST |
| Activate | Cria uma requisição de ativação de cartão | Cartão > Selecionar cartão | POST |
| Block | Cria uma requisição para bloqueio temporário de um cartão | Cartão > Bloqueio temporário | POST |
| Unblock | Cria uma requisição para desbloqueio temporário de um cartão | Cartão > Bloqueio temporário | POST |
| ChangePinCard | Cria uma requisição para alteração da senha de um cartão | Cartão > Alterar senha | POST |
| BindUnnamedCard | Cria uma requisição para vinculação de um cartão não-nominal | Cartão > Associar cartão | POST |
| InactivateAndReissue | Cria uma requisição para inativar um cartão e solicitar segunda via | Cartão > Cancelar e 2ª via > Cancelar e solicitar 2ª via | POST |
| CancelCard | Cria uma requisição para cancelamento de um cartão | Cartão > Cancelar e 2ª via > Cancelar cartão | POST |
| UpdateCardContactless | Cria uma requisição de ativação/desativação da funcionalidade de aproximação para um cartão | Cartão > Desativar contactless | POST |
Device
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| POST | Registra um Token único para identificação do dispositivo para utilização no envio de notificações do tipo PUSH | Tela inicial | POST |
DigitalWithdrawal
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| CreateDigitalWithdrawal | Cria uma requisição de operação para Saque Digital | Saque digital | POST |
| FindInfosByTokenDigitalWithdrawal | Busca informações associadas ao Token do QR Code lido | Saque igital > Ler QR Code | POST |
| AuthorizeDigitalWithdrawal | Autoriza a operação de saque digital | Saque digital > Ler QR Code | POST |
Favored
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| POST | Cria um registro de "Conta recente" para futuras transações | N/A | POST |
| FindFavoredListByAccountIdAndOperationType | Busca uma lista de "Contas recentes" para o tipo de operação informado | Telas de operações financeiras | POST |
FutureTransactions
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| FindFutureTransactionsList | Busca uma lista de operações a serem processadas de acordo com o tipo de operação informada (entrada/saída) | Agendamentos > Entradas/Saídas | POST |
| CancelFuturePayment | Cria uma requisição de cancelamento de uma operação agendada | Agendamentos > Entradas/Saídas | POST |
HashCode
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| GenerateHashCode | Cria uma requisição para geração de um QRCode com valor para recebimento de uma Transferência interna | QR Code > Receber de uma conta FitBank | POST |
| ReadHashCode | Busca as informações bancárias contidas em um HashCode gerado pelo método GenerateHashCode | QR Code > Transferir para contas FitBank | POST |
HealthCheck
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| GET | Verifica a disponibilidade da API | N/A | GET |
InternalTransfer
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| POST | Cria uma requisição de operação para transferência interna | Transferência > Transferir para conta bancária | POST |
| PUT | Atualiza o status de uma operação de transferência interna | N/A | PUT |
| FindPendingInternalTransfer | Busca uma operação de transferência pendente por SMS para um número de telefone | N/A | POST |
| CreatePendingInternalTransfer | Cria uma transferência pendente para um número de telefone informado | N/A | POST |
LimitedAccount
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| POST | Cria uma requisição para geração de uma conta limitada | N/A | POST |
MoneyTransfer
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| POST | Cria uma requisição de operação para transferência bancária | Transferência > Transferir para conta bancária | POST |
| PUT | Atualiza o status de uma operação de transferência bancária | N/A | PUT |
| FindExpectedTransferDate | Busca a próxima data útil para uma transferência bancária | Transferência > Data para transferência | POST |
NewAccount
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| POST | Cria uma requisição para criação de uma conta bancária | N/A | POST |
Notification
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| FindNotificationByAccountId | Busca a lista de notificações enviadas a uma conta | Tela inicial > Notificações | POST |
Onboarding
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| CheckLiveness | Valida a autenticidade de um documento RG enviado | N/A | POST |
Pix:
| Método | Ação | Tela |
|---|---|---|
| CreatePixOut | Cria uma requisição de operação de uma transferência Pix | Pix > Transferir > Tela para conferir os dados |
| CancelPixOut | Cria uma requisição para cancelamento de um transação Pix agendada | Agendamentos > Saídas > Cancelar |
| CreatePixKey | Cria uma chave Pix | Pix > Minhas chaves PIX |
| ResendPixKeyToken | Reenvia um Token para confirmação de criação de chave Pix | Pix > Registrar Chave Pix |
| ConfirmPixKeyHold | Confirma Token para criação de chave | Pix > Registrar Chave Pix |
| CancelPixKey | Cancela chave Pix | Pix > Minhas chaves Pix |
| FindPixKeyList | Busca chaves Pix cadastradas para a conta | Pix > Minhas chaves Pix |
| FindInfosPixKey | Busca as informações de uma chave Pix para transferência | Pix > Transferir > Usar Chave Pix |
| CreateRefundPixIn | Cria uma requisição de operação para devolução Pix | Extrato > Detalhes (Transação PixIn) > Devolver > Tela para conferir os dados |
| CreateStaticPixQRCode | Cria uma requisição para geração de um QR Code estático para transação Pix | Pix > Cobrar e Receber |
| FindPixQrCode | Busca as informações de um QR Code gerado para iniciar uma transação Pix | Pix > Cobrar e Receber |
| FindInfoPixQRCode | Busca as informações bancárias registradas em um QR Code Pix para transação | Pix > Transferir por QR Code |
| FindExternalPixKeyClaim | Busca quaisquer requisição de reinvindicação de chave Pix | Tela inicial |
| ReplyExternalPixKeyClaim | Responde a uma reinvindicação de chave Pix | Tela inicial |
| CheckPixInWasRefunded | Verifica se uma devolução Pix já foi realizada para a mesma transação de recebimento Pix | Extrato > Detalhes (Transação PixIn) > Devolver |
Tag
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| FindSuggestionTagList | Busca uma lista de de TAGs sugeridas para uma operação | N/A | POST |
TaxPayment
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| CreateFGTSPayment | Cria uma requisição de operação para pagamento de um FGTS | Pagamentos > Outros pagamentos > FGTS | POST |
| CreateDARJPayment | Cria uma requisição de operação para pagamento de um DARJ | Pagamentos > Outros pagamentos > DARJ | POST |
| CreateGAREPayment | Cria uma requisição de operação para pagamento de um GARE | Pagamentos > Outros pagamentos > GARE | POST |
TopUp
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| POST | Cria uma requisição de operação para recarga de um celular | Recarga | POST |
| FindTopUpProductList | Busca uma lista de todos os produtos disponíveis para uma recarga | N/A | POST |
| FindTopUpProductListByPhoneNumber | Busca uma lista de todos os produtos disponíveis para uma recarga para um número de telefone informado | Recarga > Recarregar celular | POST |
| FindTopUpPeriodicList | Busca uma lista de recargas automáticas cadastradas | Recarga | POST |
| CancelTopUpPeriodic | Cancela uma recarga automática cadastrada | Recarga > Recargas automáticas | POST |
User
| Método | Ação | Tela | Tipo |
|---|---|---|---|
| CreateUserInformation | Cria informações cadastrais para um usuário | N/A | POST |
| FindUserInformation | Busca as informações cadastrais de um usuário | N/A | POST |
| UpdateUserInformation | Atualiza as informações cadastrais de um usuário | Configurações > Informações pessoais > Endereço > Editar | POST |
| ResetPassword | Reseta a senha de um usuário de acordo com o CPF informado | Esqueci minha senha > Recuperar senha | POST |
| ChangePassword | Atualiza a senha de um usuário | Primeiro acesso | POST |
| UpdateUserTerms | Atualiza o registro de "Aceite os termos de uso" | Termos de uso | POST |
Updated over 2 years ago
