API Cartões de Crédito

GET /baas/v1/open/dat/credit-cards-accounts/accounts

Obtém a lista de contas de pagamento pós-paga mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento.

Permission necessária: CREDIT_CARDS_ACCOUNTS_READ

Parâmetros de query

Parâmetro	Tipo	Descrição
`page`	integer	Número da página requisitada (primeira página = 1). Default: 1.
`page-size`	integer	Quantidade de registros por página. Default: 25. Máximo: 1000.
`pagination-key`	string	Identificador de rechamada para evitar contagem dupla durante paginação.

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "creditCardAccountId": "XXZTR3459087",
      "brandName": "Organização A",
      "companyCnpj": "21128159000166",
      "name": "Cartão Universitário",
      "productType": "OUTROS",
      "productAdditionalInfo": "OURO_INTERNACIONAL",
      "creditCardNetwork": "VISA",
      "networkAdditionalInfo": "AURA CARD"
    }
  ],
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v2/resource",
    "first": "https://api.banco.com.br/open-banking/api/v2/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v2/resource",
    "next": "https://api.banco.com.br/open-banking/api/v2/resource",
    "last": "https://api.banco.com.br/open-banking/api/v2/resource"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

data[].creditCardAccountId: Identificador único e imutável da conta de pagamento pós-paga do cliente na instituição transmissora.
data[].brandName: Nome da marca reportada pelo participante no Open Finance. Preferencialmente o mesmo nome atribuído no diretório Customer Friendly Server Name.
data[].companyCnpj: CNPJ completo da instituição responsável pelo cadastro (sem máscara).
data[].name: Denominação/identificação do nome da conta de pagamento pós-paga (cartão).
data[].productType: Categoria do cartão de pagamento. Enum: CLASSIC_NACIONAL, CLASSIC_INTERNACIONAL, GOLD, PLATINUM, INFINITE, ELECTRON, STANDARD_NACIONAL, STANDARD_INTERNACIONAL, ELETRONIC, BLACK, REDESHOP, MAESTRO_MASTERCARD_MAESTRO, GREEN, BLUE, BLUEBOX, PROFISSIONAL_LIBERAL, CHEQUE_ELETRONICO, CORPORATIVO, EMPRESARIAL, COMPRAS, BASICO_NACIONAL, BASICO_INTERNACIONAL, NANQUIM, GRAFITE, MAIS, OUTROS.
data[].productAdditionalInfo: Informações complementares quando productType for OUTROS.
data[].creditCardNetwork: Bandeira do cartão de crédito (instituidor do arranjo de pagamento). Enum: VISA, MASTERCARD, AMERICAN_EXPRESS, DINERS_CLUB, HIPERCARD, BANDEIRA_PROPRIA, CHEQUE_ELETRONICO, ELO, OUTRAS.
data[].networkAdditionalInfo: Texto livre para especificar a bandeira quando creditCardNetwork for OUTRAS.
links.self: URI completa que gerou a resposta atual.
links.first: URI da primeira página. Obrigatório quando não for a primeira página.
links.prev: URI da página anterior. Obrigatório quando não for a primeira página.
links.next: URI da próxima página. Obrigatório quando não for a última página.
links.last: URI da última página. Obrigatório quando não for a última página.
meta.totalRecords: Número total de registros no resultado.
meta.totalPages: Número total de páginas no resultado.
meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.

GET /baas/v1/open/dat/credit-cards-accounts/accounts/{creditCardAccountId}

Obtém os dados de identificação da conta de pagamento pós-paga identificada por creditCardAccountId.

Permission necessária: CREDIT_CARDS_ACCOUNTS_READ

Parâmetros de path

Parâmetro	Tipo	Descrição
`creditCardAccountId`	string	Identificador único da conta de pagamento pós-paga.

Exemplo de resposta (200 OK)

