v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB

Credit Card Receivables

Busca recebíveis por parâmetros de busca

Obtém os recebíveis disponíveis para antecipação de acordo com os parâmetros informados e visualiza informações de taxa média e prazo médio.

post/credit-card-receivables

Request body

valorDesejadostring

Valor desejado para a operação

bandeirasstring[]

Lista de bandeiras de cartão de crédito. Pode ser preenchido ou vazio (nesse caso, busca por todos).

sacadosstring[]

Lista de CNPJs das credenciadoras. Pode ser preenchido ou vazio (nesse caso, busca por todos).

tipoConsulta'PorValorDesembolso' | 'PorValorBruto'

Tipo de consulta

tipoAproximacaoValorDesejado'Exata' | 'PorCima' | 'PorBaixo'

Tipo de aproximação do valor desejado

Example request

{
  "valorDesejado": "700000",
  "bandeiras": [
    "Visa",
    "MasterCard",
    "Elo",
    "AmericanExpress",
    "HiperCard"
  ],
  "sacados": [
    "01425787000104",
    "10440482000154",
    "01027058000191"
  ],
  "tipoConsulta": "PorValorDesembolso",
  "tipoAproximacaoValorDesejado": "Exata"
}

Response

Sugestão de recebíveis realizada com sucesso

averageTermnumber

Prazo médio da operação

averageRatenumber

Taxa média ponderada

Example response

{
  "averageTerm": 5,
  "averageRate": 0.02,
  "recebiveis": [
    {
      "status": "Available",
      "maximumDisbursementAmount": "66.19",
      "id": 104317068,
      "payeeId": "37297902000141",
      "payerId": "01027058000191",
      "maturityDate": "2025-06-01",
      "scheme": "MasterCard",
      "maturityAmount": "66.41",
      "suggestedDisbursementAmount": "66.19",
      "suggestedMaturityAmount": "66.41"
    }
  ]
}