Cartões CAIXA Data API: Faturas, Credit Limits & Direct Debits

Caixa Econômica Federal · Banking

Cartões CAIXA is Caixa Econômica Federal's dedicated app for holders of CAIXA-issued credit cards in Brazil. Cardholders can check current and closed faturas, download PDF statements, review spending by merchant category, and manage additional cards. It also supports emergency and permanent credit-limit requests, virtual-card creation and security-code viewing, and automatic-debit arrangements linked to a CAIXA checking account. It focuses on card management rather than the bank's broader internet-banking services, serving Brazilian cardholders alongside issuer apps from Nubank, Banco do Brasil and Bradesco.

CAIXA fatura cycles connect identifierCodeBill with billCutOffDate, while totalSpend and groupsMCC describe spending across merchant categories. Current and closed statement records retain identifierCode, identifierClient and cardNumber; closed-cycle records also include bestDatePurchase. These fields support household-ledger reconciliation and comparisons between statement totals and categorized purchases.

Credit-limit offers pair limiteAtual, valorAumentoLimite and novoLimite with numeroCartao, bandeiraCartao and varianteCartao, allowing authorized limit-offer monitoring. Virtual-card records are selected using branch, account, creditcardClientIdentifier and documentType. Automatic-debit records link identificadorFatura to valorSolicitado, valorDebitado and situacao, with nested contaDebito details and the dates dataSolicitacao and dataRetorno. Budgeting tools, issuer reconciliation systems and authorized payroll matching can use these relationships; openData Studio turns them into callable open data.

Screenshots

API surface

The endpoints and request/response examples below are reconstructed from the app's interface — illustrative, not a live capture.

Cardholder token exchange
POST /v1/cardholder-sessions/exchange opendata
Exchanges a cardholder authorization code or refresh token for access_token and refresh_token, including token lifetime and scope metadata for subsequent authenticated card requests.
Auth: None for the authorization-code or refresh-token exchange. Later requests use Authorization: Bearer <access_token>.
- grant_type
- client_id
- code
- redirect_uri
- scope
- access_token
- refresh_token
- token_type
- expires_in
- refresh_expires_in
```
POST /v1/cardholder-sessions/exchange HTTP/1.1
Content-Type: application/x-www-form-urlencoded

grant_type=authorization_code&client_id=<client-id>&code=<auth-code>&redirect_uri=<redirect-uri>&scope=offline_access
```
```
{
  "access_token": "<jwt>",
  "refresh_token": "<refresh>",
  "token_type": "Bearer",
  "expires_in": 300,
  "refresh_expires_in": 1800,
  "scope": "offline_access"
}
```
Open fatura (full access)
GET /v1/statements/{id}/current/{incluirAdicionais} openfinance
Loads the current-cycle fatura for a card identifier, optionally including additional-card lines, as a JSON array.
Auth: Bearer access_token from the cardholder token exchange; an authenticated cardholder session is required.
- id
- incluirAdicionais
- identifierCode
- identifierClient
- cardNumber
```
GET /v1/statements/STMT-EXAMPLE-10/current/true HTTP/1.1
Authorization: Bearer <access_token>
Accept: application/json
```
```
[
  {
    "identifierCode": "STMT-EXAMPLE-10",
    "identifierClient": "holder-example-001",
    "cardNumber": "****4419"
  }
]
```
Closed fatura (full access)
GET /v1/statements/{id}/closed/{incluirAdicionais} openfinance
Loads a closed, previous-cycle fatura for a card identifier, optionally including additional-card lines and the best purchase date, as a JSON array.
Auth: Bearer access_token from the cardholder token exchange; an authenticated cardholder session is required.
- id
- incluirAdicionais
- identifierCode
- identifierClient
- cardNumber
- bestDatePurchase
```
GET /v1/statements/STMT-EXAMPLE-09/closed/true HTTP/1.1
Authorization: Bearer <access_token>
Accept: application/json
```
```
[
  {
    "identifierCode": "STMT-EXAMPLE-09",
    "identifierClient": "holder-example-001",
    "cardNumber": "****4419",
    "bestDatePurchase": "2026-09-12"
  }
]
```

