Mudanças entre as edições de "API de atualização de boleto manual"
(Criou página com 'A API de atualização de boleto manual deve ser utilizada para enviar a imagem de um boleto e sua linha digitável gerados em um sistema de terceiros no Recuperador CRM. Este...') |
|||
(Uma revisão intermediária pelo mesmo usuário não está sendo mostrada) | |||
Linha 1: | Linha 1: | ||
− | A API de atualização de boleto manual deve ser utilizada para enviar a imagem de um boleto e sua linha digitável gerados em um sistema de terceiros | + | A API de atualização de boleto manual deve ser utilizada para enviar a imagem de um boleto e sua linha digitável gerados em um sistema de terceiros para o Recuperador CRM. Este recurso somente é válido para credores que utilizam o meio de pagamento Boleto Manual. |
Linha 6: | Linha 6: | ||
Ação: '''POST''' | Ação: '''POST''' | ||
− | Formato: ''' | + | Formato: '''FORM DATA''' |
Autenticação: enviar o '''token''' da API no campo '''username''' da autenticação '''Basic Auth'''. Deixe o campo password em branco. | Autenticação: enviar o '''token''' da API no campo '''username''' da autenticação '''Basic Auth'''. Deixe o campo password em branco. |
Edição atual tal como às 18h26min de 6 de dezembro de 2022
A API de atualização de boleto manual deve ser utilizada para enviar a imagem de um boleto e sua linha digitável gerados em um sistema de terceiros para o Recuperador CRM. Este recurso somente é válido para credores que utilizam o meio de pagamento Boleto Manual.
Endpoint: https://www.recuperador.com.br/api/v1AtualizaBoletoManual
Ação: POST
Formato: FORM DATA
Autenticação: enviar o token da API no campo username da autenticação Basic Auth. Deixe o campo password em branco.
Objeto de entrada
{
id_credor: inteiro, id_cliente: inteiro, id_acordo: inteiro, id_contasareceber: inteiro, linha_digitavel_boleto_manual: string, extensao_imagem: string, content_type: string, bin_data: file
}
Seguem informações complementares sobre cada coluna do objeto:
- ID Credor: código do credor no Recuperador CRM. Ele está presente no payload do Webhook de acordos.
- ID Cliente: código do devedor no Recuperador CRM. Ele está presente no payload do Webhook de acordos.
- ID Acordo: código do acordo no Recuperador CRM. Ele está presente no payload do Webhook de acordos.
- ID Contas a Receber: código (ID) da parcela no Recuperador CRM. Ele está presente no payload do Webhook de acordos na lista de parcelas.
- Linha digitável do boleto manual: envie a linha digitável do boleto que será anexado usando esta API para verificação. Informe apenas números.
- Extensão da imagem: informe a extensão da imagem do boleto anexado usando esta API para verificação. Utilize apenas .pdf, .jpg, .jpeg, .gif, .bmp ou .png.
- Content type: tipo de conteúdo da imagem do boleto anexado usando esta API para verificação. Utilize apenas image/pjpeg, image/x-png, image/png, image/gif, image/bmp, image/jpeg, image/jpg ou application/pdf.
Classe de retorno
{
sucesso: bool, mensagem: string
}
Seguem informações complementares sobre cada coluna do objeto:
- Sucesso: retornará true em caso de chamada realizada com sucesso e false em caso de erro na chamada.
- Mensagem: exibirá a mensagem de sucesso ou de erro.