Contas, Pix, boletos e transferencias
Accounts
Conjunto principal para abertura de contas, consulta de saldo e extrato, Pix, boletos, TED, TEF, CNAB e webhooks operacionais.
Abertura de conta com envio separado de documentos
Pix completo com chaves, QR Code, cash-out e devolucao
Boletos, transferencias, CNAB e comprovantes
Regras deste provedor
- O certificado define se a chamada acessa sandbox ou producao. Use certificado do mesmo ambiente da operacao.
- Quando a operacao usa uma conta especifica, envie o header x-account-id com o identificador interno da conta.
- Na abertura de conta individual, envie a conta primeiro e depois envie os documentos. A selfie deve ser enviada antes dos demais documentos.
- O campo gender aceita M ou F na API. O valor e normalizado para o formato exigido na liquidacao.
- O campo assertedIncome e obrigatorio na abertura de conta individual.
Contas
POSTCriar conta individual/hb/accounts/individualGETListar contas individuais/hb/accounts/individualsGETConsultar conta individual/hb/accounts/individualx-account-idPOSTEnviar documento da conta/hb/accounts/individual/documentPOSTCriar conta empresarial/hb/accounts/businessGETConsultar saldo/hb/accounts/balancex-account-idGETConsultar extrato/hb/accounts/statementx-account-idGETBaixar extrato em PDF/hb/accounts/statement/pdfx-account-idGETConsultar lancamentos/hb/accounts/movementsx-account-idGETConsultar comprovantes/hb/accounts/receiptsx-account-idGETConsultar lancamentos futuros/hb/accounts/future-transactionsx-account-idPOSTSolicitar encerramento de conta/hb/accounts/closure-requestsx-account-idGETConsultar status do encerramento/hb/accounts/closure-requests/:request_idDELETECancelar lancamento futuro/hb/accounts/future-release/:scheduling_codex-account-id
Pix
GETConsultar chave Pix/hb/pix/dictPOSTCriar chave Pix/hb/pix/keysx-account-idGETListar chaves Pix/hb/pix/keysx-account-idDELETEExcluir chave Pix/hb/pix/keys/:keyx-account-idPOSTEnviar MFA/hb/pix/mfax-account-idPOSTCriar QR Code estatico/hb/pix/qrcodes/staticx-account-idPOSTCriar QR Code dinamico/hb/pix/qrcodes/dynamicx-account-idPOSTCriar QR Code com vencimento/hb/pix/qrcodes/billingx-account-idGETConsultar QR Codes/hb/pix/qrcodesx-account-idPOSTEnviar Pix/hb/pix/transactionsx-account-idGETConsultar status do Pix/hb/pix/transactions/:transaction_id/statusPOSTSolicitar devolucao Pix/hb/pix/refundsx-account-id
Boletos
POSTCriar boleto/hb/bank-slips/registrationsx-account-idGETListar boletos/hb/bank-slips/registrationsx-account-idGETConsultar boleto/hb/bank-slips/registrations/:idGETBaixar boleto em PDF/hb/bank-slips/registrations/:id/pdfDELETECancelar boleto/hb/bank-slips/registrations/:idPOSTValidar pagamento de boleto/hb/bank-slips/payments/validatex-account-idPOSTConfirmar pagamento de boleto/hb/bank-slips/payments/confirmx-account-idPOSTCriar emissor de boleto/hb/bank-slips/issuerx-account-idGETConsultar emissores de boleto/hb/bank-slips/issuerPOSTCriar carteira de boleto/hb/bank-slips/portfoliosx-account-id
Transferencias
CNAB
POSTEnviar arquivo CNAB 400/hb/cnab/400/filesPOSTEnviar arquivo CNAB 240/hb/cnab/240/filesGETListar arquivos CNAB 400/hb/cnab/400/filesGETBaixar arquivo CNAB 400/hb/cnab/400/files/downloadGETListar arquivos CNAB 240/hb/cnab/240/filesGETBaixar arquivo CNAB 240/hb/cnab/240/files/downloadGETConsultar logs CNAB 240/hb/cnab/240/files/logs
Titulares
Cartoes
POSTCriar cartao/hb/cards/createx-account-idGETListar cartoes/hb/cards/listx-account-idPOSTBloquear cartao/hb/cards/:cardProxy/freezePOSTDesbloquear cartao/hb/cards/:cardProxy/unfreezeGETConsultar dados do cartao/hb/cards/:cardProxy/dataGETConsultar dados de seguranca/hb/cards/:cardProxy/security-dataPATCHAtivar cartao/hb/cards/:cardProxy/activateGETConsultar rastreio do cartao/hb/cards/:cardProxy/trackingPATCHAtualizar senha do cartao/hb/cards/:cardProxy/passwordPOSTSolicitar segunda via/hb/cards/:cardProxy/second
Multiacesso
POSTVincular conta/hb/multi-access/accounts/:id/link-accountGETListar acessos/hb/multi-access/accountsGETConsultar acesso/hb/multi-access/accounts/:idPATCHAtualizar acesso/hb/multi-access/accounts/:idDELETERemover acesso/hb/multi-access/accounts/:idPOSTBloquear acesso/hb/multi-access/accounts/:id/blockPOSTSolicitar OTP/hb/multi-access/otp/requestPOSTValidar OTP/hb/multi-access/otp/validate