Skip to main content
POST
/
processors
/
{id}
/
suspend
Suspend a processor
curl --request POST \
  --url https://olive-gateway-a6ba.onrender.com/api/v1/processors/{id}/suspend \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Suspected fraudulent activity"
}
'
{}

​
Suspend Processor

Suspend a processor to prevent them from processing transactions.

​
Endpoint

POST /api/v1/processors/:id/suspend

​
Authentication

​
Authorization
string
required
Bearer token (Admin JWT)

​
Path Parameters

​
id
string
required
Processor UUID

​
Request Body

​
reason
string
Suspension reason (e.g., “Suspected fraudulent activity”)

​
Response

{
  "success": true,
  "message": "Processor suspended successfully"
}

​
Effects

  • Processor status changes to suspended
  • All POS transactions are rejected
  • Dashboard access is blocked
  • API key is deactivated

​
Errors

CodeDescription
400Invalid request
404Processor not found
401Unauthorized

Authorizations

​
Authorization
string
header
required

JWT token from admin login for administrative operations. Format: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'

Path Parameters

​
id
string
required

Processor ID

Body

application/json

Suspension reason

​
reason
string
Example:

"Suspected fraudulent activity"

Response

Processor suspended successfully

The response is of type object.