Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Merchant

Merchant Register

This API is responsible for registering new merchants within the closed payment arrangement.

post/MerchantClosedLoopRegister

Request body

Methodstring required

Text Containing The Name Of The Method

PartnerIdinteger required

Number Of The Partner

BusinessUnitIdinteger required

Number Of The BusinessUnit

ContractIdentifierstring required

The Store's ContractIdentifier

MerchantNamestring required

Name Of The Merchant

LegalNamestring required

LegalName From Company

TaxNumberstring required

Legal Identification From Company

Sectorstring required

Sector From Company

Phonestring required

Phone From Company

Emailstring required

Email From Company

ConstitutionDatestring required

ConstitutionDate From Company

Identifierstring required

Unique Merchant Identifier

Example request

{
  "Method": "MerchantClosedLoopRegister",
  "PartnerId": 4548,
  "BusinessUnitId": 4548,
  "ContractIdentifier": "CON965569f9-5c93-4335-b09e-29efe32ba292CON",
  "MerchantName": "Tech RF International",
  "LegalName": "Bakery ltda",
  "TaxNumber": "33.762.255/0001-40",
  "Sector": "food",
  "Email": "email@example.com",
  "ConstitutionDate": "2024-04-17T14:06:04.837Z",
  "CompanyAddress": {
    "Number": "478",
    "Complement": "House",
    "Neighborhood": "Aldeota",
    "PostalCode": "60115221",
    "Line": "Street José Morais",
    "Country": "BR"
  },
  "Identifier": "MerchantTest1106new4",
  "DailyLimit": {
    "TotalAmount": 5000.55
  }
}

Response

Register the Merchant

Successboolean

True or False

Messagestring

Returned message

MerchantIdentifierstring

MerchantIdentifier From Company

Example response

{
  "Success": true,
  "Message": "Purchase generated successfully",
  "MerchantIdentifier": "MER9a883bb8-35fb-4972-8ae3-294cba924314MER"
}