/
v3.0.11Get access

getBanksByRegionId

Retrieves a list of banks in a given country/region

Request parameters:

NameDescriptionTypeValuesDefault
countryCode
iso representing the country/region stringetc.-

Parameters marked with must be included in the request

Call example:

getBanksByRegionId({
  countryCode: 'AM'
})

Response examples:

{
  code: 0,
  data: {
    result: 0,
    result_text: null,
    details: [{
      Id: '101',
      Name: 'Banco do Brasil'
    }, {
      Id: '102',
      Name: 'Bradesco'
    }, {
      Id: '103',
      Name: 'Itaú Unibanco'
    }]
  },
  rid: 1135776694
}

Response parameters:

NameDescriptionTypeValues
Id
unique identifier of the bank, used as the value when submitting the selected bank in a formstring-
Name
human-readable display name of the bank, shown to the user in a dropdown or liststring-