Update Platform Merchant

Update sub-merchant's profile

SecurityLimepay-Token
Request
path Parameters
merchantId
required
string
Request Body schema: application/json
timeZone
required
string

Timezone for the company, eg. Australia/Sydney

businessName
required
string

Business name (as linked to ABN/ACN)

businessType
required
string (BusinessType)
Enum: "company" "individual" "soletrader" "partnership" "trust"
companyType
string (CompanyType)

(Optional) Company type, required when businessType is company

Enum: "Private" "Public"
website
required
string

Company website

supportSite
required
string

Company website for handling support issues

industry
required
string (Industry)
Enum: "AcRefrigerationRepair" "AccountingBookkeepingServices" "AdvertisingServices" "AgriculturalCooperative" "AirlinesAirCarriers" "AirportsFlyingFields" "AmbulanceServices" "AmusementParksCarnivals" "AntiqueReproductions" "AntiqueShops" "Aquariums" "ArchitecturalSurveyingServices" "ArtDealersAndGalleries" "ArtistsSupplyAndCraftShops" "AutoBodyRepairShops" "AutoPaintShops" "AutoServiceShops" "AutoAndHomeSupplyStores" "AutomatedCashDisburse" "AutomatedFuelDispensers" "AutomobileAssociations" "AutomotivePartsAndAccessoriesStores" "AutomotiveTireStores" "BailAndBondPayments" "Bakeries" "BandsOrchestras" "BarberAndBeautyShops" "BettingCasinoGambling" "BicycleShops" "BilliardPoolEstablishments" "BoatDealers" "BoatRentalsAndLeases" "BookStores" "BooksPeriodicalsAndNewspapers" "BowlingAlleys" "BusLines" "BusinessSecretarialSchools" "BuyingShoppingServices" "CableSatelliteAndOtherPayTelevisionAndRadio" "CameraAndPhotographicSupplyStores" "CandyNutAndConfectioneryStores" "CarRentalAgencies" "CarWashes" "CarAndTruckDealersNewUsed" "CarAndTruckDealersUsedOnly" "CarpentryServices" "CarpetUpholsteryCleaning" "Caterers" "CharitableAndSocialServiceOrganizationsFundraising" "ChemicalsAndAlliedProducts" "ChildCareServices" "ChildrensAndInfantsWearStores" "ChiropodistsPodiatrists" "Chiropractors" "CigarStoresAndStands" "CivicSocialFraternalAssociations" "CleaningAndMaintenance" "ClothingRental" "CollegesUniversities" "CommercialEquipment" "CommercialFootwear" "CommercialPhotographyArtAndGraphics" "CommuterTransportAndFerries" "ComputerNetworkServices" "ComputerProgramming" "ComputerRepair" "ComputerSoftwareStores" "ComputersPeripheralsAndSoftware" "ConcreteWorkServices" "ConstructionMaterials" "ConsultingPublicRelations" "CorrespondenceSchools" "CosmeticStores" "CounselingServices" "CountryClubs" "CourierServices" "CourtCosts" "CreditReportingAgencies" "CruiseLines" "DairyProductsStores" "DanceHallStudiosSchools" "DatingEscortServices" "DentistsOrthodontists" "DepartmentStores" "DetectiveAgencies" "DigitalGoodsMedia" "DigitalGoodsApplications" "DigitalGoodsGames" "DigitalGoodsLargeVolume" "DirectMarketingCatalogMerchant" "DirectMarketingCombinationCatalogAndRetailMerchant" "DirectMarketingInboundTelemarketing" "DirectMarketingInsuranceServices" "DirectMarketingOther" "DirectMarketingOutboundTelemarketing" "DirectMarketingSubscription" "DirectMarketingTravel" "DiscountStores" "Doctors" "DoorToDoorSales" "DraperyWindowCoveringAndUpholsteryStores" "DrinkingPlaces" "DrugStoresAndPharmacies" "DrugsDrugProprietariesAndDruggistSundries" "DryCleaners" "DurableGoods" "DutyFreeStores" "EatingPlacesRestaurants" "EducationalServices" "ElectricRazorStores" "ElectricalPartsAndEquipment" "ElectricalServices" "ElectronicsRepairShops" "ElectronicsStores" "ElementarySecondarySchools" "EmploymentTempAgencies" "EquipmentRental" "ExterminatingServices" "FamilyClothingStores" "FastFoodRestaurants" "FinancialInstitutions" "FinesGovernmentAdministrativeEntities" "FireplaceFireplaceScreensAndAccessoriesStores" "FloorCoveringStores" "Florists" "FloristsSuppliesNurseryStockAndFlowers" "FreezerAndLockerMeatProvisioners" "FuelDealersNonAutomotive" "FuneralServicesCrematories" "FurnitureRepairRefinishing" "FurnitureHomeFurnishingsAndEquipmentStoresExceptAppliances" "FurriersAndFurShops" "GeneralServices" "GiftCardNoveltyAndSouvenirShops" "GlassPaintAndWallpaperStores" "GlasswareCrystalStores" "GolfCoursesPublic" "GovernmentServices" "GroceryStoresSupermarkets" "HardwareStores" "HardwareEquipmentAndSupplies" "HealthAndBeautySpas" "HearingAidsSalesAndSupplies" "HeatingPlumbingAC" "HobbyToyAndGameShops" "HomeSupplyWarehouseStores" "Hospitals" "HotelsMotelsAndResorts" "HouseholdApplianceStores" "IndustrialSupplies" "InformationRetrievalServices" "InsuranceDefault" "InsuranceUnderwritingPremiums" "IntraCompanyPurchases" "JewelryStoresWatchesClocksAndSilverwareStores" "LandscapingServices" "Laundries" "LaundryCleaningServices" "LegalServicesAttorneys" "LuggageAndLeatherGoodsStores" "LumberBuildingMaterialsStores" "ManualCashDisburse" "MarinasServiceAndSupplies" "MasonryStoneworkAndPlaster" "MassageParlors" "MedicalServices" "MedicalAndDentalLabs" "MedicalDentalOphthalmicAndHospitalEquipmentAndSupplies" "MembershipOrganizations" "MensAndBoysClothingAndAccessoriesStores" "MensWomensClothingStores" "MetalServiceCenters" "MiscellaneousApparelAndAccessoryShops" "MiscellaneousAutoDealers" "MiscellaneousBusinessServices" "MiscellaneousFoodStores" "MiscellaneousGeneralMerchandise" "MiscellaneousGeneralServices" "MiscellaneousHomeFurnishingSpecialtyStores" "MiscellaneousPublishingAndPrinting" "MiscellaneousRecreationServices" "MiscellaneousRepairShops" "MiscellaneousSpecialtyRetail" "MobileHomeDealers" "MotionPictureTheaters" "MotorFreightCarriersAndTrucking" "MotorHomesDealers" "MotorVehicleSuppliesAndNewParts" "MotorcycleShopsAndDealers" "MotorcycleShopsDealers" "MusicStoresMusicalInstrumentsPianosAndSheetMusic" "NewsDealersAndNewsstands" "NonFiMoneyOrders" "NonFiStoredValueCardPurchaseLoad" "NondurableGoods" "NurseriesLawnAndGardenSupplyStores" "NursingPersonalCare" "OfficeAndCommercialFurniture" "OpticiansEyeglasses" "OptometristsOphthalmologist" "OrthopedicGoodsProstheticDevices" "Osteopaths" "PackageStoresBeerWineAndLiquor" "PaintsVarnishesAndSupplies" "ParkingLotsGarages" "PassengerRailways" "PawnShops" "PetShopsPetFoodAndSupplies" "PetroleumAndPetroleumProducts" "PhotoDeveloping" "PhotographicStudios" "PhotographicPhotocopyMicrofilmEquipmentAndSupplies" "PictureVideoProduction" "PieceGoodsNotionsAndOtherDryGoods" "PlumbingHeatingEquipmentAndSupplies" "PoliticalOrganizations" "PostalServicesGovernmentOnly" "PreciousStonesAndMetalsWatchesAndJewelry" "ProfessionalServices" "PublicWarehousingAndStorage" "QuickCopyReproAndBlueprint" "Railroads" "RealEstateAgentsAndManagersRentals" "RecordStores" "RecreationalVehicleRentals" "ReligiousGoodsStores" "ReligiousOrganizations" "RoofingSidingSheetMetal" "SecretarialSupportServices" "SecurityBrokersDealers" "ServiceStations" "SewingNeedleworkFabricAndPieceGoodsStores" "ShoeRepairHatCleaning" "ShoeStores" "SmallApplianceRepair" "SnowmobileDealers" "SpecialTradeServices" "SpecialtyCleaning" "SportingGoodsStores" "SportingRecreationCamps" "SportsClubsFields" "SportsAndRidingApparelStores" "StampAndCoinStores" "StationaryOfficeSuppliesPrintingAndWritingPaper" "StationeryStoresOfficeAndSchoolSupplyStores" "SwimmingPoolsSales" "TUiTravelGermany" "TailorsAlterations" "TaxPaymentsGovernmentAgencies" "TaxPreparationServices" "TaxicabsLimousines" "TelecommunicationEquipmentAndTelephoneSales" "TelecommunicationServices" "TelegraphServices" "TentAndAwningShops" "TestingLaboratories" "TheatricalTicketAgencies" "Timeshares" "TireRetreadingAndRepair" "TollsBridgeFees" "TouristAttractionsAndExhibits" "TowingServices" "TrailerParksCampgrounds" "TransportationServices" "TravelAgenciesTourOperators" "TruckStopIteration" "TruckUtilityTrailerRentals" "TypesettingPlateMakingAndRelatedServices" "TypewriterStores" "USFederalGovernmentAgenciesOrDepartments" "UniformsCommercialClothing" "UsedMerchandiseAndSecondhandStores" "Utilities" "VarietyStores" "VeterinaryServices" "VideoAmusementGameSupplies" "VideoGameArcades" "VideoTapeRentalStores" "VocationalTradeSchools" "WatchJewelryRepair" "WeldingRepair" "WholesaleClubs" "WigAndToupeeStores" "WiresMoneyOrders" "WomensAccessoryAndSpecialtyShops" "WomensReadyToWearStores" "WreckingAndSalvageYards"
taxCountry
required
string (Country)

