Get Merchants by Company Contract

API: GetMerchantsByCompanyContract

This API is responsible for retrieving all merchants associated with a specific company contract within the Closed Loop arrangement.

The request allows pagination through the PageSize and PageIndex parameters, enabling efficient retrieval when a contract contains a large number of merchants.

Request Structure

{
  "Method": "GetMerchantsByCompanyContract",
  "BusinessUnitId": 30472,
  "PartnerId": 10409,
  "ContractIdentifier": "CON466da4fa-4d36-472a-b60f-5c042bf468c6CON",
  "PageSize": 10,
  "PageIndex": 0
}

Request Parameters

Parameter	Type	Description	Example	Mandatory
Method	string	Method name	"GetMerchantsByCompanyContract"	Yes
PartnerId	bigint	Information provided by FitBank	10409	Yes
BusinessUnitId	bigint	Information provided by FitBank	30472	Yes
ContractIdentifier	varchar	Unique identifier of the company contract	"CON466da4fa-4d36-472a-b60f-5c042bf468c6CON"	Yes
PageSize	int	Number of records returned per request	10	No
PageIndex	int	Page index for pagination (starting at 0)	0	No

Response Structure

{
  "Success": "true",
  "Message": "Merchants retrieved successfully",
  "TotalRecords": 2,
  "Merchants": [
    {
      "MerchantIdentifier": "MER086c63fa-ccf8-4995-b988-439c347aa9c4MER",
      "MerchantName": "Bakery",
      "LegalName": "Bakery LTDA",
      "TaxNumber": "33.762.255/0001-40",
      "BusinessUnitId": 10409,
      "DailyLimit": {
        "TotalAmount": 5000.55
      }
    },
    {
      "MerchantIdentifier": "MER1245fd90-6c1b-45f4-a45b-67e37e43c2a1MER",
      "MerchantName": "Food Express",
      "LegalName": "Food Express LTDA",
      "TaxNumber": "45.987.654/0001-12",
      "BusinessUnitId": 10409,
      "DailyLimit": {
        "TotalAmount": 4800
      }
    }
  ]
}

Response field

Field	Type	Description
Success	boolean	Indicates whether the request was successfully processed.
Message	string	Response message describing the result of the operation.
TotalRecords	int	Total number of merchants associated with the contract.
Merchants	array	List of merchants associated with the company contract.

Objeto Merchant

Field	Type	Description
MerchantIdentifier	varchar	Unique identifier of the merchant.
MerchantName	string	Merchant's trade name.
LegalName	string	Merchant's legal company name.
TaxNumber	varchar	Merchant's fiscal identifier.
BusinessUnitId	bigint	Business unit associated with the merchant.
DailyLimit	object	Financial configuration of the merchant.
DailyLimit.TotalAmount	decimal	Merchant's base limit configured in the system.