PUT v1/Bank/SearchBanks

Searches for a bank in a given country. Either BankName (partial like 'ban' is ok) or BankCode (CLABE, routing number, swift code, IFSC) can be used

Request Information

Parameters (ParameterName * = required)

Name
Description
Sample Value
CountryTo *
The 2-letter country code
MX
BankName
Partial bank name
Bancomer
BankCode
CLABE, IFSC, routing number, etc
011000206
MatchFromStart
If true, will only find banks matching the beginning of the search string. If false, will find banks containing the search string.
false
DeliveryMethod
OfficePickup, BankDesposit, etc
OfficePickup
CurrencyFrom
The 3-letter currency code
MXN
CurrencyTo
The 3-letter currency code
MXN
AmountFrom
Amount sent in transaction
121.87
AmountTo
Amount sent in transaction
121.87

Response Information

Response body formats

application/json, text/json

Sample:
[
  {
    "bankId": 1,
    "bankName": "sample string 2",
    "bankAlias": "sample string 3",
    "bankState": "sample string 4",
    "realTimeValidation": true,
    "receivingAgentId": 6,
    "accountValidationAgentSetting": true
  },
  {
    "bankId": 1,
    "bankName": "sample string 2",
    "bankAlias": "sample string 3",
    "bankState": "sample string 4",
    "realTimeValidation": true,
    "receivingAgentId": 6,
    "accountValidationAgentSetting": true
  },
  {
    "bankId": 1,
    "bankName": "sample string 2",
    "bankAlias": "sample string 3",
    "bankState": "sample string 4",
    "realTimeValidation": true,
    "receivingAgentId": 6,
    "accountValidationAgentSetting": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfBankInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ria.Digital.WebServices.DataModels">
  <BankInfoResponse>
    <_x003C_AccountValidationAgentSetting_x003E_k__BackingField>true</_x003C_AccountValidationAgentSetting_x003E_k__BackingField>
    <_x003C_BankAlias_x003E_k__BackingField>sample string 3</_x003C_BankAlias_x003E_k__BackingField>
    <_x003C_BankId_x003E_k__BackingField>1</_x003C_BankId_x003E_k__BackingField>
    <_x003C_BankName_x003E_k__BackingField>sample string 2</_x003C_BankName_x003E_k__BackingField>
    <_x003C_BankState_x003E_k__BackingField>sample string 4</_x003C_BankState_x003E_k__BackingField>
    <_x003C_RealTimeValidation_x003E_k__BackingField>true</_x003C_RealTimeValidation_x003E_k__BackingField>
    <_x003C_ReceivingAgentId_x003E_k__BackingField>6</_x003C_ReceivingAgentId_x003E_k__BackingField>
  </BankInfoResponse>
  <BankInfoResponse>
    <_x003C_AccountValidationAgentSetting_x003E_k__BackingField>true</_x003C_AccountValidationAgentSetting_x003E_k__BackingField>
    <_x003C_BankAlias_x003E_k__BackingField>sample string 3</_x003C_BankAlias_x003E_k__BackingField>
    <_x003C_BankId_x003E_k__BackingField>1</_x003C_BankId_x003E_k__BackingField>
    <_x003C_BankName_x003E_k__BackingField>sample string 2</_x003C_BankName_x003E_k__BackingField>
    <_x003C_BankState_x003E_k__BackingField>sample string 4</_x003C_BankState_x003E_k__BackingField>
    <_x003C_RealTimeValidation_x003E_k__BackingField>true</_x003C_RealTimeValidation_x003E_k__BackingField>
    <_x003C_ReceivingAgentId_x003E_k__BackingField>6</_x003C_ReceivingAgentId_x003E_k__BackingField>
  </BankInfoResponse>
  <BankInfoResponse>
    <_x003C_AccountValidationAgentSetting_x003E_k__BackingField>true</_x003C_AccountValidationAgentSetting_x003E_k__BackingField>
    <_x003C_BankAlias_x003E_k__BackingField>sample string 3</_x003C_BankAlias_x003E_k__BackingField>
    <_x003C_BankId_x003E_k__BackingField>1</_x003C_BankId_x003E_k__BackingField>
    <_x003C_BankName_x003E_k__BackingField>sample string 2</_x003C_BankName_x003E_k__BackingField>
    <_x003C_BankState_x003E_k__BackingField>sample string 4</_x003C_BankState_x003E_k__BackingField>
    <_x003C_RealTimeValidation_x003E_k__BackingField>true</_x003C_RealTimeValidation_x003E_k__BackingField>
    <_x003C_ReceivingAgentId_x003E_k__BackingField>6</_x003C_ReceivingAgentId_x003E_k__BackingField>
  </BankInfoResponse>
</ArrayOfBankInfoResponse>