logo
CartõesListar Cartões
Cartões

Listar Cartões

Retorna a lista paginada de cartões corporativos da empresa, com filtros opcionais por status, tipo, e-mail do responsável, nome do produto e últimos 4 dígitos.

Filtros disponíveis:

  • status: ACTIVATED, BLOCKED, CANCELLED, INACTIVATED
  • type: PHYSICAL, VIRTUAL
  • email: e-mail do responsável pelo cartão
  • productName: nome do produto do cartão
  • last4: últimos 4 dígitos do número do cartão

Use nextPageStartKey para navegar entre páginas (paginação por cursor).

curl -X GET "https://api-sandbox.contasimples.com/credit-cards/v1/cards?email=responsavel-cartao@gmail.com&status=ACTIVATED&type=PHYSICAL&productName=Marketing Ads&last4=4821&nextPageStartKey=example_string&limit=10" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "items": [
    {
      "id": "example_string",
      "maskedNumber": "example_string",
      "cardHolderName": "John Doe",
      "responsible": {
        "name": "John Doe",
        "email": "user@example.com"
      },
      "type": "PHYSICAL",
      "createdAt": "2025-09-15T14:30:00.000Z",
      "updatedAt": "2025-09-20T10:00:00.000Z",
      "status": "ACTIVATED",
      "expirationDate": "2028-12-31T23:59:59.000Z",
      "name": "John Doe",
      "costCenter": {
        "id": "example_string",
        "name": "John Doe"
      },
      "formattedExpirationDate": "12/2028",
      "purpose": "FREE"
    }
  ],
  "nextPageStartKey": "eyJvZmZzZXQiOjB9",
  "limit": 10
}
GET
/credit-cards/v1/cards
GET
Bearer Token
Bearer Tokenstring
Required

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}
query
emailstring

E-mail do responsável pelo cartão.

query
statusstring

Status do cartão.

Options: ACTIVATED, BLOCKED, CANCELLED, INACTIVATED
query
typestring

Tipo do cartão.

Options: PHYSICAL, VIRTUAL
query
productNamestring

Nome do produto do cartão.

query
last4string

Últimos 4 dígitos do número do cartão.

query
nextPageStartKeystring

Token opaco de paginação retornado na resposta anterior. Use exatamente como recebido para obter a próxima página.

query
limitinteger

Número máximo de cartões por página. Mínimo: 1.

Min: 1
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer \{token\}

Query Parameters

emailstring

E-mail do responsável pelo cartão.

statusstring

Status do cartão.

Allowed values:ACTIVATEDBLOCKEDCANCELLEDINACTIVATED
typestring

Tipo do cartão.

Allowed values:PHYSICALVIRTUAL
productNamestring

Nome do produto do cartão.

last4string

Últimos 4 dígitos do número do cartão.

nextPageStartKeystring

Token opaco de paginação retornado na resposta anterior. Use exatamente como recebido para obter a próxima página.

limitinteger

Número máximo de cartões por página. Mínimo: 1.

Responses

itemsarray
Required

Lista de cartões.

nextPageStartKeystring

Token opaco para a próxima página. Se ausente, não há mais páginas. Use este valor no campo nextPageStartKey da próxima requisição.

limitinteger

Número de itens por página.