v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB
Antecipação de Recebíveis

Geração de Propostas

Antecipação de Recebíveis - Geração de Propostas.<br/>Permite que seja criado propostas de antecipações de recebíveis.<br/><br/>Funcionalidades do Endpoint:<br/>- Proposta: Gera propostas com base em recebíveis selecionados.<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><tr><td>assignorUuid</td><td>Texto</td><td>Convênio ID</td><td>Sim</td></tr><tr><td>receivables</td><td>Lista</td><td>Lista de recebíveis em formato numérico, ex: [12555, 13555]. Valor capturado no retorno do endpoint 'GET /api/v1/credit/anticipation/receivables', coluna Id.</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>name</td><td>Texto</td><td>Nome</td></tr><tr><td>uuid</td><td>Texto</td><td>Identificador</td></tr><tr><td>assignor_uuid</td><td>Texto</td><td>Convênio</td></tr><tr><td>account_uuid</td><td>Texto</td><td>Uuid da Conta</td></tr><tr><td>status</td><td>Texto</td><td>Status</td></tr><tr><td>type</td><td>Numérico</td><td>Tipo</td></tr><tr><td>channel</td><td>Numérico</td><td>ID do Canal</td></tr><tr><td>has_bill</td><td>Boolean</td><td>Se tem Boleto habilitado</td></tr><tr><td>has_pix</td><td>Boolean</td><td>Se tem Pix habilitado</td></tr><tr><td>has_credit_card</td><td>Boolean</td><td>Se tem Cartão de Crédito habilitado</td></tr><tr><td>tax_amount</td><td>Numérico</td><td>Taxa</td></tr><tr><td>charge_value</td><td>Numérico</td><td>Valor da Cobrança</td></tr><tr><td>total_anticipation</td><td>Numérico</td><td>Total de Antecipação</td></tr><tr><td>total_released</td><td>Numérico</td><td>Total Liberado</td></tr><tr><td>amount_receivables</td><td>Numérico</td><td>Total de Recebíveis</td></tr><tr><td>proposal_identifier</td><td>Texto</td><td>Identificador da Proposta</td></tr><tr><td>contract</td><td>Texto</td><td>Contrato</td></tr><tr><td>operation_number</td><td>Texto</td><td>Número da operação</td></tr><tr><td>created_by</td><td>Texto</td><td>Criado por</td></tr><tr><td>created_date</td><td>Texto</td><td>Data de Criação</td></tr><tr><td>expire_date</td><td>Texto</td><td>Data de Expiração</td></tr><tr><td>accept_date</td><td>Texto</td><td>Data de Aceite</td></tr><tr><td>cancel_date</td><td>Texto</td><td>Data de Cancelamento</td></tr><tr><td>complete_date</td><td>Texto</td><td>Data Completa</td></tr><tr><td>agreement_id</td><td>Numérico</td><td>Id do Acordo</td></tr><tr><td>assignor_channel_name</td><td>Texto</td><td>Nome do Convênio</td></tr></tbody></table>

post/api/v1/credit/anticipation/proposal

Headers

client-idstring uuid required
Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Client ID enviado no Header

Request body

contaOrigemstring
cpfOperadorstring
assignorUuidstring
receivablesinteger[]

Example request

{
  "contaOrigem": "0000000000",
  "cpfOperador": "00000000000",
  "assignorUuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "receivables": [
    15155
  ]
}

Response

Proposta enviada com sucesso.

messagestring

Example response

{
  "message": "Proposta enviada com sucesso.",
  "data": {
    "name": "Pay",
    "uuid": "7964a0b1-fc2e-4721-96cd-195ce94c29b",
    "assignor_uuid": "7964a0b1-fc2e-4721-96cd-195ce94c29b1",
    "account_uuid": "7964a0b1-fc2e-4721-96cd-195ce94c29b1",
    "status": "proposal_with_error",
    "contract": "null",
    "operation_number": "null",
    "created_by": "Jhon",
    "created_date": "15/10/2025 11:39:14",
    "expire_date": "15/10/2025 11:39:14",
    "expired_date": "15/10/2025 11:39:14",
    "accept_date": "15/10/2025 11:39:14",
    "cancel_date": "15/10/2025 11:39:14",
    "complete_date": "15/10/2025 11:39:14"
  }
}