Skip to main content
DELETE
/
api
/
adm
/
projectPaymentProcessors
/
{id}
Delete Payment Processor Configuration
curl --request DELETE \
  --url https://localhost:44371/api/adm/projectPaymentProcessors/{id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "code": 200,
  "errorMessage": null
}

​
Description

Performs a soft delete on a payment processor configuration. The configuration is marked as deleted but not physically removed, preserving historical transaction records. Soft-deleted processors cannot be reactivated.

​
Input

  • Path Parameter: id (guid, required) — Unique identifier of the processor configuration to delete.

​
Output

Returns a ProjectPaymentProcessorDeleteCommandResponse indicating whether deletion was successful.

​
Example Request

DELETE /api/admin/project-payment-processors/9ba85f64-5717-4562-b3fc-2c963f66afa7
Authorization: Bearer {token}

​
Example Response

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

​
Errors

  • 400 Bad Request — Invalid processor ID, cannot delete active processor, or cannot delete last processor.
  • 404 Not Found — Configuration not found with specified ID.
  • 409 Conflict — Cannot delete only active processor with active transactions.

​
Notes

  • Soft delete preserves configuration for historical audit trails.
  • Deleted processors don’t appear in standard queries.
  • Historical transactions retain processor association.
  • Deactivate vs Delete: use deactivate for temporary suspension, delete for permanent removal.

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 to delete.

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 a processor configuration is deleted.

​
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