Sign in

v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Credit Card Receivables

Listagem de recebíveis

Obtém lista de recebíveis ainda disponíveis para antecipar hoje

get/credit-card-receivables

Query parameters

pageSizenumber

Número de itens a serem incluidos na página

pageNumbernumber

Número da página onde começará a query

Response

Success

idnumber

Identificador do recebível

payerIdstring

Cnpj da credenciadora

payeeIdstring

Cnpj do estabelecimento comercial

maturityDatestring date

Data de vencimento do recebível seguindo a norma ISO-8601

scheme'Visa' | 'MasterCard' | 'Elo' | 'AmericanExpress' | 'HiperCard'

Bandeira do cartão de crédito

maturityAmountstring double

Valor do recebível disponível para antecipar, ou seja, o valor máximo que poderá ser registrado na Registradora

maximumDisbursementAmountstring double

maturityAmount descontado da taxa de operação acordada, ou seja, o valor máximo que o estabelecimento comercial poderá receber ao antecipar o recebível

status'Available' | 'WaitingSignatures' | 'WaitingRegistration' | 'InDisbursement' | 'Disbursed' | 'Settled' | 'Overdue' | 'Cancelled'

Estado do recebível

Example response

[
  {
    "id": 20,
    "payerId": "01027058000191",
    "payeeId": "37297902000141",
    "maturityDate": "2024-02-15",
    "maturityAmount": "50000.55",
    "maximumDisbursementAmount": "40000.44"
  }
]