How to Use the Lookup Module

The Lookup Module allows you to perform various banking-related operations, such as retrieving bank details, validating IBANs, and fetching available transfer methods. This guide explains each endpoint, its parameters, and how to use them. The Lookup Module offers four endpoints:

Get Bank Address Details by Routing Number
Get Bank and Branch Details by Swift Code and Country Code
Validate IBAN
Get Available Transfer Methods

Get Bank Address Details by Routing Number

The Get Bank Address Details by Routing Number endpoint allows you to retrieve the bank's address and name using a routing number specific to banks in the USA. Below, you can see an example of a request and response to this endpoint:

curl --request GET \
     --url https://merchantapi.testewallet.com/api/v1/lookups/usa-routing-numbers/<ROUTING_NUMBER> \
     --header 'X-MerchantId: <YOUR_MERCHANT_ID>' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <YOUR_TOKEN>'

{
  "isSuccess": true,
  "message": "Bank details retrieved successfully.",
  "statusCode": 200,
  "logIdentifier": "xyz789abc456",
  "data": {
    "routingNumber": "123456789",
    "bankName": "Wells Fargo Bank",
    "bankAddress": "420 Montgomery St",
    "bankCity": "San Francisco",
    "bankState": "CA",
    "bankZipCode": "94104"
  }
}

Get Bank and Branch Details by Swift Code and Country Code

The Get Bank and Branch Details by Swift Code and Country Code endpoint allows you to retrieve bank and branch details using a SWIFT code and a country code. SWIFT codes are used internationally for wire transfers. Below, you can see an example of a request and response to this endpoint:

curl --request GET \
     --url https://merchantapi.testewallet.com/api/v1/lookups/swift-codes/<COUNTRY_CODE>/<SWIFT_CODE> \
     --header 'X-MerchantId: <YOUR_MERCHANT_ID>' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <YOUR_TOKEN>'

{
  "isSuccess": true,
  "message": "Operation completed successfully.",
  "statusCode": 200,
  "logIdentifier": "abc123xyz789",
  "data": {
    "swiftCode": "BOFAUS3N",
    "bankName": "Bank of America",
    "countryName": "United States",
    "countryCode": "US",
    "bankAddress": "100 N Tryon St",
    "bankCity": "Charlotte",
    "bankProvince": "North Carolina",
    "bankZipCode": "28255",
    "branchName": "Head Office",
    "branchAddress": "100 N Tryon St",
    "branchCity": "Charlotte",
    "branchProvince": "North Carolina",
    "branchZipCode": "28255"
  }
}

Validate IBAN

The Validate IBAN endpoint allows you to validate an International Bank Account Number (IBAN). It checks whether the provided IBAN is valid based on algorithmic checks. Below, you can see an example of a request and response to this endpoint:

curl --request GET \
     --url https://merchantapi.testewallet.com/api/v1/lookups/ibans/<COUNTRY_CODE>/<IBAN> \
     --header 'X-MerchantId: <YOUR_MERCHANT_ID>' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <YOUR_TOKEN>'

{
  "isSuccess": true,
  "message": "IBAN validation completed successfully.",
  "statusCode": 200,
  "logIdentifier": "def456ghi789",
  "data": {
    "iban": "DE89370400440532013000",
    "countryCode": "DE",
    "isValid": true
  }
}

Get Available Transfer Methods

The Get Available Transfer Methods endpoint returns the available transfer methods for a specified country. Based on the country code, it provides options like bank wire, credit card, etc.. Below, you can see an example of a request and response to this endpoint:

curl --request GET \
     --url 'https://merchantapi.testewallet.com/api/v1/lookups/available-transfer-methods?countryCode=US' \
     --header 'X-MerchantId: <YOUR_MERCHANT_ID>' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <YOUR_TOKEN>'

{
  "isSuccess": true,
  "message": "Available transfer methods retrieved successfully.",
  "statusCode": 200,
  "logIdentifier": "jkl123mno456",
  "data": [
    {
      "transferMethod": "Bank Wire",
      "available": true,
      "sourceCurrency": [
        "USD"
      ],
      "destinationCurrency": [
        "EUR",
        "GBP",
        "JPY"
      ]
    },
    {
      "transferMethod": "Credit Card",
      "available": true,
      "sourceCurrency": [
        "USD"
      ],
      "destinationCurrency": [
        "USD",
        "CAD"
      ]
    },
    {
      "transferMethod": "eWallet",
      "available": true,
      "sourceCurrency": [
        "USD"
      ],
      "destinationCurrency": [
        "USD",
        "EUR"
      ]
    }
  ]
}