Openi DeveloperDeveloper
Credit card

Listar cartões

Lista os cartões de crédito de um item, com paginação.

Endpoint

GET /v1/items/:itemId/credit-cards

Parâmetros da URL:

  • itemId (string, obrigatório): ID do item (UUID v7)

Parâmetros de query (opcionais):

  • page (number): página, a partir de 1. Padrão: 1
  • limit (number): itens por página, de 1 a 100. Padrão: 20

Campos da resposta

  • data.pagination: page, total, totalPages
  • data.creditCards: lista de cartões
    • id: ID do cartão (use como accountId nos demais endpoints)
    • name: nome do cartão na instituição
    • brand: bandeira
    • level: nível do cartão
    • digits: últimos dígitos
    • holderType: tipo do titular
    • type, subtype, status: classificação e status informados pela instituição
    • currency: moeda
    • createdAt, updatedAt

Campos não informados pela instituição vêm como null.

Exemplo

curl "https://of.openi.com.br/v1/items/$ITEM_ID/credit-cards?page=1&limit=20" \
  -H "Authorization: Bearer $OPENI_API_KEY"
{
  "status": "success",
  "data": {
    "pagination": { "page": 1, "total": 1, "totalPages": 1 },
    "creditCards": [
      {
        "id": "0198a1b2-...",
        "type": "CREDIT",
        "subtype": null,
        "holderType": "TITULAR",
        "name": "Cartão Platinum",
        "digits": "1234",
        "status": "ACTIVE",
        "currency": "BRL",
        "level": "PLATINUM",
        "brand": "MASTERCARD",
        "updatedAt": "2026-01-15T10:30:00.000Z",
        "createdAt": "2026-01-15T10:30:00.000Z"
      }
    ]
  }
}

On this page