Fatura PDF

POST /v1/statements/pdf-export openfinance

Requests a fatura PDF using cardNumber, identifierCode, identifierClient and bestDatePurchase to identify the statement.

Auth: Bearer access_token from the cardholder token exchange; an authenticated cardholder session is required.

cardNumber
identifierCode
identifierClient
bestDatePurchase

POST /v1/statements/pdf-export HTTP/1.1
Authorization: Bearer <access_token>
Content-Type: application/json

{
  "cardNumber": "****4419",
  "identifierCode": "STMT-EXAMPLE-10",
  "identifierClient": "holder-example-001",
  "bestDatePurchase": "2026-10-12"
}

{
  "cardNumber": "****4419",
  "identifierCode": "STMT-EXAMPLE-10",
  "identifierClient": "holder-example-001",
  "bestDatePurchase": "2026-10-12"
}

MCC spend profile
POST /v1/spending/category-breakdown openfinance
Groups statement spending by merchant category: accountNumber, cardNumber, identifierCodeClient, identifierCodeBill, billCutOffDate and groupCodeSelected identify the selection; totalSpend, groupsMCC and identifierCode describe the result.
Auth: Bearer access_token from the cardholder token exchange; an authenticated cardholder session is required.
- accountNumber
- cardNumber
- identifierCodeClient
- identifierCodeBill
- billCutOffDate
- groupCodeSelected
- totalSpend
- groupsMCC
- identifierCode
```
POST /v1/spending/category-breakdown HTTP/1.1
Authorization: Bearer <access_token>
Content-Type: application/json

{
  "accountNumber": "00123456-7",
  "cardNumber": "****4419",
  "identifierCodeClient": "holder-example-001",
  "identifierCodeBill": "STMT-EXAMPLE-10",
  "billCutOffDate": "2026-10-12",
  "groupCodeSelected": ["5411", "5812"]
}
```
```
{
  "totalSpend": "1842.55",
  "groupsMCC": [
    {"groupCode": "5411"}
  ],
  "identifierCode": "STMT-EXAMPLE-10"
}
```
Additional-card open faturas
GET /v1/statements/{id}/additional-cards/current openfinance
Lists open faturas for additional cards linked to the primary statement identifier.
Auth: Bearer access_token from the cardholder token exchange; an authenticated cardholder session is required.
- id
- identifierCode
- cardNumber
```
GET /v1/statements/STMT-EXAMPLE-10/additional-cards/current HTTP/1.1
Authorization: Bearer <access_token>
Accept: application/json
```
```
[
  {
    "identifierCode": "STMT-ADDITIONAL-EXAMPLE",
    "cardNumber": "****8821"
  }
]
```
Emergency-limit indicator
POST /v1/credit-options/emergency/check openfinance
Checks emergency-limit availability for a cardholder using agencia, conta and cpf.
Auth: Bearer access_token from the cardholder token exchange; an authenticated cardholder session is required. The operation requires the relevant card-management permission.
- agencia
- conta
- cpf
```
POST /v1/credit-options/emergency/check HTTP/1.1
Authorization: Bearer <access_token>
Content-Type: application/json

{
  "agencia": "0123",
  "conta": "00012345-6",
  "cpf": "<cpf>"
}
```
```
{
  "agencia": "0123",
  "conta": "00012345-6",
  "cpf": "<cpf>"
}
```
Confirm emergency limit
PUT /v1/credit-options/emergency/{hasEmergencyLimit} openfinance
Confirms or declines the emergency-limit flag through hasEmergencyLimit and returns the acknowledgement in mensagem.
Auth: Bearer access_token from the cardholder token exchange; an authenticated cardholder session is required. The operation requires the relevant card-management permission.
- hasEmergencyLimit
- mensagem
```
PUT /v1/credit-options/emergency/true HTTP/1.1
Authorization: Bearer <access_token>
Accept: application/json
```
```
{
  "mensagem": "Limite emergencial confirmado"
}
```
Credit-limit increase quote
POST /v1/credit-options/permanent/quote openfinance
Returns a pre-approved permanent credit-limit increase with limiteAtual, valorAumentoLimite and novoLimite, alongside cpfCnpj, nomeCliente, chpras, numeroCartao, bandeiraCartao and varianteCartao.
Auth: Bearer access_token from the cardholder token exchange; an authenticated cardholder session is required.
- cpfCnpj
- nomeCliente
- chpras
- numeroCartao
- bandeiraCartao
- varianteCartao
- limiteAtual
- valorAumentoLimite
- novoLimite
```
POST /v1/credit-options/permanent/quote HTTP/1.1
Authorization: Bearer <access_token>
Content-Type: application/json

{
  "cpfCnpj": "<cpf>",
  "numeroCartao": "****4419"
}
```
```
{
  "cpfCnpj": "<cpf>",
  "nomeCliente": "EXAMPLE CARDHOLDER",
  "chpras": "LIMIT-EXAMPLE",
  "numeroCartao": "****4419",
  "bandeiraCartao": "VISA",
  "varianteCartao": "GOLD",
  "limiteAtual": 5000,
  "valorAumentoLimite": 1500,
  "novoLimite": 6500
}
```
List virtual cards
POST /v1/virtual-cards/search openfinance
Lists the holder's virtual cards using branch, account, creditcardClientIdentifier and documentType.
Auth: Bearer access_token from the cardholder token exchange; an authenticated cardholder session is required. The operation requires the relevant card-management permission.
- branch
- account
- creditcardClientIdentifier
- documentType
```
POST /v1/virtual-cards/search HTTP/1.1
Authorization: Bearer <access_token>
Content-Type: application/json

{
  "branch": "0123",
  "account": "00012345-6",
  "creditcardClientIdentifier": "holder-example-001",
  "documentType": "CPF"
}
```
```
{
  "branch": "0123",
  "account": "00012345-6",
  "creditcardClientIdentifier": "holder-example-001",
  "documentType": "CPF"
}
```
Create virtual card
POST /v1/virtual-cards/issue openfinance
Creates a virtual card for the holder identified by branch, account, creditcardClientIdentifier and documentType. The authorized request includes device-location context.
Auth: Bearer access_token from the cardholder token exchange; an authenticated cardholder session is required. The operation requires the relevant card-management permission. Device-location context accompanies the request.
- branch
- account
- creditcardClientIdentifier
- documentType
```
POST /v1/virtual-cards/issue HTTP/1.1
Authorization: Bearer <access_token>
Content-Type: application/json

{
  "branch": "0123",
  "account": "00012345-6",
  "creditcardClientIdentifier": "holder-example-001",
  "documentType": "CPF"
}
```
```
{
  "branch": "0123",
  "account": "00012345-6",
  "creditcardClientIdentifier": "holder-example-001",
  "documentType": "CPF"
}
```
Virtual-card CVV
GET /v1/virtual-cards/{id}/security-code/{id2} openfinance
Retrieves the virtual-card CVV using the two identifiers id and id2. The authorized request includes device-location context; the mock shows only the identifying fields.
Auth: Bearer access_token from the cardholder token exchange; an authenticated cardholder session is required. The operation requires the relevant card-management permission. Device-location context accompanies the request.
- id
- id2
```
GET /v1/virtual-cards/VC-EXAMPLE/security-code/PAN-EXAMPLE HTTP/1.1
Authorization: Bearer <access_token>
Accept: application/json
```
```
{
  "id": "VC-EXAMPLE",
  "id2": "PAN-EXAMPLE"
}
```