{
  "data": {
    "name": "Cartão Universitário",
    "productType": "OUTROS",
    "productAdditionalInfo": "OURO_INTERNACIONAL",
    "creditCardNetwork": "VISA",
    "networkAdditionalInfo": "AURA CARD",
    "paymentMethod": [
      {
        "identificationNumber": "4453",
        "isMultipleCreditCard": true
      }
    ]
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v2/resource",
    "first": "https://api.banco.com.br/open-banking/api/v2/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v2/resource",
    "next": "https://api.banco.com.br/open-banking/api/v2/resource",
    "last": "https://api.banco.com.br/open-banking/api/v2/resource"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

data.name: Denominação/identificação do nome da conta de pagamento pós-paga (cartão).
data.productType: Categoria do cartão de pagamento (ver enum completo em GET /accounts).
data.productAdditionalInfo: Informações complementares quando productType for OUTROS.
data.creditCardNetwork: Bandeira do cartão de crédito (ver enum completo em GET /accounts).
data.networkAdditionalInfo: Texto livre para especificar a bandeira quando creditCardNetwork for OUTRAS.
data.paymentMethod[]: Lista de cartões (virtual/adicional/titular) associados à conta. Pode ser vazia em cenários como: conta com métodos cancelados, conta nova sem emissão, cartão no-name, conta bloqueada por furto/roubo/perda, conta suspensa, conta inativa ou conta em análise.
data.paymentMethod[].identificationNumber: Número de identificação do cartão. Para PF: 4 últimos dígitos. Para PJ: identificador conforme regras do Open Finance.
data.paymentMethod[].isMultipleCreditCard: Indica se o cartão é múltiplo (true), ou seja, possui função crédito e débito.
links: Links de navegação entre páginas (ver descrição em GET /accounts).
meta.totalRecords: Número total de registros no resultado.
meta.totalPages: Número total de páginas no resultado.
meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.

GET /baas/v1/open/dat/credit-cards-accounts/accounts/{creditCardAccountId}/bills

Obtém a lista de faturas da conta de pagamento pós-paga identificada por creditCardAccountId. Somente faturas já fechadas devem ser informadas. Qualquer pagamento deve ser contado para a última fatura fechada.

Permission necessária: CREDIT_CARDS_ACCOUNTS_BILLS_READ

Parâmetros de path

Parâmetro	Tipo	Descrição
`creditCardAccountId`	string	Identificador único da conta de pagamento pós-paga.

Parâmetros de query

Parâmetro	Tipo	Descrição
`page`	integer	Número da página requisitada (primeira página = 1). Default: 1.
`page-size`	integer	Quantidade de registros por página. Default: 25. Máximo: 1000.
`pagination-key`	string	Identificador de rechamada para evitar contagem dupla durante paginação.
`fromDueDate`	date	Data inicial de filtragem pelo vencimento da fatura (`YYYY-MM-DD`).
`toDueDate`	date	Data final de filtragem pelo vencimento da fatura (`YYYY-MM-DD`).

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "billId": "3459087XXZTR",
      "dueDate": "2021-05-21",
      "billClosingDate": "2021-05-21",
      "billTotalAmount": {
        "amount": "1000.0400",
        "currency": "BRL"
      },
      "billMinimumAmount": {
        "amount": "1000.0400",
        "currency": "BRL"
      },
      "isInstalment": false,
      "financeCharges": [
        {
          "type": "JUROS_REMUNERATORIOS_ATRASO_PAGAMENTO_FATURA",
          "additionalInfo": "Informações Adicionais",
          "amount": "100000.0400",
          "currency": "BRL"
        }
      ],
      "payments": [
        {
          "valueType": "VALOR_PAGAMENTO_FATURA_REALIZADO",
          "paymentDate": "2021-05-21",
          "paymentMode": "PIX",
          "amount": "1000.0400",
          "currency": "BRL"
        }
      ]
    }
  ],
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v2/resource",
    "first": "https://api.banco.com.br/open-banking/api/v2/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v2/resource",
    "next": "https://api.banco.com.br/open-banking/api/v2/resource",
    "last": "https://api.banco.com.br/open-banking/api/v2/resource"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

