Registrar endosso de CPR Ag de um cliente

Registra o endosso da CPR informada em cprId, do cliente informado em clientId, para o novo credor identificado pelo CPF ou CNPJ em cpfCnpjNewCreditor, com o documento do endosso em urlDocument. taxId é o CPF ou CNPJ do cliente, gravado na solicitação. O status da CPR passa para processando-endosso, e o pedido de registro e o de envio de e-mail são enviados para processamento: a resposta 201 indica que o endosso foi solicitado, não que já está registrado. O CPF ou CNPJ do novo credor precisa ser válido e pode vir com ou sem máscara. Todos os campos são obrigatórios. CPR inexistente devolve 404; conflito momentâneo de gravação devolve 503, e vale tentar de novo após 10 segundos. Requer autenticação via Bearer JWT ou header x-api-key. O cliente precisa pertencer à empresa do usuário: cliente inexistente devolve 404 (Cliente não encontrado), cliente de outra empresa devolve 401 (Acesso negado) e usuário inativo devolve 404 (Usuário não encontrado).

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Respostas

🟢201

application/json

Endosso solicitado

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400CPF/CNPJ do novo credor inválido

🟠404CPR não encontrada

🟠422Dados do endosso inválidos

🔴500Produto indisponível ou erro interno

🔴503Tente novamente

curl --location '/v2/cpr-ag/endorsement/7c9e6679-7425-40de-944b-e07fc1f90ae7' \ --header 'x-api-key: SUA_CHAVE_DE_API' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "cpfCnpjNewCreditor": "11444777000161", "cprId": "3f2b8c1e-0000-4000-8000-00000000c001", "urlDocument": "https://files.example.com/cpr/endosso-0001.pdf", "taxId": "11222333000181" }'

Registrar endosso de CPR Ag de um cliente

Requisição

Respostas