openbanking-apis v1.0.9

openbanking-apis

Catálogo de APIs Open Banking das instituições participantes.

Install

$ npm install openbanking-apis

Usage

import { Api } from 'openbanking-apis';
const catalog = new Api('v1');

//Lista de agências
catalog.channels.branches(catalog.servers.bb);
//==> https://opendata.api.bb.com.br/open-banking/channels/v1/branches

Servers (Participantes)

{
  bb: 'https://opendata.api.bb.com.br/open-banking',
  bradesco: 'https://api.bradesco.com/bradesco/open-banking',
  banrisul: 'https://openbanking.banrisul.com.br/open-banking',
  itau: 'https://api.itau/open-banking'
}

API

• Channels
  • Branches (Agências)

    catalog.channels.branches(catalog.servers.itau);
    //==> https://api.itau/open-banking/channels/v1/branches

  • Electronic Channels (Canais de atendimento eletrônico)

    catalog.channels.electronicChannels(catalog.servers.bradesco);
    //==> https://api.bradesco.com/bradesco/open-banking/channels/v1/electronic-channels

  • Phone Channels (Canais de atendimento telefônico)

    catalog.channels.phoneChannels(catalog.servers.banrisul);
    //==> https://openbanking.banrisul.com.br/open-banking/channels/v1/phone-channels

  • Banking Agents (Correspondentes bancários)

    catalog.channels.bankingAgents(catalog.servers.bb);
    //==> https://opendata.api.bb.com.br/open-banking/channels/v1/banking-agents

  • Shared Automated Teller Machines (Terminais de autoatendimento compartilhados)

    catalog.channels.sharedAutomatedTellerMachines(catalog.servers.itau);
    //==> https://api.itau/open-banking/channels/v1/shared-automated-teller-machines

• Products Services
  • Accounts
    • Personal Accounts (Contas pessoa física)

    catalog.productsServices.personalAccounts(catalog.servers.bb);
    //==> https://opendata.api.bb.com.br/open-banking/products-services/v1/personal-accounts

    • Business Accounts (Contas pessoa jurídica)

    catalog.productsServices.businessAccounts(catalog.servers.itau);
    //==> https://api.itau/open-banking/products-services/v1/business-accounts

  • Loans
    • Personal Loans (Empréstimos pessoa física)

    catalog.productsServices.personalLoans(catalog.servers.bradesco);
    //==> https://api.bradesco.com/bradesco/open-banking/products-services/v1/personal-loans

    • Business Loans (Empréstimos pessoa jurídica)

    catalog.productsServices.businessLoans(catalog.servers.banrisul);
    //==> https://openbanking.banrisul.com.br/open-banking/products-services/v1/business-loans

  • Credit Cards
    • Personal Credit Cards (Cartão de crédito pessoa física)

    catalog.productsServices.personalCreditCards(catalog.servers.bb);
    //==> https://opendata.api.bb.com.br/open-banking/products-services/v1/personal-credit-cards

    • Business Credit Cards (Cartão de crédito pessoa jurídica)

    catalog.productsServices.businessCreditCards(catalog.servers.itau);
    //==> https://api.itau/open-banking/products-services/v1/business-credit-cards

  • Invoice Financings
    • Personal Invoice Financings (Antecipação de recebíbeis pessoa fisica)

    catalog.productsServices.personalInvoiceFinancings(catalog.servers.bradesco);
    //==> https://api.bradesco.com/bradesco/open-banking/products-services/v1/personal-invoice-financings

    • Business Invoice Financings (Antecipação de recebíbeis pessoa juridica)

    catalog.productsServices.businessInvoiceFinancings(catalog.servers.banrisul);
    //==> https://openbanking.banrisul.com.br/open-banking/products-services/v1/business-invoice-financings

  • Unarranged Account Overdraft
    • Personal Unarranged Account Overdraft (Adiantamneto a depositante pessoa física)

    catalog.productsServices.personalUnarrangedAccountOverdraft(catalog.servers.bb);
    //==> https://opendata.api.bb.com.br/open-banking/products-services/v1/personal-unarranged-account-overdraft

    • Business Unarranged Account Overdraft (Adiantamneto a depositante pessoa jurídica)

    catalog.productsServices.businessUnarrangedAccountOverdraft(catalog.servers.itau);
    //==> https://api.itau/open-banking/products-services/v1/business-unarranged-account-overdraft

• Discovery
  • Status (Status do serviço)

    catalog.discovery.status(catalog.servers.bradesco);
    //==> https://api.bradesco.com/bradesco/open-banking/discovery/v1/status

  • Outages (Manutenção programada)

    catalog.discovery.outages(catalog.servers.banrisul);
    //==> https://openbanking.banrisul.com.br/open-banking/discovery/v1/outages

TODO

• Adicionar demais participante na lista de servers.

License

MIT © Danilo Sampaio