Credz cardholder, invoice and Pix data API
Credz is DMCARD SA's app for CREDZ cardholders in Brazil, bringing card and CredzConta account management into a Portuguese-language interface. After signing in with a CPF and password, holders can check credit limits and open or past invoices, view their card password, and obtain a virtual card's rotating security code for online purchases. CredzConta adds balance and statement views, Pix keys, QR-code payments and adjustable transfer limits, alongside the cardholder's acquired insurance products. Its Google Play listing is rated 4.3 from around 157,000 reviews.
Open-invoice balances pair valorFaturaAberta with vencimentoFaturaAberta, while idCartao and idFatura connect a bill to its card and payment history. Closed invoices add valorPago, dataPagamento and codigoTransacaoPagamentoFatura; credit capacity is represented separately by valorLimiteTotal, valorLimiteDisponivel and the installment and withdrawal limits.
CredzConta ledger entries attach valorTransacao to dataHoraTransacao and endToEndId, alongside balance snapshots in saldo and accountBalanceValue. Pix directory records use chave and tipoChave, and transfer controls distinguish limitePixPessoaDiurnoMax from valorLimiteNoturnoTransferencia. These fields support invoice-operations reconciliation, Pix treasury dashboards and credit-capacity monitoring. With authorized access, checkout integrations can also work with virtualCardId, securityCode and expiracaoCodigoSegundos for time-limited virtual-card credentials. openData Studio turns these records into callable open data; the examples below use illustrative paths and mock values rather than live service addresses.
Screenshots
API surface
The endpoints and request/response examples below are reconstructed from the app's interface — illustrative, not a live capture.
Issue IdentityServer access token
POST
/v1/cardholder-sessions/createopendataExchanges the cardholder CPF and password for the IdentityServer access_token that gates holder, invoice, Pix and CredzConta calls.
Auth: None. CPF as username plus password, grant_type=password, client_id and scope=openid mint access_token. Later calls send Authorization: Bearer plus a sessao query on holder and digital-account routes.
- grant_type
- username
- password
- client_id
- scope
- access_token
- token_type
- expires_in
- refresh_token
POST /v1/cardholder-sessions/create HTTP/1.1 Content-Type: application/x-www-form-urlencoded grant_type=password&username=<holder-cpf>&password=<password>&client_id=<client-id>&scope=openid{ "access_token": "<access-token>", "token_type": "Bearer", "expires_in": 3600, "refresh_token": "<refresh-token>", "scope": "openid" }Read cardholder profile
GET
/v1/member/profileosintReturns the signed-in portador (cardholder) record: name, CPF/documento, holderStatus and digital-invoice contact channels.
Auth: Bearer access_token from the illustrative cardholder session. sessao query is appended on this route.
- nomePortador
- holderName
- documento
- cpf
- holderDocument
- holderStatus
- titular
- tipoDocumento
- digitalInvoiceEmail
- digitalInvoiceNumber
- sessao
GET /v1/member/profile?sessao=<session-id> HTTP/1.1 Authorization: Bearer <access_token> Accept: application/json{ "nomePortador": "ILLUSTRATIVE CARDHOLDER", "holderName": "ILLUSTRATIVE CARDHOLDER", "documento": "<holder-cpf>", "cpf": "<holder-cpf>", "holderDocument": "<holder-cpf>", "holderStatus": "ATIVO", "titular": true, "tipoDocumento": "CPF", "digitalInvoiceEmail": "<invoice-email>", "digitalInvoiceNumber": "<holder-phone>" }List holder cards
GET
/v1/card-portfolioopenbankingLists the holder's physical and virtual cards with last-four, available/total limit and the open-invoice snapshot shown on the home carousel.
Auth: Bearer access_token from the illustrative cardholder session.
- idCartao
- numeroCartao
- finalCartao
- nomePortador
- imagemCartao
- valorLimiteTotal
- valorLimiteDisponivel
- vencimentoFaturaAberta
- valorFaturaAberta
- contactless
- pixCartaoLiberado
GET /v1/card-portfolio HTTP/1.1 Authorization: Bearer <access_token> Accept: application/json{ "cartoes": [ { "idCartao": "c-8821", "numeroCartao": "**** **** **** 4412", "finalCartao": "4412", "nomePortador": "ILLUSTRATIVE CARDHOLDER", "imagemCartao": "<card-image-reference>", "valorLimiteTotal": 5000.0, "valorLimiteDisponivel": 1875.4, "vencimentoFaturaAberta": "2026-11-10", "valorFaturaAberta": 932.18, "contactless": true, "pixCartaoLiberado": true } ] }Read open invoice
GET
/v1/card-portfolio/{idCartao}/invoices/currentopenbankingReturns the current open fatura for a card: due date, total, minimum payment and whether fatura digital is on.
Auth: Bearer access_token from the illustrative cardholder session. sessao query is appended.
- idCartao
- idFatura
- openInvoice
- valorFaturaAberta
- vencimentoFaturaAberta
- invoiceValue
- invoiceDueDate
- valorMinimoPagamento
- valorPago
- faturaDigital
- digitalInvoiceStatus
GET /v1/card-portfolio/c-8821/invoices/current?sessao=<session-id> HTTP/1.1 Authorization: Bearer <access_token> Accept: application/json{ "idCartao": "c-8821", "idFatura": "fat-202611", "openInvoice": true, "valorFaturaAberta": 932.18, "vencimentoFaturaAberta": "2026-11-10", "invoiceValue": 932.18, "invoiceDueDate": "2026-11-10", "valorMinimoPagamento": 140.0, "valorPago": 0, "faturaDigital": true, "digitalInvoiceStatus": "ATIVA" }List closed invoices
GET
/v1/card-portfolio/{idCartao}/invoices/archiveopenbankingPages previously closed faturas with due date, amount paid and the payment transaction code used by Minhas Faturas.
Auth: Bearer access_token from the illustrative cardholder session.
- idFatura
- idInvoice
- closedInvoice
- invoiceValue
- invoiceDueDate
- dataVencimento
- valorPago
- dataPagamento
- codigoTransacaoPagamentoFatura
- pagina
- tamanhoPagina
GET /v1/card-portfolio/c-8821/invoices/archive?pagina=1&tamanhoPagina=20&sessao=<session-id> HTTP/1.1 Authorization: Bearer <access_token> Accept: application/json{ "closedInvoices": [ { "idFatura": "fat-202610", "idInvoice": "fat-202610", "closedInvoice": true, "invoiceValue": 1104.5, "invoiceDueDate": "2026-10-10", "dataVencimento": "2026-10-10", "valorPago": 1104.5, "dataPagamento": "2026-10-08", "codigoTransacaoPagamentoFatura": "pg-fat-4412" } ], "pagina": 1, "tamanhoPagina": 20 }Reveal card password
GET
/v1/card-portfolio/{idCartao}/pin/viewopenbankingReturns the plastic's PIN (senha) for the in-app password-view flow after OTP / password confirmation.
Auth: Bearer access_token from the illustrative cardholder session. The app gates this screen with card password / OTP (possuiGeradorOtpAtivo) before calling.
- idCartao
- finalCartao
- numeroCartao
- senha
- possuiGeradorOtpAtivo
GET /v1/card-portfolio/c-8821/pin/view HTTP/1.1 Authorization: Bearer <access_token> Accept: application/json{ "idCartao": "c-8821", "finalCartao": "4412", "numeroCartao": "**** **** **** 4412", "senha": "<illustrative-pin>", "possuiGeradorOtpAtivo": true }Read card credit limits
GET
/v1/card-portfolio/credit-capacityopenbankingReturns total, available, installment and cash-out (saque) limits shown on Meus Limites.
Auth: Bearer access_token from the illustrative cardholder session.
- idCartao
- valorLimiteTotal
- valLimiteTotal
- valorLimiteDisponivel
- valorLimiteParceladoDisponivel
- valorLimiteSaqueDisponivel
- valorLimiteSaqueParcDisponivel
- cardWithdrawalLimitAvailable
GET /v1/card-portfolio/credit-capacity HTTP/1.1 Authorization: Bearer <access_token> Accept: application/json{ "idCartao": "c-8821", "valorLimiteTotal": 5000.0, "valLimiteTotal": 5000.0, "valorLimiteDisponivel": 1875.4, "valorLimiteParceladoDisponivel": 2100.0, "valorLimiteSaqueDisponivel": 400.0, "valorLimiteSaqueParcDisponivel": 250.0, "cardWithdrawalLimitAvailable": 400.0 }Read CredzConta balance
GET
/v1/cash-account/available-balanceopenfinanceReads the CredzConta digital-account cash balance shown as Saldo da CredzConta.
Auth: Bearer access_token from the illustrative cardholder session. sessao query is appended.
- saldo
- accountBalanceValue
- accountBalanceCurrencySymbol
- lastDateGetBalance
- sessao
GET /v1/cash-account/available-balance?sessao=<session-id> HTTP/1.1 Authorization: Bearer <access_token> Accept: application/json{ "saldo": 352.9, "accountBalanceValue": 352.9, "accountBalanceCurrencySymbol": "R$", "lastDateGetBalance": "2026-10-26T18:01:00Z" }List CredzConta statement
GET
/v1/cash-account/ledger-entriesopenfinancePages CredzConta ledger lines (Pix, boleto cash-in, card cash-in) with amount, timestamp and endToEndId.
Auth: Bearer access_token from the illustrative cardholder session. sessao query is appended.
- idTransacao
- codigoTransacao
- tipoTransacao
- descricaoTransacao
- valorTransacao
- dataHoraTransacao
- endToEndId
- documentoDestinatario
- agenciaDestinatario
GET /v1/cash-account/ledger-entries?sessao=<session-id> HTTP/1.1 Authorization: Bearer <access_token> Accept: application/json{ "transacoes": [ { "idTransacao": "tx-90112", "codigoTransacao": "pix-90112", "tipoTransacao": "PIX", "descricaoTransacao": "Pix enviado", "valorTransacao": 80.0, "dataHoraTransacao": "2026-10-25T14:22:11Z", "endToEndId": "E12345678202610251422abcd", "documentoDestinatario": "<recipient-cpf>", "agenciaDestinatario": "0001" } ] }List Pix keys
GET
/v1/pix-directory/registered-keysopenfinanceLists Pix keys registered on CredzConta (CPF, phone, email, random) for receive and portability screens.
Auth: Bearer access_token from the illustrative cardholder session. sessao query is appended.
- chave
- tipoChave
- nomeChave
- nomeChavePix
- cpf
- sessao
GET /v1/pix-directory/registered-keys?sessao=<session-id> HTTP/1.1 Authorization: Bearer <access_token> Accept: application/json{ "chaves": [ { "chave": "<holder-cpf>", "tipoChave": "CPF", "nomeChave": "CPF", "nomeChavePix": "ILLUSTRATIVE CARDHOLDER", "cpf": "<holder-cpf>" }, { "chave": "<holder-phone>", "tipoChave": "PHONE", "nomeChave": "Celular", "nomeChavePix": "ILLUSTRATIVE CARDHOLDER" } ] }Read Pix limits
GET
/v1/pix-controls/transfer-capsopenfinanceReturns day/night Pix caps for persons and companies plus used-versus-available amounts on Ajustar Limites.
Auth: Bearer access_token from the illustrative cardholder session.
- valorLimiteDiarioTransferencia
- valorLimiteMensalTransferencia
- valorLimiteNoturnoTransferencia
- limitePixPessoaDiurnoMax
- limitePixPessoaNoturnoMax
- limitePixEmpresaDiurnoMax
- limitePixEmpresaNoturnoMax
- valorDiarioUtilizado
- valorMensalUtilizado
GET /v1/pix-controls/transfer-caps?session=<session-id> HTTP/1.1 Authorization: Bearer <access_token> Accept: application/json{ "valorLimiteDiarioTransferencia": 5000.0, "valorLimiteMensalTransferencia": 20000.0, "valorLimiteNoturnoTransferencia": 1000.0, "limitePixPessoaDiurnoMax": 5000.0, "limitePixPessoaNoturnoMax": 1000.0, "limitePixEmpresaDiurnoMax": 15000.0, "limitePixEmpresaNoturnoMax": 3000.0, "valorDiarioUtilizado": 80.0, "valorMensalUtilizado": 430.0 }Decode Pix QR code
POST
/v1/pix-payments/qr/interpretopenfinanceDecodes a static or dynamic Pix EMV payload into payee key, amount and institution before the pay-QR confirm screen.
Auth: Bearer access_token from the illustrative cardholder session.
- qrCode
- tipoQrCode
- chave
- valor
- nomeInstituicao
- idInstituicao
- documentoDestinatario
- endToEndId
- permiteAlterarValor
POST /v1/pix-payments/qr/interpret HTTP/1.1 Authorization: Bearer <access_token> Content-Type: application/json { "qrCode": "<illustrative-pix-qr-payload>", "tipoQrCode": "EMV" }{ "tipoQrCode": "ESTATICO", "chave": "<recipient-pix-key>", "valor": 129.9, "nomeInstituicao": "BANCO EXEMPLO S.A.", "idInstituicao": "00000000", "documentoDestinatario": "<recipient-document>", "endToEndId": null, "permiteAlterarValor": false }Issue virtual-card security codes
POST
/v1/virtual-credentials/security-code/issueopenbankingMints a rotating CVV (securityCode) and masked PAN for the Credz virtual card used in online checkout.
Auth: Bearer access_token from the illustrative cardholder session. The app confirms with card password before this call.
- virtualCardId
- idCartao
- numeroCartao
- securityCode
- pan
- expiracaoCodigoSegundos
POST /v1/virtual-credentials/security-code/issue HTTP/1.1 Authorization: Bearer <access_token> Content-Type: application/json { "virtualCardId": "vc-4412", "idCartao": "c-8821" }{ "virtualCardId": "vc-4412", "idCartao": "c-8821", "numeroCartao": "5465 00** **** 4412", "securityCode": "<illustrative-cvv>", "pan": "546500******4412", "expiracaoCodigoSegundos": 60 }List acquired insurances
GET
/v1/member/policy-subscriptionsopendataLists insurance products attached to the cardholder (e.g. pet) with installment amount and due date.
Auth: Bearer access_token from the illustrative cardholder session. holderDocument query selects the portador.
- holderDocument
- holderName
- codigo
- status
- valorParcela
- dataVencimento
GET /v1/member/policy-subscriptions?holderDocument=<holder-cpf> HTTP/1.1 Authorization: Bearer <access_token> Accept: application/json{ "holderDocument": "<holder-cpf>", "seguros": [ { "codigo": "PET-FRIEND", "holderName": "ILLUSTRATIVE CARDHOLDER", "status": "ATIVO", "valorParcela": 19.9, "dataVencimento": "2026-11-10" } ] }
Data categories
- cardholder profile
- credit-card invoices
- credit limits
- card PIN
- Pix keys
- Pix QR payloads
- digital account balance
- digital account statement
- virtual card CVV
- acquired insurance
Where teams use this data
Invoice ops reconciliation
A card-issuer ops bot pulls valorFaturaAberta, vencimentoFaturaAberta and valorPago per idCartao each morning and flags open invoices that passed invoiceDueDate still unpaid.
Pix treasury dashboard
Treasury software lists chave / tipoChave on CredzConta, watches saldo and accountBalanceValue, and matches outbound Pix by endToEndId against the extrato.
Limit and nocturnal-cap monitor
Risk tools subscribe to valorLimiteDisponivel versus valorLimiteTotal and the Pix day/night caps (limitePixPessoaDiurnoMax, valorLimiteNoturnoTransferencia) so a spent-down book surfaces before authorization declines.
Virtual-card checkout assist
A travel or marketplace checkout pulls numeroCartao plus the rotating securityCode (and expiracaoCodigoSegundos) instead of asking the holder to read the CVV off the virtual-card screen.
Frequently asked questions
What invoice fields are included in the Credz data API examples?
Open invoices include valorFaturaAberta, vencimentoFaturaAberta, invoiceValue, invoiceDueDate, valorMinimoPagamento, valorPago and digitalInvoiceStatus. Closed-invoice records add dataPagamento and codigoTransacaoPagamentoFatura, with idFatura identifying the bill.
How is cardholder authentication represented?
The session example exchanges a CPF username and password using grant_type=password, client_id and scope=openid for an access_token. Protected examples retain Authorization: Bearer authentication, and the relevant profile, invoice and CredzConta requests include a sessao parameter. All credentials shown are placeholders.
Which CredzConta and Pix fields can support reconciliation?
Balance snapshots use saldo and accountBalanceValue. Statement lines include valorTransacao, dataHoraTransacao and endToEndId, while registered Pix keys use chave, tipoChave and nomeChavePix. Transfer-cap records distinguish personal and business day/night limits and report daily and monthly usage.
What do the virtual-card security-code examples contain?
They show virtualCardId, idCartao, masked numeroCartao and pan values, plus securityCode and expiracaoCodigoSegundos for the rotating CVV and its validity window. The cardholder confirms with the card password before that flow; the sample security code is only a placeholder.
Apps similar to Credz
- Cartão Carrefour: Crédito e + — Banco CSF S/A'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, request additional cards, and use Open Finance, with exclusive conditions at Carrefour, Atacadão and Sam's Club.
- Cartão Magalu — Itaú Unibanco's Cartão Magalu app manages Magalu and Luiza store credit cards with Magalu cashback, fatura pay and renegotiation, and temporary or recurring virtual cards for online shopping.
- BrasilCard Cliente — BrasilCard Cliente is BrasilCard's cardholder app for tracking invoices and live purchases, generating a barcode to pay the fatura, unblocking the card and changing the due date, and requesting a duplicate or debt negotiation.
- Cartão Mais! — Cred-System's Cartão Mais app shows card limits and transaction history, helps control spending, and lists the card's promotions and partnerships.
- Trigg: Cartão de crédito — Trigg is DMCARD SA's digital credit-card app with themed plastics, cashback that can discount the bill or go to donations, a virtual card released after approval for online purchases, and NFC payments.
- FortBrasil: Cartão de crédito — FortBrasil is DMCARD SA's cardholder app for checking invoices and available limit, blocking or unblocking the card, changing the due date, reviewing a limit increase, and topping up a mobile phone.
- Nubank — Nubank's Brazilian app combines a free NuConta, a no-annual-fee international credit card, free unlimited Pix around the clock, loans, investments from R$1, life insurance and cashback.
- Cartões CAIXA — Cartões CAIXA is Caixa Econômica Federal's app for CAIXA credit cards, covering limit and up to 40 latest faturas, PDF invoices, on/off for purchases and withdrawals, virtual-card limits, CAIXA Points, invoice installments and a digitizable payment line.
Topics
- credz data api
- credz fatura
- credzconta pix
- credz virtual card
- dmcard credz
- credz limite
- pix chave credz
- brazil card invoice data
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