Cadastrar CPF
Cadastro do CPF que deseja receber documentos através do Ezpay Business.
info
Opt-in único para todas as concessionárias quando informado apenas o CPF, ou opt-in por concessionária quando informado também o id_emissora.
Interface
| Método HTTP | Endpoint |
|---|---|
POST | https://api.ez-pay.app/v1/register |
Parâmetros de entrada
| Header |
|---|
| Bearer token |
| Query Params | |
|---|---|
| Parâmetro | Tipo |
| cpf | STRING(11) CPF do cliente que deseja receber os documentos |
| id_banco | INT Identificação do banco de origem do optin |
| id_emissora | STRING(36) ID da empresa emissora do documento (opcional) |
| Exemplo | |
|---|---|
| Key | Value |
| cpf | 40732223091 |
| id_banco | 123 |
| id_emissora | 23fa7559-ac39-448d-ba23-6e301826015f |
Response
{
"message": "Requisição processada com sucesso",
"trackid": "ff5852ee-61d0-4d4f-b44a-028daeee06fb"
}
Mensagens
| Código HTTP | Mensagem |
|---|---|
| 201 | CPF cadastrado com sucesso |
| 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 |