data[].billId: Código único e imutável que identifica a fatura.
data[].dueDate: Data de vencimento da fatura exibida para pagamento pelo cliente (YYYY-MM-DD).
data[].billClosingDate: Data de fechamento da fatura (YYYY-MM-DD).
data[].billTotalAmount.amount: Valor total da fatura. Positivo para saldo devedor, negativo para saldo credor. Com 2 a 4 casas decimais.
data[].billTotalAmount.currency: Moeda no padrão ISO-4217 (ex: BRL).
data[].billMinimumAmount.amount: Valor do pagamento mínimo da fatura. Com 2 a 4 casas decimais.
data[].billMinimumAmount.currency: Moeda no padrão ISO-4217 (ex: BRL).
data[].isInstalment: Indica se a fatura permite parcelamento (true) ou não (false).
data[].financeCharges[]: Lista de encargos cobrados na fatura.
data[].financeCharges[].type: Tipo do encargo. Enum: JUROS_REMUNERATORIOS_ATRASO_PAGAMENTO_FATURA, MULTA_ATRASO_PAGAMENTO_FATURA, JUROS_MORA_ATRASO_PAGAMENTO_FATURA, IOF, OUTROS.
data[].financeCharges[].additionalInfo: Campo livre, obrigatório quando type for OUTROS.
data[].financeCharges[].amount: Valor cobrado pelo encargo. Com 2 a 4 casas decimais.
data[].financeCharges[].currency: Moeda do encargo no padrão ISO-4217.
data[].payments[]: Lista de pagamentos realizados na fatura. Pagamentos após o fechamento de uma fatura e antes do próximo fechamento ficam registrados na fatura corrente fechada.
data[].payments[].valueType: Tipo do valor do pagamento. Enum: VALOR_PAGAMENTO_FATURA_PARCELADO (fato gerador do parcelamento da fatura), VALOR_PAGAMENTO_FATURA_REALIZADO (pagamento total da fatura), OUTRO_VALOR_PAGO_FATURA (demais casos).
data[].payments[].paymentDate: Data efetiva do pagamento da fatura (YYYY-MM-DD).
data[].payments[].paymentMode: Forma de efetivação do pagamento. Enum: DEBITO_CONTA_CORRENTE, BOLETO_BANCARIO, AVERBACAO_FOLHA, PIX.
data[].payments[].amount: Valor pago conforme o valueType. Não pode ser negativo. Com 2 a 4 casas decimais.
data[].payments[].currency: Moeda do pagamento no padrão ISO-4217.
links: Links de navegação entre páginas (ver descrição em GET /accounts).
meta.totalRecords: Número total de registros no resultado.
meta.totalPages: Número total de páginas no resultado.
meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.

GET /baas/v1/open/dat/credit-cards-accounts/accounts/{creditCardAccountId}/bills/{billId}/transactions

Obtém a lista de transações da conta de pagamento pós-paga identificada por creditCardAccountId e billId. Retorna somente transações após conciliação.

Permission necessária: CREDIT_CARDS_ACCOUNTS_BILLS_TRANSACTIONS_READ

Parâmetros de path

Parâmetro	Tipo	Descrição
`creditCardAccountId`	string	Identificador único da conta de pagamento pós-paga.
`billId`	string	Identificador único da fatura.

Parâmetros de query

Parâmetro	Tipo	Descrição
`page`	integer	Número da página requisitada (primeira página = 1). Default: 1.
`page-size`	integer	Quantidade de registros por página. Default: 25. Máximo: 1000.
`pagination-key`	string	Identificador de rechamada para evitar contagem dupla durante paginação.
`fromTransactionDate`	date	Data inicial de filtragem pelo `transactionDateTime` (`YYYY-MM-DD`). Obrigatório se `toTransactionDate` for informado.
`toTransactionDate`	date	Data final de filtragem pelo `transactionDateTime` (`YYYY-MM-DD`). Obrigatório se `fromTransactionDate` for informado. Se não informado, retorna todas as transações da fatura.
`transactionType`	string	Filtro pelo tipo de transação.
`payeeMCC`	integer	Filtro pelo MCC do estabelecimento comercial.

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "transactionId": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl",
      "identificationNumber": "4453",
      "transactionName": "PGTO",
      "billId": "MTU0OTU1NjI2NTk4OTRmc2ZhZDRmc2Q1NmZkM",
      "creditDebitType": "DEBITO",
      "transactionType": "PAGAMENTO",
      "transactionalAdditionalInfo": "string",
      "paymentType": "A_VISTA",
      "feeType": "ANUIDADE",
      "feeTypeAdditionalInfo": "string",
      "otherCreditsType": "CREDITO_ROTATIVO",
      "otherCreditsAdditionalInfo": "string",
      "chargeIdentificator": 12,
      "chargeNumber": 12,
      "brazilianAmount": {
        "amount": "1000.0400",
        "currency": "BRL"
      },
      "amount": {
        "amount": "1000.0400",
        "currency": "BRL"
      },
      "transactionDateTime": "2016-01-29T12:29:03.374Z",
      "billPostDate": "2021-05-21",
      "payeeMCC": 5137
    }
  ],
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v2/resource",
    "first": "https://api.banco.com.br/open-banking/api/v2/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v2/resource",
    "next": "https://api.banco.com.br/open-banking/api/v2/resource",
    "last": "https://api.banco.com.br/open-banking/api/v2/resource"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

