Update a sub-merchant.
PUT {{baseUrl}}/sub-merchants/{{guid}}
Returns sub-merchant object with status.
Request Body
{"name"=>"{{$randomCompanyName}}", "categoryCode"=>"3002", "orderAvailabilityDateTime"=>"2021-10-18T13:56:47.123+00:00", "orderHistoryMonths"=>5, "orderLatencyDays"=>5, "industryCode"=>"ACC", "primaryContact"=>{"jobTitle"=>"Manager", "firstName"=>"{{$randomFirstName}}", "lastName"=>"{{$randomLastName}}", "email"=>"{{$randomExampleEmail}}", "phone"=>"1-234-567-8901"}, "legalAddress"=>{"website"=>"https://merchantwebsite.example.com", "addressLine1"=>"223 Blythwood Rd", "addressLine2"=>"Suite 123", "countryCode"=>"CAN", "regionCode"=>"ON", "city"=>"Toronto", "postalCode"=>"M4N1A7", "email"=>"customerservice.merchant@example.com", "phone"=>"1-234-567-8901"}, "merchantType"=>"SUB_MERCHANT", "locales"=>[{"code"=>"EN_CA", "merchantDescription"=>"An airline that no longer exists.", "defaultLocale"=>true}], "locations"=>[{"addressLine1"=>"223 Blythwood Rd", "addressLine2"=>"Suite 123", "city"=>"Toronto", "postalCode"=>"M4N1A7", "displayAddressToCardHolder"=>true, "website"=>"https://merchantwebsite.example.com/customerservice.html", "email"=>"customerservice.merchant@example.com", "contactWebsite"=>"https://merchantwebsite.example.com/contactus.html", "phone"=>"1-234-567-8901", "displayPhoneToCardHolder"=>true, "refundPolicy"=>"Complete merchant refund policy", "terms"=>"Entire merchant Terms & Conditions", "customerServiceInstructions"=>"Include Transaction ID in all communications.", "additionalInfo"=>"Customers can contact merchants for a refund 24 hours a day.", "regionCode"=>"ON", "countryCode"=>"can", "termsWebsite"=>"https://merchantwebsite.example.com/terms.html", "refundPolicyWebsite"=>"https://merchantwebsite.example.com/refunds.html", "defaultLocation"=>true, "cardAcceptorNames"=>["{{$randomCompanyName}} {{$randomInt}}"], "cardAcceptorLocation"=>"Pan American Airlines Canada", "cardAcceptorLocationType"=>"CARD_PRESENT"}], "contentTypes"=>["ADULT_LANGUAGE"], "crm"=>{"termsConditionsConsent"=>{"date"=>"2022-06-13T13:30:06.792Z", "firstName"=>"{{$randomFirstName}}", "lastName"=>"{{$randomLastName}}", "jobTitle"=>"Manager", "email"=>"{{$randomExampleEmail}}", "countryCode"=>"CAN", "consentUuid"=>"3d94ab7b-fe1c-4f7d-ad4c-93c1eb6d29c3", "consentVersion"=>"10"}, "paymentConfirmation"=>true}, "businessType"=>"BUSINESS_CORPORATION", "subMerchantIdentifier"=>"{{$randomPassword}}", "searchFields"=>[{"searchParameter"=>"ACQUIRER_REFERENCE_NUMBER", "required"=>true, "searchFieldCards"=>["AMEX"]}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
User-Id | string | (Required) The user id of the submitter/technical contact. | |
Submitter-First-Name | string | (Required) The first name of the submitter/technical contact. | |
Submitter-Last-Name | string | (Required) The last name of the submitter/technical contact. | |
Content-Type | string | ||
Accept | string | ||
If-Match | string |
RESPONSES
status: OK
{"name":"Pan American Airlines","industryCode":"ACC","primaryContact":{"jobTitle":"Manager","firstName":"John","lastName":"Doe","email":"john.doe@example.com","phone":"1-234-567-8901"},"legalAddress":{"countryCode":"CAN","website":"https://merchantwebsite.example.com","addressLine1":"223 Blythwood Rd","addressLine2":"Suite 123","regionCode":"ON","city":"Toronto","postalCode":"M4N1A7","email":"customerservice.merchant@example.com","phone":"1-234-567-8901"},"categoryCode":"3002","orderAvailabilityDateTime":"2021-10-18T13:56:47.123+00:00","orderHistoryMonths":5,"orderLatencyDays":5,"merchantType":"SUB_MERCHANT","guid":"jK2dA5aybhQQBq6C","status":"LIVE","locales":[{"merchantDescription":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"code":"en-CA","defaultLocale":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"locations":[{"countryCode":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"defaultLocation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"addressLine1":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"addressLine2":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"city":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"postalCode":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"displayAddressToCardHolder":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"website":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"contactWebsite":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"phone":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"displayPhoneToCardHolder":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"refundPolicy":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"terms":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"customerServiceInstructions":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"additionalInfo":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"acceptedPaymentTypes":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"regionCode":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"termsWebsite":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"refundPolicyWebsite":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"cardAcceptorNames":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"cardAcceptorLocation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"cardAcceptorLocationType":"Online","rejectedCardAcceptorNames":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"contentTypes":["ADULT_LANGUAGE"],"validationStatus":{"messages":[{"Source":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"ReasonCode":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Description":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Recoverable":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Details":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"Source":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"ReasonCode":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Description":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Recoverable":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Details":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"contactUs":"Please reach out to Mastercard/Ethoca customer success team for any questions or concerns."},"crm":{"termsConditionsConsent":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"paymentConfirmation":true,"sanctionScreeningStatus":"APPROVED","billingAccountCreated":true,"salesforceAccountNumber":"TY12SS33ERYUIOPDDSS34XX"},"subMerchantIdentifier":"GHF5F67DFSD468GJJXH78","searchFields":[{"searchParameter":"cardAcceptorName","required":true,"searchFieldCards":["AMEX"]},{"searchParameter":"cardAcceptorName","required":true,"searchFieldCards":["AMEX"]}]}