1. Endpoint #
PUT https://hmlapi2.bancosemear.com.br/caas-api-status/v1/public/proposals/:contractId/bank-data
2. Descrição #
API destinada à reapresentação de pagamentos com erro ou divergência, permitindo uma nova tentativa de processamento de forma controlada, segura e rastreável, vinculada ao pagamento original. O cliente receberá um webhook (worker_credit.disbursement) informando que houve divergências de dados bancários no pagamento, ou poderá consultar a API de Status. Após isso, ele poderá realizar a reapresentação do pagamento, corrigindo os dados. Caso os dados não sejam corrigidos no período de 3 dias, a proposta será cancelada automaticamente e desaverbada na Dataprev.
3. Headers #
| Key | Valor (apenas exemplo) | Descrição |
| client_id | 00000000-0000-0000-0000-000000000000 | Identificador único do cliente/aplicação consumidora da API |
| access_token | 00000000-0000-0000-0000-000000000000 | Token de acesso Bearer/JWT com escopo de autorização |
| Content-Type | application/json | Formato do corpo da requisição |
4. Request Body #
{
"bankId": "001",
"accountType": "checking",
"agency": "1234",
"agencyDigit": "5",
"account": "123456",
"accountDigit": "7"
}
Obs.: Deve-se preencher o parametro contractId na rota:
Ex.: /caas-api-status/v1/public/proposals/c0aae62c-1ae3-4fcf-bca2-a225c14d292c/bank-data
4.1. Tabela de campos
| Campo | Tipo | Obrigatório* | Regras | Descrição |
|---|---|---|---|---|
bankId | string | Sim | Somente números | Código Bancário |
accountType | string | Sim | — | Tipo de conta: checking = conta corrente savings = conta poupança |
agency | string | Sim | Somente números | Número da agência |
agencyDigit | string | Não | — | Número do dígito da agência |
| account | string | Sim | Somente números | Número da conta |
| accountDigit | string | Não | — | Número do dígito da conta |
5. Respostas esperadas #
5.1. 200 — Sucesso
Retornado quando os dados bancários são atualizados e o pagamento é reprocessado automaticamente em seguida.
"Enviando correção de dados bancários para a esteira de pagamento."
5.2. (400) — Requisição inválida
Retornado quando ocorre algum erro ao buscar os dados de pagamento do cliente.
Falha ao atualizar dados bancários na esteira de pagamento.
5.3. 500 — Erro inesperado
"Falha de comunicação com a esteira de pagamento."