data[].transactionId: Código ou identificador único, imutável e estável prestado pela instituição para representar a transação individual.
data[].identificationNumber: Número de identificação do cartão. Para PF: 4 últimos dígitos. Para PJ: identificador conforme regras do Open Finance.
data[].transactionName: Literal usada pela instituição para identificar a transação. Deve ser a mesma exibida nos canais eletrônicos (extrato e fatura).
data[].billId: Código único e imutável da fatura onde consta a transação. Preenchido apenas para transações em fatura fechada.
data[].creditDebitType: Indicador do tipo de lançamento. Enum: CREDITO, DEBITO.
data[].transactionType: Tipo da transação. Enum: PAGAMENTO, PAGAMENTO_FATURA, TARIFA, OPERACOES_CREDITO_CONTRATADAS_CARTAO, ESTORNO, CASHBACK, OUTROS. O tipo PAGAMENTO_FATURA cobre pagamentos parciais ou totais de fatura.
data[].transactionalAdditionalInfo: Campo livre, obrigatório quando transactionType for OUTROS.
data[].paymentType: Tipo de pagamento. Obrigatório quando transactionType for PAGAMENTO. Enum: A_VISTA, A_PRAZO.
data[].feeType: Tipo de tarifa. Obrigatório quando transactionType for TARIFA. Enum: ANUIDADE, SAQUE_CARTAO_BRASIL, SAQUE_CARTAO_EXTERIOR, AVALIACAO_EMERGENCIAL_CREDITO, EMISSAO_SEGUNDA_VIA, TARIFA_PAGAMENTO_CONTAS, SMS, OUTRA.
data[].feeTypeAdditionalInfo: Campo livre, obrigatório quando feeType for OUTRA.
data[].otherCreditsType: Outros tipos de crédito contratados no cartão. Obrigatório quando transactionType for OPERACOES_CREDITO_CONTRATADAS_CARTAO. Enum: CREDITO_ROTATIVO, PARCELAMENTO_FATURA, EMPRESTIMO, OUTROS.
data[].otherCreditsAdditionalInfo: Campo livre, obrigatório quando otherCreditsType for OUTROS.
data[].chargeIdentificator: Número da parcela sendo informada (1–999). Obrigatório quando paymentType for A_PRAZO.
data[].chargeNumber: Quantidade total de parcelas (1–999). Obrigatório quando houver parcelas relacionadas à transação.
data[].brazilianAmount.amount: Valor da transação em BRL. Para compras internacionais, é o valor convertido. Para nacionais, igual ao amount. Com 2 a 4 casas decimais.
data[].brazilianAmount.currency: Moeda no padrão ISO-4217 (sempre BRL).
data[].amount.amount: Valor original da transação na moeda de origem, sem conversão. Para parceladas, corresponde ao valor da parcela. Com 2 a 4 casas decimais.
data[].amount.currency: Moeda original da transação no padrão ISO-4217.
data[].transactionDateTime: Data e hora da transação no formato RFC-3339 com milissegundos (ex: 2024-01-29T11:15:00.000Z). Nas compras parceladas, deve ser idêntico em todas as parcelas.
data[].billPostDate: Data em que a transação foi inserida na fatura (YYYY-MM-DD).
data[].payeeMCC: Código MCC do estabelecimento comercial. Obrigatório quando transactionType for PAGAMENTO.
links: Links de navegação entre páginas (ver descrição em GET /accounts).
meta.totalRecords: Número total de registros no resultado.
meta.totalPages: Número total de páginas no resultado.
meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.

GET /baas/v1/open/dat/credit-cards-accounts/accounts/{creditCardAccountId}/limits

Obtém os limites da conta de pagamento pós-paga identificada por creditCardAccountId.

Permission necessária: CREDIT_CARDS_ACCOUNTS_LIMITS_READ

