This set of methods is used to provide information from the backend systems or from Boarding system.

Method: GET /api//hierarchy

This endpoint is used to retrieve information about the merchants stored in a superior level of hierarchy.

1. Parameters
   a. CompanyNameOrMID – merchant Trade Name or Merchant Id
   b. MerchantLevelCode - For each institution Boarding has parameterized a list of levels that represent the merchant hierarchy. To valid codes use this API - GET: /api/v1/application/data.
   c. Page – paging parameter, if needed.
   d. PageSize - paging parameter, if needed.
2. Responses
   a. “200” – OK. Indicates success in the inquiry and provides all the merchants stored in the superior hierarchy group level, like internalMerchantId, groupLevel and companyName. It can be used to select the parentMerchantId to be set in a new merchant boarding.
   b. “204” - No register found
   c. “400” - Bad request
   d. “401” - Unauthorized request
   e. “403” - Forbidden request
   f. “500” - Internal Error
   g. “502” - API Error

Method: GET /api/v1/ipg

This endpoint is used to retrieve information about the IPG´s identification of the merchants, that have been boarded via APIs system.

1. Parameters
   a. TradeName - merchant Trade Name or
   b. Mid – merchantId, used to inquire the database
2. Responses
   a. “200” – OK. Indicates success in the inquiry and provides the merchant´s applicationId, and nodeId.

Method: GET /api/v1/ipg/merchant/{mid}

This endpoint is used to retrieve information about the IPG´s identification of the merchants, that have been boarded via APIs system.

1. Parameters
   a. Mid – merchantId, used to inquire the database
2. Responses
   a. “200” – OK. Indicates success in the inquiry and provides the merchant´s applicationId, tradeName and nodeId.