Returns detailed information about the columns available for a specific endpoint.
Usage
pix_columns(
endpoint = c("keys", "municipality", "stats", "fraud", "cnae", "dict_users")
)Value
A tibble::tibble with column names, types, and descriptions.
Examples
pix_columns("keys")
#> # A tibble: 6 × 3
#> column type description
#> <chr> <chr> <chr>
#> 1 Data character Reference date (YYYY-MM-DD, last day of month)
#> 2 ISPB character 8-digit code identifying the financial institution
#> 3 Nome character Name of the PIX participant (financial institution)
#> 4 NaturezaUsuario character User type: PF (Individual) or PJ (Legal Entity)
#> 5 TipoChave character Key type: CPF, CNPJ, Celular, e-mail, or Aleatória
#> 6 qtdChaves numeric Number of registered keys
pix_columns("municipality")
#> # A tibble: 19 × 3
#> column type description
#> <chr> <chr> <chr>
#> 1 AnoMes integer Reference year-month (YYYYMM format)
#> 2 Municipio_Ibge integer IBGE municipality code
#> 3 Municipio character Municipality name
#> 4 Estado_Ibge integer IBGE state code
#> 5 Estado character State name
#> 6 Sigla_Regiao character Region abbreviation (NE, SE, S, CO, N)
#> 7 Regiao character Region name
#> 8 VL_PagadorPF numeric Value paid by individuals (BRL)
#> 9 QT_PagadorPF numeric Count of transactions with individual payers
#> 10 VL_PagadorPJ numeric Value paid by legal entities (BRL)
#> 11 QT_PagadorPJ numeric Count of transactions with legal entity payers
#> 12 VL_RecebedorPF numeric Value received by individuals (BRL)
#> 13 QT_RecebedorPF numeric Count of transactions with individual receivers
#> 14 VL_RecebedorPJ numeric Value received by legal entities (BRL)
#> 15 QT_RecebedorPJ numeric Count of transactions with legal entity receive…
#> 16 QT_PES_PagadorPF numeric Distinct individual payers
#> 17 QT_PES_PagadorPJ numeric Distinct legal entity payers
#> 18 QT_PES_RecebedorPF numeric Distinct individual receivers
#> 19 QT_PES_RecebedorPJ numeric Distinct legal entity receivers
pix_columns("stats")
#> # A tibble: 12 × 3
#> column type description
#> <chr> <chr> <chr>
#> 1 AnoMes integer Reference year-month (YYYYMM format)
#> 2 PAG_PFPJ character Payer type: PF (Individual) or PJ (Legal Entity)
#> 3 REC_PFPJ character Receiver type: PF or PJ
#> 4 PAG_REGIAO character Payer region (NORTE, NORDESTE, SUDESTE, SUL, CENTRO…
#> 5 REC_REGIAO character Receiver region
#> 6 PAG_IDADE character Payer age group
#> 7 REC_IDADE character Receiver age group
#> 8 FORMAINICIACAO character Initiation method (DICT, QRDN, QRES, MANU, INIC)
#> 9 NATUREZA character Transaction nature (P2P, P2B, B2P, B2B, P2G, G2P)
#> 10 FINALIDADE character Transaction purpose (Pix, Pix Saque, Pix Troco)
#> 11 VALOR numeric Total transaction value (BRL)
#> 12 QUANTIDADE numeric Number of transactions
pix_columns("fraud")
#> # A tibble: 24 × 3
#> column type description
#> <chr> <chr> <chr>
#> 1 AnoMes integer Reference year-month (Y…
#> 2 QtdePixcontestados numeric Contested PIX transacti…
#> 3 Qtdecontestacoesaceitas numeric Accepted contestations
#> 4 Qtdecontestacoesrejeitadas numeric Rejected contestations
#> 5 Qtdecontestacoesaceitasacada100mil numeric Accepted contestations …
#> 6 QtdeUsuarioscommarcacoesdefraude numeric Users with fraud markin…
#> 7 QtdeChavesPixcommarcacoesdefraude numeric PIX keys with fraud mar…
#> 8 ValorPixcontestadosaceitos numeric Value of accepted conte…
#> 9 QuantidadedevolvidaintegralmentepormeiodoMED numeric Fully returned via MED …
#> 10 ValorPixdevolvidosintegralmente numeric Fully returned via MED …
#> # ℹ 14 more rows
pix_columns("cnae")
#> # A tibble: 15 × 3
#> column type description
#> <chr> <chr> <chr>
#> 1 AnoMes integer Reference year-month (YYYYMM format)
#> 2 tipopessoa character Receiver type: PF (Individual) or PJ (Legal Entity)
#> 3 formainic character Initiation method (DICT, QRDN, QRES, MANU, INIC)
#> 4 finalidade character Transaction purpose (Pix, Pix Saque, Pix Troco)
#> 5 porte character Company size (e.g., Microempresa)
#> 6 mei character Individual microentrepreneur flag (S/N)
#> 7 cnssecao character CNAE section of the receiver's economic activity
#> 8 mesmatit character Payer and receiver are the same person (S/N)
#> 9 naturezarel character Transaction nature (P2P, P2B, B2P, B2B, ...)
#> 10 qtpagador numeric Distinct payers
#> 11 qtrecebedor numeric Distinct receivers
#> 12 qtlanliq numeric Number of settled transactions
#> 13 vllanliq numeric Value of settled transactions (BRL)
#> 14 vlcompra numeric Purchase value (BRL, Pix Troco)
#> 15 vldinespec numeric Cash value (BRL, Pix Saque / Pix Troco)
pix_columns("dict_users")
#> # A tibble: 4 × 3
#> column type description
#> <chr> <chr> <chr>
#> 1 DataGraficosPix Date Reference date (last day of month)
#> 2 qtdUsuariosPessoaFisica numeric Individual users (PF) registered in D…
#> 3 qtdUsuariosPessoaJuridica numeric Legal entity users (PJ) registered in…
#> 4 qtdUsuariosCadastradosDICTTotal numeric Total users registered in DICT