7 - Merchant Register

5. Merchant Registration Flow

5.1 API: MerchantRegister

Description: This API is responsible for registering new merchants within the closed loop payment system.
Functionality:
- Receives merchant information, such as business data, bank details, and required documents.
- Performs initial validations to verify the compliance of the provided data.
- Facilitates the integration of new merchants into the closed loop payment system.

JSON REQUEST:

{
    "Method": "MerchantClosedLoopRegister",
    "PartnerId": "",
    "BusinessUnitId": "",
    "ContractIdentifier": "",
    "MerchantName": "SUPER 24 MONTUFAR",
    "LegalName": "Super 24 - LegalTeste",
    "TaxNumber": "nulo",
    "Sector": "food",
    "Phone": "+50223629963",
    "Email": "[email protected]",
    "ConstitutionDate": "nulo",
    "CompanyAddress": {
      "postalCode": "01009",
      "street": "CALLE 12",
      "number": "2-21",
      "complement": "Calle Montufar",
      "neighborhood": "ZONA 9",
      "city": "Ciudad de Guatemala",
      "state": "Departamento de Guatemala",
      "reference": "Paleta Montufar",
      "CountryCode": "GT"
    }
}

JSON RESPONSE:

{
  "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:

Property	Type	Description
method	String	Name of the method to be executed
PartnerId	Integer	Partner Identifier
BusinessUnitId	Integer	Business Unit Identifier
ContractIdentifier	Integer	Identifier of the ClosedLoop contract
MerchantName	String	Merchant name
LegalName	String	Legal name of the company
TaxNumber	Integer	Company registration number
Sector	String	Company sector (e.g., Food)
Phone	String	Company phone number
Email	String	Company email address
ConstitutionDate	Date	Date of company's establishment (e.g., "2013-05-13")
MerchantAddress	Object	Object containing company address details
postalCode	String	Postal code
street	String	Street name
number	String	Street number
complement	String	Address complement (e.g., "SALA 01 - 2 ANDAR")
neighborhood	String	Neighborhood
city	String	City
state	String	State
reference	String	Reference point (e.g., "Próximo aos Correios")
countryCode	String	Country code (e.g., "BR")