Skip to main content
GET
Look Up SWIFT Code

Overview

Returns the bank details EximPe holds for a SWIFT/BIC code, in the same field names as settlement_details on Create Merchant. Use it to show the bank to your user before you submit, or to check a code.
You do not have to call this first. On Create Merchant and Update Merchant, bank fields you leave out are filled from bank_swift_code in the same way.

Query Parameters

Response

A field is null when EximPe holds no value for it. bank_state is not returned; you always send it yourself. The values are returned as EximPe holds them and are not checked against the rules on Create Merchant. When you use them in a sub-merchant:
  • Send any field that is null here yourself. If you leave it out, Create Merchant and Update Merchant refuse the request with a 400 that lists the field in details.settlement_details, alongside any other problems in the request. When it is the only problem, the code is ERR_MERCHANT_019, or ERR_MERCHANT_006 when the field is bank_country.
  • Check each value against its rule, e.g. bank_address must be 20–150 characters. A value that fails is refused with a 400 that lists the field in details.settlement_details. Send your own value for it instead.

Errors

Authorizations

X-Client-ID
string
header
required

Client Application ID - Your unique application identifier used to authenticate API requests. You can find your Client ID in the Developer Settings section of the merchant dashboard.

X-Client-Secret
string
header
required

Client Secret Key - Your secret key used alongside the Client ID for secure authentication. Keep this confidential and never expose it in client-side code. Available in the Developer Settings section of the merchant dashboard.

X-API-Version
string
header
required

API Version - Specifies which version of the API to use (e.g., '1.X.X', '2.X.X', or '3.X.X'). This header allows you to control which API version your integration uses. Default version information is available in the Developer Settings.

Query Parameters

code
string
required

SWIFT/BIC code. 8 or 11 characters, upper case: 6 letters, then 2 letters or digits, then an optional 3-character branch code of letters or digits, e.g. DBSSSGSG.

Pattern: ^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$

Response

Bank details for the code.

success
boolean
required
message
string
required
data
object
required