Openi DeveloperDeveloper
Credit card

Buscar fatura

Retorna uma fatura de cartão de crédito com encargos e pagamentos.

Endpoint

GET /v1/items/:itemId/credit-cards/:accountId/bills/:billId

Parâmetros da URL:

  • itemId, accountId, billId (string, obrigatórios): UUID v7

Campos da resposta

  • id: ID da fatura (aparece como billId nas transações do cartão)
  • amount, amountCurrencyCode: valor total da fatura
  • minimumPayment: pagamento mínimo, ou null
  • allowsInstallments: se a fatura pode ser parcelada
  • expiresAt: vencimento
  • charges: encargos (id, type, amount, amountCurrencyCode, additionalInfo)
  • payments: pagamentos (id, amount, amountCurrencyCode, paidAt, paymentType, paymentMode, isOverParcelPayment)
  • createdAt, updatedAt

Exemplo

curl https://of.openi.com.br/v1/items/$ITEM_ID/credit-cards/$ACCOUNT_ID/bills/$BILL_ID \
  -H "Authorization: Bearer $OPENI_API_KEY"
{
  "status": "success",
  "data": {
    "id": "0198a1b4-...",
    "amount": "2350.40",
    "amountCurrencyCode": "BRL",
    "minimumPayment": "352.56",
    "allowsInstallments": true,
    "expiresAt": "2026-02-10T00:00:00.000Z",
    "charges": [],
    "payments": [
      {
        "id": "0198a1b5-...",
        "amount": "2350.40",
        "amountCurrencyCode": "BRL",
        "paidAt": "2026-02-09T00:00:00.000Z",
        "paymentType": null,
        "paymentMode": null,
        "isOverParcelPayment": false
      }
    ]
  }
}

Erro (404): Bill not found.

On this page