Account-debit schedule

POST /v1/statement-payments/direct-debit/search openfinance

Reads a fatura's automatic-debit schedule, including identificadorFatura, valorSolicitado, valorDebitado, situacao, request and return dates, and the nested contaDebito account details.

Auth: Bearer access_token from the cardholder token exchange; an authenticated cardholder session is required. The operation requires the relevant card-management permission.

agencia
conta
contaDebito
produto
numero
digitoVerificador
cpfCnpj
dataRetorno
dataSolicitacao
identificadorFatura
remessa
situacao
tipoSolicitacao
valorDebitado
valorSolicitado

POST /v1/statement-payments/direct-debit/search HTTP/1.1
Authorization: Bearer <access_token>
Content-Type: application/json

{
  "agencia": "0123",
  "conta": "00012345-6",
  "cpfCnpj": "<cpf>",
  "identificadorFatura": "STMT-EXAMPLE-10"
}

{
  "agencia": "0123",
  "conta": "00012345-6",
  "contaDebito": {
    "produto": "001",
    "numero": "00012345",
    "digitoVerificador": "6",
    "agencia": "0123"
  },
  "cpfCnpj": "<cpf>",
  "dataRetorno": "2026-10-20",
  "dataSolicitacao": "2026-10-05",
  "identificadorFatura": "STMT-EXAMPLE-10",
  "remessa": "REMITTANCE-EXAMPLE",
  "situacao": "AGENDADO",
  "tipoSolicitacao": "DEBITO_AUTOMATICO",
  "valorDebitado": "0.00",
  "valorSolicitado": "1842.55"
}

