Credz 持卡人、账单与 Pix 数据 API

DMCARD SA · 银行 4.3 ★

Credz 是 DMCARD SA 面向巴西 CREDZ 持卡人推出的应用，把信用卡与 CredzConta 账户管理收进葡萄牙语界面。用户以 CPF 加密码登录后，可查看信用额度、未结与历史账单、卡片密码，并为线上购物获取虚拟卡随时轮换的安全码。CredzConta 在此之上提供余额与流水查看、Pix 密钥、二维码支付以及可调整的转账额度，同时展示持卡人已购买的保险产品。该应用在 Google Play 上评分 4.3，约有 15.7 万条评价。

未结账单余额由 valorFaturaAberta 与 vencimentoFaturaAberta 成对给出，idCartao 与 idFatura 把一张账单连到它所属的卡片和还款记录；已结账单再补上 valorPago、dataPagamento 与 codigoTransacaoPagamentoFatura，而信用额度则单独由 valorLimiteTotal、valorLimiteDisponivel 以及分期与取现额度表示。

CredzConta 流水把 valorTransacao 挂在 dataHoraTransacao 与 endToEndId 上，余额快照则在 saldo 和 accountBalanceValue 中；Pix 密钥目录使用 chave 与 tipoChave，转账限额区分 limitePixPessoaDiurnoMax 与 valorLimiteNoturnoTransferencia。这些字段可支撑账单运营对账、Pix 资金看板与信用额度监控；在获得授权的前提下，结账集成还可以使用 virtualCardId、securityCode 和 expiracaoCodigoSegundos 处理限时有效的虚拟卡凭据。openData Studio 把这些记录做成可调用的开放数据；下方示例使用示意路径与模拟值，并非真实的服务地址。

应用截图

API 端点一览

以下端点与请求/响应示例均依据应用界面推导重构，为示意说明，并非实际抓包。

签发 IdentityServer 访问令牌
POST /v1/cardholder-sessions/create opendata
用持卡人的 CPF 与密码换取 IdentityServer 的 access_token，持卡人、账单、Pix 与 CredzConta 的各项调用都以它为准入凭证。
认证方式：无需令牌。以 CPF 作为用户名加密码，配合 grant_type=password、client_id 与 scope=openid 换取 access_token；之后的调用携带 Authorization: Bearer，持卡人与数字账户相关路由还会附带 sessao 查询参数。
- 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"
}
```

读取持卡人资料

GET /v1/member/profile osint

返回已登录的 portador（持卡人）记录：姓名、CPF/documento、holderStatus 以及电子账单的联系渠道。

认证方式：使用示意性持卡人会话中的 Bearer access_token；该路由会附加 sessao 查询参数。

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>"
}

列出持卡人卡片

GET /v1/card-portfolio openbanking

列出持卡人的实体卡与虚拟卡，含卡号末四位、可用/总额度，以及首页卡片轮播里显示的未结账单快照。

认证方式：使用示意性持卡人会话中的 Bearer access_token。

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
    }
  ]
}

读取未结账单
GET /v1/card-portfolio/{idCartao}/invoices/current openbanking
返回某张卡当前未结的 fatura（账单）：到期日、总额、最低还款额，以及是否开通电子账单（fatura digital）。
认证方式：使用示意性持卡人会话中的 Bearer access_token；会附加 sessao 查询参数。
- 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"
}
```

列出已结账单

GET /v1/card-portfolio/{idCartao}/invoices/archive openbanking

分页返回历史已结 fatura，含到期日、已还金额以及 Minhas Faturas 页面使用的还款交易编码。

认证方式：使用示意性持卡人会话中的 Bearer access_token。

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
}

