POST
/
merchants
/
accounts
/
suspend
cURL
curl -X POST "https://dev.api.onekhusa.com/sandbox/v1/merchants/accounts/suspend" \
  --header "Authorization: Bearer your-jwt-token" \
  --header "Content-Type: application/json" \
  --header "Accept-Language: en" \
  -d '{
    "merchantAccountNumber": 35253486,
    "changedBy": "johndoe@example.com",
    "comments": "Merchant account suspended pending compliance documentation",
    "reasonId": 2
  }'
"Merchant account has been suspended successfully"

Authorizations

ā€‹
Authorization
string
header
required

Bearer authentication header of the form Bearer Token, Where accessToken is the access token used to authenticate the request.

Headers

ā€‹
Accept-Language
string
default:en

Preferred language for the response

Body

application/json
ā€‹
merchantAccountNumber
integer
required

The unique identifier of the merchant account to suspend

Example:

35253486

ā€‹
changedBy
string<email>
required

Email address of the user suspending the merchant

Example:

"johndoe@example.com"

ā€‹
reasonId
integer
required

The unique identifier of the reason category for this status change

Example:

2

ā€‹
comments
string

Additional comments or notes about the suspension

Example:

"Merchant account suspended pending compliance documentation"

Response

200 - application/json

OK - Merchant successfully suspended

The response is of type string.

Example:

"Merchant account has been suspended successfully"