Include account debit

POST /v1/statement-payments/direct-debit/enrolments openfinance

Enrols automatic debit for a fatura using agencia, conta, cpfCnpj, identificadorFatura, valorSolicitado, tipoSolicitacao and contaDebito, returning situacao and dataSolicitacao.

Auth: Bearer access_token from the cardholder token exchange; an authenticated cardholder session is required. The operation requires the relevant card-management permission.

agencia
conta
cpfCnpj
identificadorFatura
valorSolicitado
tipoSolicitacao
contaDebito
produto
numero
digitoVerificador
situacao
dataSolicitacao

POST /v1/statement-payments/direct-debit/enrolments HTTP/1.1
Authorization: Bearer <access_token>
Content-Type: application/json

{
  "agencia": "0123",
  "conta": "00012345-6",
  "cpfCnpj": "<cpf>",
  "identificadorFatura": "STMT-EXAMPLE-10",
  "valorSolicitado": "1842.55",
  "tipoSolicitacao": "DEBITO_AUTOMATICO",
  "contaDebito": {
    "produto": "001",
    "numero": "00012345",
    "digitoVerificador": "6",
    "agencia": "0123"
  }
}

{
  "identificadorFatura": "STMT-EXAMPLE-10",
  "situacao": "AGENDADO",
  "valorSolicitado": "1842.55",
  "dataSolicitacao": "2026-10-05"
}

Data categories

invoices
spend-profile
credit-limits
virtual-cards
direct-debit
identity

Where teams use this data

Fatura close-cycle reconciliation
Household ledgers pull identifierCodeBill, billCutOffDate and totalSpend plus groupsMCC so a CAIXA Visa cycle can be matched to POS receipts without opening the PDF.
Limit-offer monitoring
Issuer ops watch limiteAtual, valorAumentoLimite and novoLimite on chpras / numeroCartao / bandeiraCartao, and the emergency-limit flag keyed by agencia, conta and cpf.
Virtual-card checkout vault
Commerce backends list virtual plastics by branch, account, creditcardClientIdentifier and documentType, then fetch CVV on the two-id consultarCVV call when the holder authorises a one-time charge.
Débito automático payroll match
Payroll bots read identificadorFatura, valorSolicitado, valorDebitado and situacao against ContaDebito numero / digitoVerificador so a salary credit covers the scheduled fatura debit.

Frequently asked questions

What card data does the Cartões CAIXA data API illustrate?

It covers current and closed faturas, additional-card statement references, PDF statement identifiers, merchant-category spending, emergency-limit checks, permanent credit-limit offers, virtual-card workflows and automatic-debit schedules. The examples use illustrative paths and mock values rather than live issuer addresses.

How is cardholder authentication represented?

An authorization-code or refresh-token exchange supplies access_token and refresh_token with token lifetime and scope metadata. Subsequent card requests require Bearer access_token, an authenticated cardholder session and the permissions specified for the operation. Client identifiers, authorization codes and redirect values are placeholders; the examples do not provide public access to personal financial information.

Which fields support fatura reconciliation?

identifierCodeBill and billCutOffDate identify the statement cycle, while totalSpend and groupsMCC describe categorized spending. identifierCode, identifierClient and cardNumber tie the statement references together, including additional-card cycles.

