Skip to main content
POST
/
api
/
adm
/
projectPaymentProcessors
/
{id}
/
active
Update Processor Active Status
curl --request POST \
  --url https://localhost:44371/api/adm/projectPaymentProcessors/{id}/active \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "isActive": true
}
'
{
  "success": true,
  "code": 200,
  "errorMessage": null
}

​
Description

Provides a lightweight way to activate or deactivate a payment processor without submitting the full configuration including sensitive credentials. Useful for testing failover, temporarily suspending during maintenance, or quickly re-enabling processors.

​
Input

  • Path Parameter: id (guid, required) — Unique identifier of processor configuration.
  • Body: model (ProjectPaymentProcessorActiveUpdateCommandRequest, required) — Status change including:
    • id (guid, required) — Configuration identifier (must match path parameter).
    • isActive (bool, required) — New active status.

​
Output

Returns a ProjectPaymentProcessorActiveUpdateCommandResponse indicating whether status update was successful.

​
Example Request

POST /api/admin/project-payment-processors/9ba85f64-5717-4562-b3fc-2c963f66afa7/active
Content-Type: application/json
Authorization: Bearer {token}

{
  "id": "9ba85f64-5717-4562-b3fc-2c963f66afa7",
  "isActive": false
}

​
Example Response

{
  "success": true,
  "code": 200,
  "errorMessage": null
}

​
Errors

  • 400 Bad Request — Invalid processor ID, missing isActive field, cannot deactivate only active processor, or already in requested state.
  • 404 Not Found — Configuration not found with specified ID.

​
Notes

  • Status change takes effect immediately for new transaction routing.
  • In-flight transactions continue processing regardless of status change.
  • Deactivating preserves all settings and credentials.
  • Use cases: failover testing, maintenance windows, incident response, gradual rollout.
  • UpdateEntryActive for quick status toggle; UpdateEntry for credential rotation.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
string<guid>
required

The unique identifier of the processor configuration.

Body

application/json

The status change request containing the new active status (true/false).

Represents the payload required to update only the active state of a processor configuration.

​
id
string<guid>

The identifier of the processor configuration to update.

​
isActive
boolean

Indicates whether the processor configuration should be active.

Response

Always returned. Check the success property in the response body to determine if the operation succeeded.

Standard response structure containing operation status and error information. Standard command response indicating the result of a data modification. Represents the response returned after the active status of a processor configuration is updated.

​
success
boolean

True if the operation completed successfully; false if an error occurred.

Example:

true

​
code
enum<string>

Result code indicating the outcome of the operation.

Available options:
Unknown,
Success,
BadRequest,
Unauthorized,
NotFound,
Error
Example:

200

​
errorMessage
string | null

Human-readable error message when an error occurs.

Example:

null