Update Merchant

Endpoint

PUT /api/{merchantId}

Header parameters

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

Request parameters

Parameter	Type	Required	Description
stripePlatformAccountId	string max(100)	required	A Stripe Platform account Id. This will be provided to the SoftCo during SoftCo registration
redirectUrl	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.
stripePriceGroupId	string max(100)	optional	Stripe pricing group identifier. This must be an active Stripe price group id obtained from PaySuite during project setup. If no value provided, the default pricing scheme will be applied to the customer.

Payload example

{
  "stripePlatformAccountId": "acct_platform123",
  "redirectUrl": "https://example.com/onboarding/complete",
  "stripePriceGroupId": "price_group_456"
}

Response parameters

Status Code: 200 OK

Parameter	Type	Description
merchantId	uuid	A unique identifier for the customer created by the Merchant API.
customerId	string	A unique identifier for the customer in the SoftCo product.
sessionId	string	A unique identifier to track the session.
action	object	Object containing the action to be performed by the SoftCo product.
→ redirectUrl	string	(conditional) The URL to redirect the customer to being the onboarding journey. Note: this will only be returned if there is further data to be collected from the customer and the integration is via a redirect onboarding
→ stripeConnectAccountId	string	(conditional) The Stripe Connect identifier for the customer. Note: this will only be returned if the integration is via embedded onboarding.
→ stripeClientSecret	string	(conditional) The Stripe Connect identifier for the customer. Note: this will only be returned if the integration is via embedded onboarding

Payload redirect example

{
  "merchantId": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "customer_123",
  "sessionId": "66c0df2ec03d8a3b582e615b83274816",
  "action": {
    "redirectUrl": "https://creditRiskAssessmentUrl.com"
  }
}

Payload embedded example

{
  "merchantId": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "customer_123",
  "sessionId": "66c0df2ec03d8a3b582e615b83274816",
  "action": {
    "stripeConnectAccountId": "acct_12345"
    "stripeClientSecret": "client_secret_67890",
  }
}