How can automatic debits be matched to a statement?

identificadorFatura links the scheduled debit to its fatura. valorSolicitado, valorDebitado and situacao show the requested amount, debited amount and schedule status; contaDebito contains the linked account details, and dataSolicitacao and dataRetorno record the request and return dates.

Apps similar to Cartões CAIXA

Bradesco Cartões — Bradesco Cartões is Banco Bradesco's dedicated credit-card app for checking live purchases and limits, paying the digital fatura via Pix or a PDF boleto, blocking or unblocking the card and NFC, and creating a virtual card for online payments.
Nubank — Nubank's Brazilian app combines a free NuConta with a no-annual-fee international credit card, unlimited free Pix around the clock, and in-app control of spending, transfers and payments.
BB: Banco, Conta, Pix, Cartão — Banco do Brasil's BB app is a full digital account for Pix, a credit card, loans and financing from Brazil's government-controlled bank.
Banco Itaú: Conta, Cartão e + — Banco Itaú's consumer app lets customers open an account, request a credit card, send Pix, and use cashback, investments and loans in one login.
Inter: Conta, Cartão e Pix — Inter's Super App offers a Brazilian digital account with unlimited fee-free Pix, TED and DOC, plus an international credit card with a points program and a virtual card for online and tap-to-pay purchases.
C6 Bank: Cartão, Conta e Mais! — C6 Bank's app is a Brazilian digital bank that issues a credit card alongside a digital account in reais and an international account.
Santander Brasil — Santander Brasil's app is the Brazilian subsidiary of Spain's Santander Group and offers a digital account, credit card and loans.
Cartão Carrefour: Crédito e + — Banco CSF's Cartão Carrefour app lets holders of the Carrefour store credit card check available and used limit, track spending in real time, generate a barcode to pay the fatura, and request additional cards.

More Banking apps

Topics

Cartões CAIXA
Caixa Econômica Federal
fatura CAIXA
cartão virtual CAIXA
limite emergencial
débito automático cartão
Brazil credit card API
CAIXA fatura data
MCC spending profile

Need this app's data API integrated?

We deliver scoped integrations for any named app — from USD 500 with source-code handoff, or hosted access billed per call. Tell us the data you need.

NDA + SOW on every engagement
Delivery in 3–7 days
Payment only after acceptance
Work scoped to authorized use

Get a quote

Cartões CAIXA Data API: Faturas, Credit Limits & Direct Debits

Screenshots

API surface

Cardholder token exchange

Open fatura (full access)

Closed fatura (full access)

Fatura PDF

MCC spend profile

Additional-card open faturas

Emergency-limit indicator

Confirm emergency limit

Credit-limit increase quote

List virtual cards

Create virtual card

Virtual-card CVV

Account-debit schedule

Include account debit

Data categories

Where teams use this data

Fatura close-cycle reconciliation

Limit-offer monitoring

Virtual-card checkout vault

Débito automático payroll match

Frequently asked questions

Apps similar to Cartões CAIXA

More Banking apps

5paisa: Demat, Stocks & IPO

Ajaib: Stock, Crypto, US Stock

Albert: Budgeting and Banking

AndroMoney

Topics

Need this app's data API integrated?

Cartões CAIXA Data API: Faturas, Credit Limits & Direct Debits

Screenshots

API surface

Cardholder token exchange

Open fatura (full access)

Closed fatura (full access)

Fatura PDF

MCC spend profile

Additional-card open faturas

Emergency-limit indicator

Confirm emergency limit

Credit-limit increase quote

List virtual cards

Create virtual card

Virtual-card CVV

Account-debit schedule

Include account debit

Data categories

Where teams use this data

Fatura close-cycle reconciliation

Limit-offer monitoring

Virtual-card checkout vault

Débito automático payroll match

Frequently asked questions

Related apps

Apps similar to Cartões CAIXA

More Banking apps

5paisa: Demat, Stocks & IPO

Ajaib: Stock, Crypto, US Stock

Albert: Budgeting and Banking

AndroMoney

Topics

Need this app's data API integrated?