Show Menu

Search Banks

Search Banks

Allows you to search banks within a country using bank name.

post/API/v4/Bank/SearchBank

Header Parameters

Authorizationstring

bearer access_token

Content-typestring

application/json

Request Parameters

IssuerAccountNumberstring

String length: inclusive between 1 and 25

BankNamestring

String length: 100

CountryISO2string

String length: 2

Paginationint

Specifies pagination information to limit the number of records to return. Allowed parameters are: RecordsToSkip—Number of records to skip. RecordsToTake—Number of records to return.

Response Parameters

BanksList

Returned if successful A structure that contains list of Bank names that match the search criteria.

OperationStatusstring

Always returned Indicates the status of the operation. Allowed parameters are:
Errors - Displays an error message if the Property name Obligation Definition/value operation was unsuccessful. For more information, see API Error Message Appendix.
Success—Indicates whether the operation was successful. Returns True if the action was successful or False if it was not successful.

Sample Request:

sandbox.xapi.xtrm.com//API/v4/Bank/SearchBank 

{
  "SearchBank":{
    "request":{
      "IssuerAccountNumber":"SPN19134657",
      "BankName":"Wells ",
      "BankCountryISO2":"US",
      "Pagination":{
        "RecordsToSkip":1,
        "RecordsToTake":10
      }
    }
  }
}

Sample Response:


{
	"SearchBankResponse": {
		"SearchBankResponseResult": {
			"Banks": [
				{
					"BankName": "Wells Fargo Bank New Mexico Na"
				},
				{
					"BankName": "Wells Fargo Bank, National Association"
				},
				{
					"BankName": "Wells Fargo Clearing Services, LLC"
				},
				{
					"BankName": "Wells Fargo Na"
				},
				{
					"BankName": "Wells Fargo Securities International Limited"
				},
				{
					"BankName": "Wells Fargo Securities, LLC"
				},
				{
					"BankName": "Wells Fargo Trust Company, National Association"
				}
			],
			"OperationStatus": {
				"Errors": null,
				"Success": true
			},
			"PaginationTotal": [
				{
					"RecordsTotal": 7,
					"RecordsToSkip": 1,
					"RecordsToTake": 10
				}
			]
		}
	}
}

Why

Products

Developers

How It Works

Resources

Payment and foreign exchange transactions are powered and provided by Corpay. “Corpay” is the marketing trade name for the International Payment Solutions and Risk Management Solutions provided by certain subsidiaries of FleetCor Technologies, Inc. Use of this service is governed by Corpay’s Terms and Conditions.

➤