ISO-3166 two letter country code for where the merchant is a tax resident.

Enum: "AU" "NZ" "ZA"
tradingCountry
string (Country)

ISO-3166 two letter country code for where the merchant is a tax resident.

Enum: "AU" "NZ" "ZA"
taxId
required
string

The registered tax id of the company, eg. ABN, NZBN

required
object (BusinessContactPerson)
contactEmail
required
string
supportEmail
string
phoneNo
required
string

Phone number in E164 format, eg. +61400000000

required
object (LimeAddress)
brandName
required
string

The customer facing name of your business.

cardStatementName
required
string

The label that will appear on your customer's credit or debit card statements

smsSenderName
required
string

Sms Sender Name

required
object (BusinessVerificationDoc)
Responses
200
400
401
403
404
405
406
409
422
429
500
503
post/marketplaces/merchants/{merchantId}
Request samples
application/json
{
  • "timeZone": "Australia/Sydney",
  • "businessName": "string",
  • "businessType": "company",
  • "companyType": "Private",
  • "website": "string",
  • "supportSite": "string",
  • "industry": "AcRefrigerationRepair",
  • "taxCountry": "AU",
  • "tradingCountry": "AU",
  • "taxId": "string",
  • "contactPerson": {
    },
  • "contactEmail": "lucy.diamond@star.com",
  • "supportEmail": "lucy.diamond@star.com",
  • "phoneNo": "+61401234567",
  • "address": {
    },
  • "brandName": "string",
  • "cardStatementName": "string",
  • "smsSenderName": "string",
  • "verificationDocs": {
    }
}
Response samples
application/json
{
  • "statusCode": 0,
  • "errorCode": "string",
  • "message": "string",
  • "tracer": "string",
  • "detail": "string",
  • "errorTypeDescription": "string"
}
Copyright © April Solutions 2023. All right reserved.