Parâmetros de path

Parâmetro	Tipo	Descrição
`creditCardAccountId`	string	Identificador único da conta de pagamento pós-paga.

Orientações sobre a lista de limites:

Lista vazia = ausência da informação.

Limite zerado deve ter registro explícito com valor 0.

Cartão sem limite predefinido ("limite flexível") deve ter isLimitFlexible = true.

Limites globais (compartilhados entre todos os cartões) usam consolidationType = CONSOLIDADO.

Limites segregados por cartão usam consolidationType = INDIVIDUAL.

Cartões virtuais só aparecem com INDIVIDUAL quando o limite for segregado.

Conta cartão cancelada deve retornar lista vazia.

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "creditLineLimitType": "LIMITE_CREDITO_TOTAL",
      "consolidationType": "CONSOLIDADO",
      "identificationNumber": "4453",
      "lineName": "CREDITO_A_VISTA",
      "lineNameAdditionalInfo": "Informações adicionais e complementares.",
      "isLimitFlexible": true,
      "limitAmount": {
        "amount": "1000.0400",
        "currency": "BRL",
        "limitAmountReason": "O perfil do cliente passou por uma análise e o limite precisou ser zerado"
      },
      "usedAmount": {
        "amount": "1000.0400",
        "currency": "BRL"
      },
      "availableAmount": {
        "amount": "1000.0400",
        "currency": "BRL"
      },
      "customizedLimitAmount": {
        "amount": "1000.0400",
        "currency": "BRL"
      }
    }
  ],
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v2/resource",
    "first": "https://api.banco.com.br/open-banking/api/v2/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v2/resource",
    "next": "https://api.banco.com.br/open-banking/api/v2/resource",
    "last": "https://api.banco.com.br/open-banking/api/v2/resource"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

data[].creditLineLimitType: Tipo do limite. Enum: LIMITE_CREDITO_TOTAL (limite total da conta cartão), LIMITE_CREDITO_MODALIDADE_OPERACAO (limite por modalidade de operação).
data[].consolidationType: Indicador de consolidação do limite. Enum: CONSOLIDADO (limite compartilhado entre todos os métodos de pagamento), INDIVIDUAL (limite segregado por método de pagamento).
data[].identificationNumber: Número de identificação do cartão. Para PF: 4 últimos dígitos. Para PJ: identificador conforme regras do Open Finance.
data[].lineName: Modalidade de operação do limite. Enum: CREDITO_A_VISTA, CREDITO_PARCELADO, SAQUE_CREDITO_BRASIL, SAQUE_CREDITO_EXTERIOR, EMPRESTIMO_CARTAO_CONSIGNADO, OUTROS.
data[].lineNameAdditionalInfo: Campo livre, obrigatório quando lineName for OUTRAS.
data[].isLimitFlexible: true = limite total flexível ou sem limite predefinido. false = limite predeterminado exibido ao cliente.
data[].limitAmount.amount: Valor total do limite concedido. Com 2 a 4 casas decimais. Obrigatório quando isLimitFlexible = false.
data[].limitAmount.currency: Moeda no padrão ISO-4217. Obrigatório quando isLimitFlexible = false.
data[].limitAmount.limitAmountReason: Razão pelo qual o limite está zerado. Obrigatório quando limitAmount = 0.00.
data[].usedAmount.amount: Valor utilizado do limite. Limites extras contratados e usados são somados neste campo. Pode ser maior que o limitAmount quando há uso de limites extras. Com 2 a 4 casas decimais.
data[].usedAmount.currency: Moeda no padrão ISO-4217.
data[].availableAmount.amount: Valor disponível do limite. Com 2 a 4 casas decimais. Obrigatório quando isLimitFlexible = false.
data[].availableAmount.currency: Moeda no padrão ISO-4217. Obrigatório quando isLimitFlexible = false.
data[].customizedLimitAmount.amount: Valor total do limite customizado pelo cliente nos canais eletrônicos. Obrigatório quando a instituição permite que o cliente altere seu limite. Com 2 a 4 casas decimais.
data[].customizedLimitAmount.currency: Moeda no padrão ISO-4217.
links: Links de navegação entre páginas (ver descrição em GET /accounts).
meta.totalRecords: Número total de registros no resultado.
meta.totalPages: Número total de páginas no resultado.
meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.