TransaçõesExtrato de Cartão

Extrato de Cartão

Consulta o extrato de transações de cartão por período. Retorna uma lista paginada de transações com dados do cartão, categoria, centro de custo, status e anexos.

Regras:

  • O período entre startDate e endDate não pode exceder 62 dias.
  • O limit deve estar entre 5 e 100 itens por página.
  • Use nextPageStartKey para navegar entre páginas (paginação por cursor).
curl -X GET "https://api-sandbox.contasimples.com/statements/v1/credit-card?limit=50&startDate=2025-09-01&endDate=2025-09-30&types=["PURCHASE"]&cardIds=cardId1,cardId2&nextPageStartKey=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "transactions": [
    {
      "id": "example_string",
      "operation": "CASH_IN",
      "transactionDate": "2025-09-15T14:30:00.000Z",
      "status": "PENDING",
      "isCanceled": true,
      "type": "PURCHASE",
      "merchant": "example_string",
      "amountBrl": 150.75,
      "exchangeRateUsd": 0,
      "card": {
        "id": "example_string",
        "maskedNumber": "example_string",
        "responsibleName": "John Doe",
        "responsibleEmail": "user@example.com",
        "type": "VIRTUAL"
      },
      "category": {
        "id": "example_string",
        "name": "Alimentação"
      },
      "costCenter": {
        "id": "example_string",
        "name": "Marketing"
      },
      "isConciled": true,
      "installment": 1,
      "attachments": [
        {
          "id": "example_string",
          "name": "comprovante.pdf",
          "type": "image/jpeg",
          "_links": {
            "content": {
              "href": "/attachments/v1/content/{id}",
              "rel": "GET"
            }
          }
        }
      ],
      "notes": "example_string"
    }
  ],
  "nextPageStartKey": "example_string"
}
GET
/statements/v1/credit-card
GET
Base URLstring

Target server for requests. Edit to use your own host.

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
limitinteger
Required

Número máximo de transações por página. Mínimo: 5, Máximo: 100.

Min: 5 • Max: 100
query
startDatestring
Required

Data de início do período consultado (formato YYYY-MM-DD). O período não pode exceder 62 dias.

Format: date
query
endDatestring
Required

Data de fim do período consultado (formato YYYY-MM-DD). O período não pode exceder 62 dias.

Format: date
query
typesarray

Filtro opcional por tipo(s) de transação.

query
cardIdsarray

Filtro opcional por ID(s) de cartão (separados por vírgula).

query
nextPageStartKeystring

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

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

limitinteger
Required

Número máximo de transações por página. Mínimo: 5, Máximo: 100.

startDatestring
Required

Data de início do período consultado (formato YYYY-MM-DD). O período não pode exceder 62 dias.

endDatestring
Required

Data de fim do período consultado (formato YYYY-MM-DD). O período não pode exceder 62 dias.

typesarray

Filtro opcional por tipo(s) de transação.

cardIdsarray

Filtro opcional por ID(s) de cartão (separados por vírgula).

nextPageStartKeystring

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

Responses

transactionsarray
Required

Lista de transações do período consultado.

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.