Register a new Merchant

Register a New Associated Company

API: RegisterCompanyContractClosedLoop

This functionality allows the Receiver participant to register a new Associated Company within the Closed Loop arrangement, specifying the types of services offered and the applicable fees for purchase, withdrawal, and deposit transactions.

During the company registration process, it is also possible to define the base limit amount available for merchants associated with this company, as well as the daily limit configuration, which controls additional balance requests.

Each merchant created under this contract will inherit the base financial configuration defined at the time the company is created.

Functionality available in the Portal Management Hub.

New Financial Parameters

Starting from this API version, new financial parameters have been introduced to control the base limit and the daily limit available for merchants.

TotalAmount

Defines the merchant's base limit within the Closed Loop system.
This value represents the initial limit configured for the merchant at the time of creation.

DailyLimit

Defines the structure used to request a temporary daily limit increase, calculated based on the merchant's base limit.

Daily Limit Rules

• The additional limit can be requested only once per day.
• After a request is made, a new request can only be submitted on the following day.
• The allowed limit increase is up to 25% of the merchant's base limit (TotalAmount).
• When a limit increase is requested, the system will grant an additional amount equivalent to 25% of the base limit configured for the merchant.
• The base limit (TotalAmount) is defined during the company or merchant creation process.

Example:

• Merchant base limit TotalAmount: 5,000
• Additional limit allowed per day: 1,250 (25%)
• Total available limit for the day after the request: 6,250

Request Structure

{
  "Method": "RegisterCompanyContractClosedLoop",
  "PartnerId": 30472,
  "BusinessUnitId": 10409,
  "ArrangementIdentifier": "ARR880ff122-e5a9-4069-aaac-d9e5f58dee8cARR",
  "Name": "CompanyContract",
  "Nickname": "Super 24 Contract",
  "TaxNumber": "33.762.255/0001-40",
  "CompanySector": "food",
  "ServiceType": 6,
  "RatePurchaseValue": 2.5,
  "RatePurchaseType": 0,
  "RateWithdrawalValue": 2,
  "RateWithdrawalType": 1,
  "RateDepositValue": 0.5,
  "RateDepositType": 0,
  "DaysToSettle": 2,
  "DailyLimit": {
    "TotalAmount": 5000.55
  }
}

 

• JSON RESPONSE:
  JSON

  {
    "Success": "true",
    "Message": "The registration request for the Merchant [padaria] was received successfully! We will soon send you the status of the Merchant account creation",
    "MerchantIdentifier": "MER9a883bb8-35fb-4972-8ae3-294cba924314MER"
  }
  

Parameter Descriptions: