searchMerchant

You can look up a merchant record with the searchMerchant call.
Use this call to get the following information:

  • A merchant code
  • A merchant's external reference (for example, the reference you use to identify a merchant in your system)
  • Whether the specified merchant account exists or not.

You can search by:

  • Merchant code
  • Merchant's external reference.

The searchMerchant call returns the following data:

  • The specified merchant code, if the corresponding merchant account exists
  • The specified merchant's external reference, if available
  • If the specified merchant account exists or not.

Fields Type Required Description

searchType

String (tick)

It is a mandatory field. It defines the type of search you want to run:

  • Either based on a known merchant code to look up the corresponding external reference
  • A merchant's external reference to look up the corresponding merchant code.

Allowed values:

  • ExternalReference
  • MerchantCode

searchField

String (tick)

It is a mandatory field. Depending on the defined searchType value, this field holds one the following search strings:

  • Either the known merchant code
  • The known merchant's external reference.

Refer the given code examples.

Questions

Can't find something you are looking for? Look at our FAQ for answers or contact Support.