PIpismo
Merchant

Update merchant status

Update merchant status using the merchant ID.

To find all available merchant status transitions, use List status transitions.

This endpoint generates a Merchant updated event.

put/v1/merchants/{merchantId}/workflow/status

Request

  • Base URL
    https://sandbox.pismolabs.io/merchants
  • URL
    https://sandbox.pismolabs.io/merchants/v1/merchants/{merchantId}/workflow/status
  • Auth
    HTTP bearer

Path parameters

merchantIdinteger required
Example:1

Merchant ID

Headers

Content-Typestring
Example:application/json

Content type

Authorizationstring
Example:Bearer 1JI12J39182H39182JDIOAWJ%=

Authorization token. This is a regular access token, which does not need to include an account ID.

Request body

statusstring required

Merchant status. This is a string, not an enum, so any string value is allowed, but the most commonly used values are: 'ACTIVE', 'ANALYSING', 'APPROVED', 'CANCELLED', 'PENDING', 'REJECTED'

notesstring

Notes about the operation.

<b>Note</b>: This field is <b>deprecated</b> and scheduled for removal.

Example request

{
  "status": "APPROVED",
  "notes": "This is a status change."
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.