Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Merchant

Retrieve the Merchants related to a contract

This API is responsible for retrieving all te merchants involved in a contract

post/GetMerchantsByCompanyContract

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

Pagesizeinteger

Page Size

PageIndexinteger

Index of the page starting in 0

Example request

{
  "Method": "GetMerchantsByCompanyContract",
  "PartnerId": 4548,
  "BusinessUnitId": 4548,
  "ContractIdentifier": "CON965569f9-5c93-4335-b09e-29efe32ba292CON",
  "Pagesize": 10,
  "PageIndex": 2
}

Response

Retrieve Merchants

Successboolean

True or False

Messagestring

Returned message

TotalRecordsinteger

amount of results

MerchantIdentifierstring

MerchantIdentifier From Company

Example response

{
  "Success": true,
  "Message": "Purchase generated successfully",
  "TotalRecords": 1,
  "MerchantIdentifier": "MER9a883bb8-35fb-4972-8ae3-294cba924314MER",
  "Merchants": [
    {
      "MerchantIdentifier": "MER9a883bb8-35fb-4972-8ae3-294cba924314MER",
      "MerchantName": "Tech RF International",
      "LegalName": "Bakery ltda",
      "TaxNumber": "33.762.255/0001-40",
      "BusinessUnitId": 4548,
      "Email": "email@example.com",
      "ConstitutionDate": "2024-04-17T14:06:04.837Z",
      "DailyLimit": {
        "TotalAmount": 5000.55
      }
    }
  ]
}