/
v3.0.11Get access

getFinancialCompanies

Returns a list of financial companies (e.g. banks, credit unions) that can be used for deposits and withdrawals. Each entry includes an ID and display name. It is used when users choose a bank or financial institution for payments, and to populate payment method selection fields. It supports payment flows that require selecting a specific financial company.

Request parameters:

The method works without parameters

Call example:

getFinancialCompanies()

Response examples:

{
  code: 0,
  rid: 969333701,
  data: {
    result: 0,
    result_text: null,
    details: [{
      CompanyId: '71207740',
      Name: 'CCR IRAI - SICOOB CREDIMIL'
    }, {
      CompanyId: '01644264',
      Name: 'CCLA SICOOB CREDIMEPI'
    }, {
      CompanyId: '09464032',
      Name: 'MIDWAY S.A. - SCFI'
    }, {
      CompanyId: '19449602',
      Name: 'CC CREDCOOPER LTDA'
    }, {
      CompanyId: '02335109',
      Name: 'CCLA ZONA DA MATA LTDA'
    }]
  }
}

Response parameters:

NameDescriptionTypeValues
CompanyId
Financial company identifier string-
Name
Financial company display name string-