查看卡片密码
GET /v1/card-portfolio/{idCartao}/pin/view openbanking
在 OTP / 密码确认后，为应用内查看密码的流程返回塑料卡的 PIN（senha）。
认证方式：使用示意性持卡人会话中的 Bearer access_token；应用在调用前会先用卡片密码 / OTP（possuiGeradorOtpAtivo）把关该页面。
- 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
}
```
读取卡片信用额度
GET /v1/card-portfolio/credit-capacity openbanking
返回 Meus Limites 页面展示的总额度、可用额度、分期额度和取现（saque）额度。
认证方式：使用示意性持卡人会话中的 Bearer access_token。
- 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
}
```
读取 CredzConta 余额
GET /v1/cash-account/available-balance openfinance
读取 CredzConta 数字账户的现金余额，对应界面上的「Saldo da CredzConta」。
认证方式：使用示意性持卡人会话中的 Bearer access_token；会附加 sessao 查询参数。
- 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"
}
```

列出 CredzConta 流水

GET /v1/cash-account/ledger-entries openfinance

分页返回 CredzConta 的账本流水行（Pix、boleto 入账、银行卡入账），含金额、时间戳和 endToEndId。

认证方式：使用示意性持卡人会话中的 Bearer access_token；会附加 sessao 查询参数。

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"
    }
  ]
}

列出 Pix 密钥

GET /v1/pix-directory/registered-keys openfinance

列出登记在 CredzConta 上的 Pix 密钥（CPF、手机号、邮箱、随机密钥），供收款与携号转移页面使用。

认证方式：使用示意性持卡人会话中的 Bearer access_token；会附加 sessao 查询参数。

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"
    }
  ]
}

读取 Pix 转账额度
GET /v1/pix-controls/transfer-caps openfinance
返回个人与企业的 Pix 日间/夜间上限，以及「Ajustar Limites」页面上已用与可用额度的对比。
认证方式：使用示意性持卡人会话中的 Bearer access_token。
- 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
}
```

解析 Pix 二维码

POST /v1/pix-payments/qr/interpret openfinance

在扫码支付确认页之前，把静态或动态的 Pix EMV 内容解析为收款密钥、金额与机构信息。

认证方式：使用示意性持卡人会话中的 Bearer access_token。

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
}

签发虚拟卡安全码

POST /v1/virtual-credentials/security-code/issue openbanking

为 Credz 虚拟卡生成用于线上结账的轮换 CVV（securityCode）与打码 PAN。

认证方式：使用示意性持卡人会话中的 Bearer access_token；应用在此调用前会先用卡片密码确认。

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
}

列出已购保险

GET /v1/member/policy-subscriptions opendata

列出挂在持卡人名下的保险产品（例如宠物险），含分期金额与到期日。

认证方式：使用示意性持卡人会话中的 Bearer access_token；holderDocument 查询参数用于选定持卡人（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"
    }
  ]
}

数据类别

持卡人资料
信用卡账单
信用额度
卡片密码
Pix 密钥
Pix 二维码内容
数字账户余额
数字账户流水
虚拟卡安全码
已购保险

数据使用场景与案例

账单运营对账
发卡机构的运营机器人每天早晨按 idCartao 拉取 valorFaturaAberta、vencimentoFaturaAberta 与 valorPago，并标出已超过 invoiceDueDate 仍未还款的未结账单。
Pix 资金看板
资金管理软件列出 CredzConta 上的 chave / tipoChave，监控 saldo 与 accountBalanceValue，并按 endToEndId 把对外发出的 Pix 与流水（extrato）逐笔匹配。
额度与夜间限额监控
风控工具对比 valorLimiteDisponivel 与 valorLimiteTotal，并跟踪 Pix 日间/夜间限额（limitePixPessoaDiurnoMax、valorLimiteNoturnoTransferencia），在授权被拒之前就发现额度已被用尽的账户。
虚拟卡结账辅助
旅行或电商结账页直接取 numeroCartao 与轮换的 securityCode（及 expiracaoCodigoSegundos），无需让持卡人从虚拟卡页面上自己抄读 CVV。

常见问题

Credz 数据 API 示例包含哪些账单字段？

未结账单包含 valorFaturaAberta、vencimentoFaturaAberta、invoiceValue、invoiceDueDate、valorMinimoPagamento、valorPago 与 digitalInvoiceStatus；已结账单记录再补上 dataPagamento 和 codigoTransacaoPagamentoFatura，并以 idFatura 标识具体账单。

持卡人鉴权是如何呈现的？

会话示例用 CPF 作为用户名加密码，配合 grant_type=password、client_id 与 scope=openid 换取 access_token。受保护的示例保留 Authorization: Bearer 鉴权，相关的资料、账单与 CredzConta 请求还会带上 sessao 参数。示例中的所有凭据均为占位值。

哪些 CredzConta 与 Pix 字段可用于对账？

余额快照使用 saldo 与 accountBalanceValue；流水行包含 valorTransacao、dataHoraTransacao 和 endToEndId；已登记的 Pix 密钥使用 chave、tipoChave 与 nomeChavePix。限额记录区分个人与企业的日间/夜间上限，并给出当日与当月的已用额度。

