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, INACTIVATEDtype: PHYSICAL, VIRTUALemail: e-mail do responsável pelo cartãoproductName: nome do produto do cartãolast4: ú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"
import requests
import json
url = "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"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("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", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("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", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('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')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"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": "Marketing"
},
"formattedExpirationDate": "12/2028",
"purpose": "FREE"
}
],
"nextPageStartKey": "eyJvZmZzZXQiOjB9",
"limit": 10
}
{
"error": "Bad Request",
"message": "Um ou mais parâmetros da requisição são inválidos.",
"code": 400,
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"details": [
"O campo exemplo deve ter um valor entre 5 e 100.",
"datas devem estar no formato YYYY-MM-DD."
]
}
{
"error": "Unauthorized",
"message": "Token de acesso inválido ou expirado.",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"code": 401
}
{
"error": "Not Found",
"message": "O recurso solicitado não foi encontrado.",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"code": 404
}
{
"error": "Internal Server Error",
"message": "Ocorreu um erro inesperado ao processar a solicitação.",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"code": 500
}
/credit-cards/v1/cards
Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}
Bearer {token}E-mail do responsável pelo cartão.
Status do cartão.
Tipo do cartão.
Nome do produto do cartão.
Últimos 4 dígitos do número do cartão.
Token opaco de paginação retornado na resposta anterior. Use exatamente como recebido para obter a próxima página.
Número máximo de cartões por página. Mínimo: 1.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}
Query Parameters
E-mail do responsável pelo cartão.
Nome do produto do cartão.
Últimos 4 dígitos do número do cartão.
Token opaco de paginação retornado na resposta anterior. Use exatamente como recebido para obter a próxima página.
Número máximo de cartões por página. Mínimo: 1.
Responses
Lista de cartões.
Identificador único do cartão.
Número do cartão mascarado (ex: **** **** **** 1234).
Nome do portador do cartão.
Dados do responsável pelo cartão.
Nome do responsável pelo cartão.
E-mail do responsável pelo cartão.
Tipo do cartão.
PHYSICALVIRTUALData de criação do cartão (ISO 8601).
Data da última atualização do cartão (ISO 8601).
Status atual do cartão.
ACTIVATEDBLOCKEDCANCELLEDINACTIVATEDData de expiração do cartão (ISO 8601).
Nome atribuído ao cartão.
Centro de custo associado à transação.
Identificador único do centro de custo.
Nome do centro de custo.
Data de expiração formatada (MM/YYYY).
Finalidade do cartão.
FREETRIPADSSOFTWAREAERIALHOTELToken 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.
Número de itens por página.
Breve identificação do tipo de erro (ex.: Bad Request, Not Found).
Descrição breve do erro para o cliente da API.
Código HTTP do erro (corresponde ao status da resposta).
Opcional. Em erros 400, pode ser uma string com um único detalhe ou um array de strings com cada falha de validação.
Breve identificação do tipo de erro (ex.: Bad Request, Not Found).
Descrição breve do erro para o cliente da API.
Código HTTP do erro (corresponde ao status da resposta).
Opcional. Em erros 400, pode ser uma string com um único detalhe ou um array de strings com cada falha de validação.
Breve identificação do tipo de erro (ex.: Bad Request, Not Found).
Descrição breve do erro para o cliente da API.
Código HTTP do erro (corresponde ao status da resposta).
Opcional. Em erros 400, pode ser uma string com um único detalhe ou um array de strings com cada falha de validação.
Breve identificação do tipo de erro (ex.: Bad Request, Not Found).
Descrição breve do erro para o cliente da API.
Código HTTP do erro (corresponde ao status da resposta).
Opcional. Em erros 400, pode ser uma string com um único detalhe ou um array de strings com cada falha de validação.
Last updated today
Built with Documentation.AI