Banks Reference

The Banks API provides access to the list of financial institutions available in Brazil for payment processing.

Overview

WEpayments supports a wide range of Brazilian banks and financial institutions. The Banks API allows you to retrieve the complete list of available institutions, which is essential for:

Payment Processing: Know which banks are supported for transactions
User Interface: Display bank options to your users
Integration: Validate bank codes before processing payments
Compliance: Ensure you’re working with authorized institutions

Available Institutions

The API returns information about all banks registered with the Brazilian Central Bank (Banco Central do Brasil) that are supported by WEpayments.

Institution Information

Each institution in the list includes:

Field	Type	Description
`code`	string	ISPB code (unique identifier)
`name`	string	Full institution name
`short_name`	string	Abbreviated name
`type`	string	Institution type (bank, payment institution, etc.)

Use Cases

Bank Selection in UI

Retrieve the list of institutions to populate a dropdown or selection menu in your application:

const banks = await fetchBanks();
const bankOptions = banks.map(bank => ({
  value: bank.code,
  label: bank.name
}));

Bank Code Validation

Validate bank codes before processing transactions:

function isValidBank(bankCode, bankList) {
  return bankList.some(bank => bank.code === bankCode);
}

Bank Name Display

Convert bank codes to readable names for display:

function getBankName(bankCode, bankList) {
  const bank = bankList.find(b => b.code === bankCode);
  return bank ? bank.name : 'Unknown Bank';
}

Filtering by Type

Filter institutions by type (e.g., only traditional banks):

const traditionalBanks = banks.filter(bank => bank.type === 'bank');

Common Banks in Brazil

Some of the major banks you’ll find in the list include:

Banco do Brasil - One of the largest banks in Brazil
Caixa Econômica Federal - Federal savings bank
Itaú Unibanco - Major private bank
Bradesco - One of the largest private banks
Santander Brasil - International bank with Brazilian operations
Nubank - Leading digital bank
Inter - Digital bank and payment institution
PagSeguro - Payment institution

Best Practices

Cache the Bank List: The list of institutions doesn’t change frequently. Cache it in your application to reduce API calls and improve performance.

Keep Updated: While the list is relatively stable, new institutions may be added. Refresh your cache periodically (e.g., weekly) to stay current.

Caching Strategy

// Example caching implementation
const CACHE_DURATION = 7 * 24 * 60 * 60 * 1000; // 7 days

async function getBanks() {
  const cached = localStorage.getItem('banks');
  const cacheTime = localStorage.getItem('banks_timestamp');
  
  if (cached && cacheTime) {
    const age = Date.now() - parseInt(cacheTime);
    if (age < CACHE_DURATION) {
      return JSON.parse(cached);
    }
  }
  
  // Fetch fresh data
  const banks = await fetchBanksFromAPI();
  localStorage.setItem('banks', JSON.stringify(banks));
  localStorage.setItem('banks_timestamp', Date.now().toString());
  
  return banks;
}

Introduction

Account

Banks

Payin

Payout

Markup

Reference

Banks Reference

Overview

Available Institutions

Institution Information

Use Cases

Common Banks in Brazil

Best Practices

Caching Strategy

Next Steps

List Institutions

Payment Processing

​Banks Reference

​Overview

​Available Institutions

​Institution Information

​Use Cases

​Common Banks in Brazil

​Best Practices

​Caching Strategy

​Next Steps

List Institutions

Payment Processing

Banks Reference

Overview

Available Institutions

Institution Information

Use Cases

Common Banks in Brazil

Best Practices

Caching Strategy

Next Steps