v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB

Antecipação de Recebíveis

Consulta os convênios vinculádos com a conta.

Convênios - Consulta os convênios vinculádos com a conta<br/>Permite que seja acessado os detalhes específicos dos convênios vinculados a conta.<br/><br/>Funcionalidades do Endpoint:<br/>- Identificador do conênios: Captura o identificador do convênio.<br/><br/>Requisição<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>client-id</td><td>Texto</td><td>Cliente ID</td><td>Sim</td></tr><tr><td>cpfOperador</td><td>Texto</td><td>CPF do recebedor</td><td>Sim</td></tr><tr><td>contaOrigem</td><td>Texto</td><td>Conta da qual se origina o pagamento com o digito verificador.</td><td>Sim</td></tr></tbody></table><br/><br/>Resposta<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>assignor_uuid</td><td>Texto</td><td>UUID do convênio</td></tr><tr><td>name</td><td>Texto</td><td>Nome do convênio</td></tr><tr><td>created_at</td><td>Texto</td><td>Data de Criação</td></tr><tr><td>product</td><td>Texto</td><td>Nome do Produto</td></tr></tbody></table>

get/api/v1/credit/anticipation/assignor

Query parameters

contaOrigemstring required

Example:0000000000

Número da conta.

cpfOperadorstring required

Example:00000000000

CPF do operador.

Headers

client-idstring uuid required

Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Client ID enviado no Header

Response

Consulta retornada com sucesso.

messagestring

Example response

{
  "message": "Consulta retornada com sucesso.",
  "data": [
    {
      "assignor_uuid": "15131bc6-1c58-47cc-9265-5c0da9e8b99c",
      "name": "Pay",
      "created_at": "2025-10-13 09:22:39",
      "product": "Antecipação de Recebíveis"
    }
  ]
}