2.4 - 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:

ParameterDescriptionTypeExampleMandatory
MethodMethod namestring"MerchantClosedLoopRegister"Yes
PartnerInformation provided by FitBankbigint"847561"Yes
BusinessUnitIdInformation provided by FitBankint"234334"Yes
ContractIdentifierContract identifiervarchar"CON965569f9-5c93-4335-b09e-29efe32ba292CON"Yes
MerchantNameMerchant namestring"Super 24 - Montufar"Yes
LegalNameLegal name of the companystring"Prones y Pagamentos"Yes
TaxNumberFiscal identifiervarchar"3480082520113"Yes
SectorEstablishment sectorvarchar"Food"Yes
ConstitutionDateDate of company's establishment (e.g., "2013-05-13")date"24/09/2023 14:30:00"Yes
MerchantIdentifierEstablishment identifiervarchar"MER0551a52e-b0e7-4c58-8b26-0a3016f458caMER"Yes
AccountKeyCommercial establishment's key accountvarchar"963497-209911-9590853-5"No
PhoneEstablishment's phone numbervarchar"+50223629963"Yes
EmailEstablishment's email addressvarchar"[email protected]"Yes
PostalCodePostal Code of the Establishmentvarchar"01009"Yes
StreetEstablishment's streetvarchar"CALLE 12"Yes
NumberEstablishment's numbervarchar"2-21"Yes
ComplementAddress complement of the establishmentvarchar"Calle Montufar"Yes
NeighborhoodNeighborhood/Zone of ​​the Establishmentvarchar"ZONA 9"Yes
CityCity of the Establishmentdatetime"Ciudad de Guatemala"Yes
StateState/Department of the Establishmentvarchar"Departamento de Guatemala"Yes
ReferenceReference point near the establishmentvarchar"Paleta Montufar"Yes
CountryCodeCountry Code (e.g. GT)varcharGTYes