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:
Parameter | Description | Type | Example | Mandatory |
---|---|---|---|---|
Method | Method name | string | "MerchantClosedLoopRegister" | Yes |
Partner | Information provided by FitBank | bigint | "847561" | Yes |
BusinessUnitId | Information provided by FitBank | int | "234334" | Yes |
ContractIdentifier | Contract identifier | varchar | "CON965569f9-5c93-4335-b09e-29efe32ba292CON" | Yes |
MerchantName | Merchant name | string | "Super 24 - Montufar" | Yes |
LegalName | Legal name of the company | string | "Prones y Pagamentos" | Yes |
TaxNumber | Fiscal identifier | varchar | "3480082520113" | Yes |
Sector | Establishment sector | varchar | "Food" | Yes |
ConstitutionDate | Date of company's establishment (e.g., "2013-05-13") | date | "24/09/2023 14:30:00" | Yes |
MerchantIdentifier | Establishment identifier | varchar | "MER0551a52e-b0e7-4c58-8b26-0a3016f458caMER" | Yes |
AccountKey | Commercial establishment's key account | varchar | "963497-209911-9590853-5" | No |
Phone | Establishment's phone number | varchar | "+50223629963" | Yes |
Establishment's email address | varchar | "[email protected]" | Yes | |
PostalCode | Postal Code of the Establishment | varchar | "01009" | Yes |
Street | Establishment's street | varchar | "CALLE 12" | Yes |
Number | Establishment's number | varchar | "2-21" | Yes |
Complement | Address complement of the establishment | varchar | "Calle Montufar" | Yes |
Neighborhood | Neighborhood/Zone of the Establishment | varchar | "ZONA 9" | Yes |
City | City of the Establishment | datetime | "Ciudad de Guatemala" | Yes |
State | State/Department of the Establishment | varchar | "Departamento de Guatemala" | Yes |
Reference | Reference point near the establishment | varchar | "Paleta Montufar" | Yes |
CountryCode | Country Code (e.g. GT) | varchar | GT | Yes |
Updated 8 days ago