虚拟卡安全码示例包含什么内容？

示例包含 virtualCardId、idCartao、已打码的 numeroCartao 与 pan，以及代表轮换 CVV 及其有效期的 securityCode 和 expiracaoCodigoSegundos。该流程要求持卡人先用卡片密码确认；示例中的安全码仅为占位值。

与 Credz 相似的应用

Cartão Carrefour: Crédito e + — Banco CSF S/A 的 Cartão Carrefour 应用面向 Carrefour 商场信用卡持卡人，可查看可用与已用额度、实时跟踪消费、生成缴 fatura 的条码、申请附属卡，并使用 Open Finance，在 Carrefour、Atacadão 与 Sam's Club 享专属条件。
Cartão Magalu — Itaú Unibanco 的 Cartão Magalu 应用管理 Magalu 与 Luiza 商场信用卡，提供 Magalu 返现、fatura 缴纳与重组，以及用于网购的临时或周期虚拟卡。
BrasilCard Cliente — BrasilCard Cliente 是 BrasilCard 的持卡人应用，可查看账单与实时消费、生成缴 fatura 的条码、解锁卡片并改到期日，以及申请补卡或协商欠款。
Cartão Mais! — Cred-System 的 Cartão Mais 应用可查看卡片额度与交易记录、帮助控制支出，并列出示该卡的促销与合作商家。
Trigg: Cartão de crédito — Trigg 是 DMCARD SA 的数字信用卡应用，提供主题卡面、可抵账单或捐出的返现、审批通过后即可用于网购的虚拟卡，以及 NFC 闪付。
FortBrasil: Cartão de crédito — FortBrasil 是 DMCARD SA 的持卡人应用，可查询账单与可用额度、锁定或解锁卡片、更改到期日、查看提额，以及给手机充值。
Nubank — Nubank 的巴西应用在同一入口提供免费 NuConta、免年费国际信用卡、全天候不限额免费 Pix、贷款、从 1 雷亚尔起投的理财、人寿保险和返现。
Cartões CAIXA — Cartões CAIXA 是 Caixa Econômica Federal 管理 CAIXA 信用卡的应用，可查看额度与最多 40 期 fatura、下载 PDF 账单、开关消费与取现、设置虚拟卡额度、兑换 CAIXA Points、分期账单并生成可输付款码。

需要集成这个 App 的数据 API？

我们可为任意指定 App 交付定制集成——源码交付 USD 500 起，或托管 API 按调用计费。告诉我们您需要的数据即可。

每个项目均签 NDA 与 SOW
3–7 天交付
验收通过后才付款
仅在授权范围内作业

获取报价

Credz 持卡人、账单与 Pix 数据 API

应用截图

API 端点一览

签发 IdentityServer 访问令牌

读取持卡人资料

列出持卡人卡片

读取未结账单

列出已结账单

查看卡片密码

读取卡片信用额度

读取 CredzConta 余额

列出 CredzConta 流水

列出 Pix 密钥

读取 Pix 转账额度

解析 Pix 二维码

签发虚拟卡安全码

列出已购保险

数据类别

数据使用场景与案例

账单运营对账

Pix 资金看板

额度与夜间限额监控

虚拟卡结账辅助

常见问题

与 Credz 相似的应用

更多银行类应用

5paisa: Demat, Stocks & IPO

Ajaib: Stock, Crypto, US Stock

Albert: Budgeting and Banking

AndroMoney

相关主题

需要集成这个 App 的数据 API？

Credz 持卡人、账单与 Pix 数据 API

应用截图

API 端点一览

签发 IdentityServer 访问令牌

读取持卡人资料

列出持卡人卡片

读取未结账单

列出已结账单

查看卡片密码

读取卡片信用额度

读取 CredzConta 余额

列出 CredzConta 流水

列出 Pix 密钥

读取 Pix 转账额度

解析 Pix 二维码

签发虚拟卡安全码

列出已购保险

数据类别

数据使用场景与案例

账单运营对账

Pix 资金看板

额度与夜间限额监控

虚拟卡结账辅助

常见问题

相关应用

与 Credz 相似的应用

更多银行类应用

5paisa: Demat, Stocks & IPO

Ajaib: Stock, Crypto, US Stock

Albert: Budgeting and Banking

AndroMoney

相关主题

需要集成这个 App 的数据 API？