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
startDateeendDatenão pode exceder 62 dias. - O
limitdeve estar entre 5 e 100 itens por página. - Use
nextPageStartKeypara 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"]&nextPageStartKey=example_string" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://api-sandbox.contasimples.com/statements/v1/credit-card?limit=50&startDate=2025-09-01&endDate=2025-09-30&types=["PURCHASE"]&nextPageStartKey=example_string"
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/statements/v1/credit-card?limit=50&startDate=2025-09-01&endDate=2025-09-30&types=["PURCHASE"]&nextPageStartKey=example_string", {
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/statements/v1/credit-card?limit=50&startDate=2025-09-01&endDate=2025-09-30&types=["PURCHASE"]&nextPageStartKey=example_string", 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/statements/v1/credit-card?limit=50&startDate=2025-09-01&endDate=2025-09-30&types=["PURCHASE"]&nextPageStartKey=example_string')
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
{
"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"
}
{
"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
}
/statements/v1/credit-card
Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}
Bearer {token}Número máximo de transações por página. Mínimo: 5, Máximo: 100.
Data de início do período consultado (formato YYYY-MM-DD). O período não pode exceder 62 dias.
Data de fim do período consultado (formato YYYY-MM-DD). O período não pode exceder 62 dias.
Filtro opcional por tipo(s) de transação.
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
Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer {token}
Query Parameters
Número máximo de transações por página. Mínimo: 5, Máximo: 100.
Data de início do período consultado (formato YYYY-MM-DD). O período não pode exceder 62 dias.
Data de fim do período consultado (formato YYYY-MM-DD). O período não pode exceder 62 dias.
Filtro opcional por tipo(s) de transação.
Token opaco de paginação retornado na resposta anterior. Use exatamente como recebido para obter a próxima página.
Responses
Lista de transações do período consultado.
Identificador único da transação.
Tipo de operação da transação.
CASH_INCASH_OUTData e hora da transação (ISO 8601).
Status atual da transação.
PENDINGPROCESSEDCANCELEDIndica se a transação foi cancelada.
Tipo detalhado da transação.
PURCHASEPURCHASE_INTERNATIONALPURCHASE_BNPLWITHDRAWWITHDRAW_INTERNATIONALWITHDRAW_FUNDSBALANCE_INQUIRYPAYMENT_PLAN_INQUIRYREFUNDREFUND_INTERNATIONALREFUND_CREDIT_ADJUSTMENTREVERSAL_CREDIT_ADJUSTMENTREFUND_IOFREFUND_PURCHASE_BNPLIOFLIMITLIMIT_CREDITSUMMARYBILL_TARIFFREFUND_BILL_TARIFFINVOICE_PAYMENTNome do estabelecimento onde a transação foi realizada.
Valor da transação em Reais (BRL).
Taxa de câmbio em dólar (USD). Presente em transações internacionais — use apenas como referência para auditoria.
Dados do cartão associado à transação.
Identificador único do cartão.
Número do cartão mascarado (ex: **** **** **** 1234).
Nome do responsável pelo cartão.
E-mail do responsável pelo cartão.
Tipo do cartão.
VIRTUALPHYSICALCategoria de despesa associada à transação.
Identificador único da categoria.
Nome da categoria (ex: Alimentação, Transporte).
Centro de custo associado à transação.
Identificador único do centro de custo.
Nome do centro de custo.
Indica se a transação foi conciliada.
Número da parcela (para compras parceladas).
Lista de anexos vinculados à transação (comprovantes, notas fiscais, recibos).
Identificador único do anexo. Use este ID no endpoint GET /attachments/v1/content/{attachmentId} para download.
Nome do arquivo do anexo.
Tipo MIME do arquivo, inferido pela extensão do nome (.jpg/.jpeg, .png ou .pdf). Ausente quando a extensão não for reconhecida.
image/jpegimage/pngapplication/pdfLinks para download do conteúdo do anexo.
Link HATEOAS para recurso relacionado.
URL relativa do recurso vinculado.
Método HTTP para acessar o recurso.
Observação inserida pelo usuário.
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.
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