Openi DeveloperDeveloper
Credit card

Buscar cartão

Retorna um cartão de crédito com seus limites e faturas.

Endpoint

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

Parâmetros da URL:

  • itemId (string, obrigatório): ID do item (UUID v7)
  • accountId (string, obrigatório): ID do cartão (UUID v7)

Campos da resposta

data traz os mesmos campos de Listar cartões, mais:

  • limits: limites do cartão
    • id, identificationNumber, consolidationType, limitType, isFlexible
    • limitTotal, limitUsed, limitAvailable: valores em string decimal
    • limitTotalCurrencyCode, limitUsedCurrencyCode, limitAvailableCurrencyCode
    • createdAt, updatedAt
  • bills: faturas do cartão, no formato de Buscar fatura

Exemplo

curl https://of.openi.com.br/v1/items/$ITEM_ID/credit-cards/$ACCOUNT_ID \
  -H "Authorization: Bearer $OPENI_API_KEY"
{
  "status": "success",
  "data": {
    "id": "0198a1b2-...",
    "name": "Cartão Platinum",
    "brand": "MASTERCARD",
    "digits": "1234",
    "currency": "BRL",
    "limits": [
      {
        "id": "0198a1b3-...",
        "limitType": "TOTAL",
        "isFlexible": false,
        "limitTotal": "10000.00",
        "limitTotalCurrencyCode": "BRL",
        "limitUsed": "2350.40",
        "limitUsedCurrencyCode": "BRL",
        "limitAvailable": "7649.60",
        "limitAvailableCurrencyCode": "BRL"
      }
    ],
    "bills": []
  }
}

Erro (404): item ou cartão inexistente, ou de outra aplicação.

On this page