Skip to main content
GET
/
api
/
adm
/
projectPaymentProcessors
Get Payment Processor Configurations
curl --request GET \
  --url https://localhost:44371/api/adm/projectPaymentProcessors \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "entries": []
}

Documentation Index

Fetch the complete documentation index at: https://docs.chargeworx.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Description

Queries payment processor configurations across the platform. Results can be filtered by project ID to view all processors configured for a specific project, or queried without filters to view all configurations. Useful for dashboards, monitoring, and audits.

​
Input

  • Query Parameters: model (ProjectPaymentProcessorQueryRequest) — Filtering options including:
    • companyProjectId (guid, optional) — Filter by project identifier.
    • isActive (bool, optional) — Filter by active status.
    • limit (int, optional) — Maximum records to return.
    • offset (int, optional) — Records to skip for pagination.

​
Output

Returns a ProjectPaymentProcessorQueryResponse containing matching configurations or an empty list.

​
Example Request

GET /api/admin/project-payment-processors?companyProjectId=3fa85f64-5717-4562-b3fc-2c963f66afa6&isActive=true
Authorization: Bearer {token}

​
Example Response

{
  "success": true,
  "code": 200,
  "errorMessage": null,
  "entries": [
    {
      "id": "9ba85f64-5717-4562-b3fc-2c963f66afa7",
      "companyProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "projectPaymentProcessorName": "Production CyberSource",
      "gateway": 1,
      "paymentType": 1,
      "isActive": true,
      "createdDate": "2025-01-15T10:30:00Z"
    }
  ]
}

​
Errors

  • 400 Bad Request — Invalid query parameters or filter values.
  • 401 Unauthorized — Missing or invalid authentication token.

​
Notes

  • Use companyProjectId to filter by project.
  • Use isActive to filter by active/inactive status.
  • SettingsJson not included in responses for security.
  • Empty results return success with empty entries array.

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
CompanyProjectId
string<guid> | null

The identifier of the company project to filter processors by.

​
Id
string<guid> | null

Optional identifier to filter results by a specific entity.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Response

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

Represents a paginated collection of project payment processor configurations.

​
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

​
entries
object[] | null

Collection of entities matching the query criteria.

Example:
[]