Submerchants

create submerchant creates a new submerchant resource request method post endpoint /submerchants content type application/json request body the request body should be a json object containing the following properties property type required description isactive boolean no indicates whether the submerchant is active default is true payoutswithheld boolean no indicates whether payouts are withheld for the submerchant default is false payoutswithheldreason string no the reason for withholding payouts required when payoutswithheld is true must be one of the allowed payoutswithheldreasons payoutswithheldmessage string no the message associated with withholding payouts required when payoutswithheld is true name string yes the name of the submerchant legalname string no the legal name of the submerchant businesstype string no the type of business default is sole proprietorship must be one of the allowed businesstypes businessregistrationnumber string no the business registration number required when businesstype is not sole proprietorship phonenumber string yes the phone number of the submerchant in e 164 format secondaryphonenumber string no the secondary phone number of the submerchant in e 164 format emailaddress string no the email address of the submerchant websiteurl string no the website url of the submerchant addressline1 string yes the first line of the submerchant's address addressline2 string no the second line of the submerchant's address addressline3 string no the third line of the submerchant's address addresscity string yes the city/town of the submerchant's address regioncode string yes the region code of the submerchant's address must be one of the allowed regioncodes postcode string yes the postcode of the submerchant's address countrycode string yes the country code of the submerchant's address must be one of the allowed countrycodes currencycode string no the currency code for the submerchant default is gbp must be one of the allowed currencycodes inheritoperatordbainfo boolean no indicates whether to inherit dba information from the operator language string no the language code for the submerchant default is en must be one of the allowed languagecodes signatory object yes the signatory object representing the submerchant's signatory must conform to the signatoryschema significantowners array yes an array of significant owner objects representing the submerchant's significant owners each object must conform to the significantownerschema merchantcategorycode string yes the merchant category code (mcc) for the submerchant must be a valid mcc number merchantid string yes the id of the associated merchant (note this will be removed in the future) paymentfacilitatorid string yes the id of the associated payment facilitator (note this will become required in the future) operatorid string no the id of the associated operator reference string no an optional reference for the submerchant note string no an optional note for the submerchant businessdescription string no a description of the submerchant's business maximum length is 400 characters response status code 201 created content type application/json the response body will contain the created submerchant resource errors 400 bad request the request body is invalid or missing required fields 401 unauthorized the request lacks valid authentication credentials 403 forbidden the authenticated user does not have sufficient permissions to create a submerchant 500 internal server error an unexpected error occurred on the server