Update Merchant

Endpoint

PUT /api/v2/{merchantId}

Header parameters

Header	Type	Required	Description
Ocp-Apim-Subscription-Key	string	Yes	Your PaySuite subscription key
Content-Type	string	Yes	application/json

Path Parameters

Parameter	Type	Required	Description
merchantId	uuid	Yes	Unique merchant identifier

Request parameters

Parameter	Type	Required	Description
divisionAccountId	string max(100)	required	A PaySuite created Account Id to identify the SoftCo. This will be provided to the SoftCo during the project setup
customerId	string max(100)	required	A unique identifier for the customer in the SoftCo product. This will be returned in the webhook events and should be used to identify the customer in the SoftCo product.
returnUrl	string	required	URL to redirect after onboarding completion. This redirect will happen trigger after the Stripe hosted onboarding flow has been completed (or cancelled) by the customer.
evo	object	required	Object to provide the required details for the Evo platform. See Evo object

Payload example

Payment Gateway stripe example

{
    "divisionAccountId": "<string>",
    "customerId": "<string>",
    "returnUrl": "<url>",
    "evo": {
        "organisationId": "<GUID>",
        "customerReference": "<Finance CuCode>"
    }
}

Response parameters

Status Code: 201 Created

Parameter	Type	Description
divisionAccountId	string	As provided in the request.
customerId	string	As provided in the request.
merchantId	uuid	A PaySuite ID used for future queries to obtain the onboarding status.
sessionId	string	A unique identifier to track the session.
traceId	string	A unique trace identifier for the request.
action	object	Object containing the action to be performed by the SoftCo product.
→ type	string	Identifies the type of action to perform. Will either return redirect or embed based on the Soft Co settings
→ redirectUrl	string	(conditional) If type is redirect. The URL to redirect the customer to start the onboarding journey. Use this to initiate the Redirect MFE Onboarding journey.
→ stripe.connectAccountId	string	The Stripe Connect identifier for the customer.
→ stripe.clientSecret	string	(conditional) If type is embed. The Stripe Connect identifier for the customer. Use this to initiate the Stripe Onboarding component, see embedded onboarding

Payload redirect example

{
  "divisionAccountId": "<string>",
  "customerId": "<string>",
  "merchantId": "<string>",
  "sessionId": "<string>",
  "traceId": "<string>",
  "action": {
    "type": "redirect",
    "redirectUrl": "<URL>",
    "stripe": {
        "connectAccountId": "<string>"
    }
  }
}

Payload embedded example

{
  "divisionAccountId": "<string>",
  "customerId": "<string>",
  "merchantId": "<string>",
  "sessionId": "<string>",
  "traceId": "<string>",
  "action": {
    "type": "embed",
    "stripe": {
        "connectAccountId": "<string>",
        "clientSecret": "<string>"
    }
  }
}