Get Merchant Details

API: GetMerchantDetails

This API is responsible for retrieving the details of a specific merchant within the Closed Loop system.

The query is performed using the merchant's unique identifier (MerchantIdentifier), returning all registration data, address information, contact details, and the financial configuration associated with the merchant.

Request Structure

{
  "Method": "GetMerchantDetails",
  "BusinessUnitId": 30472,
  "PartnerId": 10409,
  "MerchantIdentifier": "MER086c63fa-ccf8-4995-b988-439c347aa9c4MER"
}

Request Parameters

Parameter	Type	Description	Example	Mandatory
Method	string	Method name	"GetMerchantDetails"	Yes
PartnerId	bigint	Information provided by FitBank	10409	Yes
BusinessUnitId	bigint	Information provided by FitBank	30472	Yes
MerchantIdentifier	varchar	Unique identifier of the merchant	"MER086c63fa-ccf8-4995-b988-439c347aa9c4MER"	Yes

Response Structure

{
  "Success": "true",
  "Message": "Merchant details retrieved successfully",
  "Merchant": {
    "MerchantIdentifier": "MER086c63fa-ccf8-4995-b988-439c347aa9c4MER",
    "MerchantName": "Bakery",
    "LegalName": "Bakery LTDA",
    "TaxNumber": "33.762.255/0001-40",
    "BusinessUnitId": 10409,
    "Phone": 302123456789,
    "Email": "[email protected]",
    "ConstitutionDate": "2024-04-17T14:06:04.837Z",
    "CompanyAddress": {
      "Line": "Street José Morais",
      "Number": "478",
      "Complement": "House",
      "Reference": "Near restaurant",
      "Neighborhood": "Aldeota",
      "City": "Crateus",
      "State": "CE",
      "ZipCode": "60115221",
      "Country": "BR"
    },
    "CreatedAt": "2024-03-01T10:00:00Z",
    "UpdatedAt": "2024-03-10T15:30:00Z",
    "DailyLimit": {
      "TotalAmount": 5000.00
    }
  }
}

Response Fields

Type	Field	Description
boolean	Success	Indicates whether the request was successfully processed.
string	Message	API response message describing the result of the operation.
object	Merchant	Object containing the merchant's complete information.

Merchant Object

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.
Phone	varchar	Merchant's phone number.
Email	string	Merchant's contact email.
ConstitutionDate	datetime	Company establishment date.
CompanyAddress	object	Merchant's address information.
CreatedAt	datetime	Date when the merchant was created in the system.
UpdatedAt	datetime	Date of the last update to the merchant's data.
DailyLimit	object	Merchant's financial configuration.
DailyLimit.TotalAmount	decimal	Base limit configured for the merchant in the system.