Descadastrar CPF
Endpoint para realizar o opt-out do CPF.
info
O opt-out é realizado por CPF e id_emissora. Informando apenas o CPF o opt-out é realizado para todas as emissoras vinculadas ao cliente.
Interface
| Método HTTP | Endpoint |
|---|---|
PATCH | https://api.ez-pay.app/v1/unregister |
Parâmetros de entrada
| Header |
|---|
| Bearer token |
| Query Params | |
|---|---|
| Parâmetro | Tipo |
| cpf | STRING(11) CPF do cliente que deseja descadastrar o recebimento de documentos |
| id_banco | INT Identificação do banco de origem do opt-out |
| id_emissora | STRING(36) ID da empresa emissora do documento (opcional) |
| Exemplo | |
|---|---|
| Key | Value |
| id_emissora | emissoraaemissoraaemissoraaemissoraa |
| cpf | 40732223091 |
Response
{
"message": "Requisição processada com sucesso",
"trackid": "12d270b2-64cd-4a89-859a-ab20f6aafbfd"
}
Mensagens
| Código HTTP | Mensagem |
|---|---|
| 200 | CPF descadastrado com sucesso |
| 204 | CPF não possui opt-in |
| 204 | Emissora inexistente |
| 400 | Parâmetros inválidos |
| 400 | CPF inválido |
| 400 | Id do Banco inválido |
| 401 | Credential unexpected |
| 500 | Erro ao processar a requisição |