Management API reference
Generated from
docs-site/public/management-api/openapi.jsonat build time. Do not edit this page by hand — change the OpenAPI document (or the annotations in the Control Plane) and rebuild.
OpenAPI version: 3.0.1 · Operations: 153
Servers:
http://localhost:0/api/v1— Local sandboxhttps://testapi.hokeka.com/api/v1— Sandbox / testhttps://api.hokeka.com/api/v1— Production
For an interactive "try it" console, run the Control Plane and open its Swagger UI (/swagger-ui.html). This page is the stable, searchable reference.
Operations at a glance
| Method | Path | Summary | Tag |
|---|---|---|---|
GET | /admin/decision-orchestrator | Admin - List | decision-orchestrator-admin-controller |
PUT | /admin/decision-orchestrator | Admin - Update | decision-orchestrator-admin-controller |
POST | /admin/onboarding/invites | Admin - Create | onboarding-invite-admin-controller |
GET | /admin/onprem/instances | Admin - List | on-prem-instance-admin-controller |
POST | /admin/onprem/instances | Admin - Create | on-prem-instance-admin-controller |
GET | /admin/onprem/instances/{id} | Admin - Get | on-prem-instance-admin-controller |
PUT | /admin/onprem/instances/{id}/approved-days | Admin - Update | on-prem-instance-admin-controller |
PUT | /admin/onprem/instances/{id}/revoke | Admin - Update | on-prem-instance-admin-controller |
PUT | /admin/onprem/instances/{id}/suspend | Admin - Update | on-prem-instance-admin-controller |
GET | /admin/psp-api-keys | Admin - List | psp-api-key-admin-controller |
POST | /admin/psp-api-keys | Admin - Create | psp-api-key-admin-controller |
DELETE | /admin/psp-api-keys/{id} | Admin - Delete | psp-api-key-admin-controller |
POST | /admin/psp-api-keys/{id}/rotate | Admin - Create | psp-api-key-admin-controller |
POST | /admin/psp-billing/{pspId}/invoice/generate | Admin - Create | psp-admin-billing-controller |
GET | /admin/psp-billing/{pspId}/invoices | Admin - Get | psp-admin-billing-controller |
POST | /admin/psp-billing/{pspId}/notify | Admin - Create | psp-admin-billing-controller |
GET | /admin/psp-billing/{pspId}/usage | Admin - Get | psp-admin-billing-controller |
GET | /admin/psp-billing/summary | Admin - List | psp-admin-billing-controller |
GET | /admin/psps/{pspId}/billing-rates | Admin - Get | billing-rate-admin-controller |
POST | /admin/psps/{pspId}/billing-rates | Admin - Create | billing-rate-admin-controller |
PUT | /admin/psps/{pspId}/billing-rates/{rateId} | Admin - Update | billing-rate-admin-controller |
DELETE | /admin/psps/{pspId}/billing-rates/{rateId} | Admin - Delete | billing-rate-admin-controller |
GET | /admin/runtime-errors | Admin - List | runtime-error-controller |
GET | /audit/logs | Audit - List | audit-log-controller |
GET | /audit/logs/entity | Audit - List | audit-log-controller |
GET | /audit/logs/range | Audit - List | audit-log-controller |
GET | /audit/logs/user/{username} | Audit - Get | audit-log-controller |
GET | /audit/logs/verify | Audit - List | audit-log-controller |
GET | /auth/permissions | Auth - List | role-permission-controller |
GET | /auth/role-permissions | Auth - List | role-permission-controller |
GET | /auth/roles | Auth - List | role-permission-controller |
POST | /console/exports | Console export - Create | console-list-export-controller |
GET | /console/exports/jobs/{jobUuid} | Console export - Get | console-list-export-controller |
GET | /console/exports/jobs/{jobUuid}/download | Console export - Get | console-list-export-controller |
GET | /edge/nodes | Edge - List | edge-admin-controller |
POST | /edge/nodes | Edge - Create | edge-admin-controller |
GET | /edge/nodes/{id} | Edge - Get | edge-admin-controller |
POST | /edge/nodes/{id}/approve | Edge - Create | edge-admin-controller |
POST | /edge/nodes/{id}/reject | Edge - Create | edge-admin-controller |
POST | /edge/nodes/{id}/revoke | Edge - Create | edge-admin-controller |
POST | /edge/nodes/{id}/suspend | Edge - Create | edge-admin-controller |
GET | /edge/nodes/analytics | Edge - List | edge-admin-controller |
GET | /psps | PSP - List | psp-controller |
POST | /psps | PSP - Create | psp-controller |
GET | /psps/{id} | PSP - Get | psp-controller |
PUT | /psps/{id} | PSP - Update | psp-controller |
DELETE | /psps/{id} | PSP - Delete | psp-controller |
GET | /psps/{id}/cbk-config | PSP - Get | psp-controller |
PUT | /psps/{id}/cbk-config | PSP - Update | psp-controller |
PUT | /psps/{id}/kyc-config | PSP - Update | psp-controller |
GET | /psps/{id}/signal-settings | PSP - Get | psp-controller |
PUT | /psps/{id}/signal-settings | PSP - Update | psp-controller |
PUT | /psps/{id}/status | PSP - Update | psp-controller |
GET | /psps/{pspId}/cbk/customer-complaints | PSP - Get | psp-customer-complaint-controller |
POST | /psps/{pspId}/cbk/customer-complaints | PSP - Create | psp-customer-complaint-controller |
GET | /psps/{pspId}/cbk/customer-complaints/{id} | PSP - Get | psp-customer-complaint-controller |
PUT | /psps/{pspId}/cbk/customer-complaints/{id} | PSP - Update | psp-customer-complaint-controller |
DELETE | /psps/{pspId}/cbk/customer-complaints/{id} | PSP - Delete | psp-customer-complaint-controller |
GET | /psps/{pspId}/cbk/cyber-incidents | PSP - Get | psp-cyber-incident-controller |
POST | /psps/{pspId}/cbk/cyber-incidents | PSP - Create | psp-cyber-incident-controller |
GET | /psps/{pspId}/cbk/cyber-incidents/{id} | PSP - Get | psp-cyber-incident-controller |
PUT | /psps/{pspId}/cbk/cyber-incidents/{id} | PSP - Update | psp-cyber-incident-controller |
DELETE | /psps/{pspId}/cbk/cyber-incidents/{id} | PSP - Delete | psp-cyber-incident-controller |
GET | /psps/{pspId}/cbk/directors | PSP - Get | psp-director-controller |
POST | /psps/{pspId}/cbk/directors | PSP - Create | psp-director-controller |
GET | /psps/{pspId}/cbk/directors/{id} | PSP - Get | psp-director-controller |
PUT | /psps/{pspId}/cbk/directors/{id} | PSP - Update | psp-director-controller |
DELETE | /psps/{pspId}/cbk/directors/{id} | PSP - Delete | psp-director-controller |
GET | /psps/{pspId}/cbk/fraud-incidents | PSP - Get | psp-fraud-incident-controller |
POST | /psps/{pspId}/cbk/fraud-incidents | PSP - Create | psp-fraud-incident-controller |
GET | /psps/{pspId}/cbk/fraud-incidents/{id} | PSP - Get | psp-fraud-incident-controller |
PUT | /psps/{pspId}/cbk/fraud-incidents/{id} | PSP - Update | psp-fraud-incident-controller |
DELETE | /psps/{pspId}/cbk/fraud-incidents/{id} | PSP - Delete | psp-fraud-incident-controller |
GET | /psps/{pspId}/cbk/products | PSP - Get | psp-product-controller |
POST | /psps/{pspId}/cbk/products | PSP - Create | psp-product-controller |
GET | /psps/{pspId}/cbk/products/{id} | PSP - Get | psp-product-controller |
PUT | /psps/{pspId}/cbk/products/{id} | PSP - Update | psp-product-controller |
DELETE | /psps/{pspId}/cbk/products/{id} | PSP - Delete | psp-product-controller |
GET | /psps/{pspId}/cbk/senior-management | PSP - Get | psp-senior-management-controller |
POST | /psps/{pspId}/cbk/senior-management | PSP - Create | psp-senior-management-controller |
GET | /psps/{pspId}/cbk/senior-management/{id} | PSP - Get | psp-senior-management-controller |
PUT | /psps/{pspId}/cbk/senior-management/{id} | PSP - Update | psp-senior-management-controller |
DELETE | /psps/{pspId}/cbk/senior-management/{id} | PSP - Delete | psp-senior-management-controller |
GET | /psps/{pspId}/cbk/shareholders | PSP - Get | psp-shareholder-controller |
POST | /psps/{pspId}/cbk/shareholders | PSP - Create | psp-shareholder-controller |
GET | /psps/{pspId}/cbk/shareholders/{id} | PSP - Get | psp-shareholder-controller |
PUT | /psps/{pspId}/cbk/shareholders/{id} | PSP - Update | psp-shareholder-controller |
DELETE | /psps/{pspId}/cbk/shareholders/{id} | PSP - Delete | psp-shareholder-controller |
GET | /psps/{pspId}/cbk/system-interruptions | PSP - Get | psp-system-interruption-controller |
POST | /psps/{pspId}/cbk/system-interruptions | PSP - Create | psp-system-interruption-controller |
GET | /psps/{pspId}/cbk/system-interruptions/{id} | PSP - Get | psp-system-interruption-controller |
PUT | /psps/{pspId}/cbk/system-interruptions/{id} | PSP - Update | psp-system-interruption-controller |
DELETE | /psps/{pspId}/cbk/system-interruptions/{id} | PSP - Delete | psp-system-interruption-controller |
GET | /psps/{pspId}/cbk/tariffs | PSP - Get | psp-tariff-template-controller |
POST | /psps/{pspId}/cbk/tariffs | PSP - Create | psp-tariff-template-controller |
GET | /psps/{pspId}/cbk/tariffs/{id} | PSP - Get | psp-tariff-template-controller |
PUT | /psps/{pspId}/cbk/tariffs/{id} | PSP - Update | psp-tariff-template-controller |
DELETE | /psps/{pspId}/cbk/tariffs/{id} | PSP - Delete | psp-tariff-template-controller |
GET | /psps/{pspId}/cbk/tariffs/active | PSP - Get | psp-tariff-template-controller |
GET | /psps/{pspId}/cbk/trust-accounts | PSP - Get | psp-trust-account-controller |
POST | /psps/{pspId}/cbk/trust-accounts | PSP - Create | psp-trust-account-controller |
GET | /psps/{pspId}/cbk/trust-accounts/{id} | PSP - Get | psp-trust-account-controller |
PUT | /psps/{pspId}/cbk/trust-accounts/{id} | PSP - Update | psp-trust-account-controller |
DELETE | /psps/{pspId}/cbk/trust-accounts/{id} | PSP - Delete | psp-trust-account-controller |
GET | /psps/{pspId}/cbk/trustees | PSP - Get | psp-trustee-controller |
POST | /psps/{pspId}/cbk/trustees | PSP - Create | psp-trustee-controller |
GET | /psps/{pspId}/cbk/trustees/{id} | PSP - Get | psp-trustee-controller |
PUT | /psps/{pspId}/cbk/trustees/{id} | PSP - Update | psp-trustee-controller |
DELETE | /psps/{pspId}/cbk/trustees/{id} | PSP - Delete | psp-trustee-controller |
GET | /psps/{pspId}/report-config | PSP - Get | psp-reporting-config-controller |
PUT | /psps/{pspId}/report-config | PSP - Update | psp-reporting-config-controller |
GET | /psps/me | PSP - List | psp-controller |
POST | /psps/register | PSP - Create | psp-controller |
POST | /psps/users | PSP - Create | psp-controller |
GET | /roles | Role - List | role-controller |
POST | /roles | Role - Create | role-controller |
GET | /roles/{id} | Role - Get | role-controller |
PUT | /roles/{id} | Role - Update | role-controller |
DELETE | /roles/{id} | Role - Delete | role-controller |
GET | /rules | Rule - List | rules-controller |
POST | /rules | Rule - Create | rules-controller |
GET | /rules/{id} | Rule - Get | rules-controller |
PUT | /rules/{id} | Rule - Update | rules-controller |
DELETE | /rules/{id} | Rule - Delete | rules-controller |
POST | /rules/{id}/disable | Rule - Create | rules-controller |
GET | /rules/{id}/effectiveness | Rule - Get | rules-controller |
POST | /rules/{id}/enable | Rule - Create | rules-controller |
POST | /rules/{id}/rollback | Rule - Create | rules-controller |
GET | /rules/{id}/versions | Rule - Get | rules-controller |
POST | /rules/generate | Rule - Create | rules-controller |
GET | /rules/governance/pending | Rule - List | rules-controller |
POST | /rules/governance/versions/{versionId}/approve | Rule - Create | rules-controller |
POST | /rules/governance/versions/{versionId}/reject | Rule - Create | rules-controller |
POST | /rules/reload | Rule - Create | rules-controller |
GET | /settings | Settings - List | settings-controller |
PUT | /settings | Settings - Update | settings-controller |
GET | /settings/config | Settings - List | settings-controller |
GET | /settings/psps | Settings - List | settings-controller |
GET | /settings/psps/{pspId}/theme | Settings - Get | settings-controller |
PUT | /settings/psps/{pspId}/theme | Settings - Update | settings-controller |
GET | /settings/system | Settings - List | settings-controller |
PUT | /settings/system | Settings - Update | settings-controller |
GET | /settings/themes/presets | Settings - List | settings-controller |
GET | /users | User - List | user-controller |
POST | /users | User - Create | user-controller |
GET | /users/{id} | User - Get | user-controller |
PUT | /users/{id} | User - Update | user-controller |
DELETE | /users/{id} | User - Delete | user-controller |
POST | /users/{id}/{action} | User - Create | user-controller |
PATCH | /users/{id}/toggle | User - Update | user-controller |
POST | /webhooks/subscribe | Webhook - Create | webhook-subscription-controller |
GET | /webhooks/subscriptions | Webhook - List | webhook-subscription-controller |
DELETE | /webhooks/subscriptions/{id} | Webhook - Delete | webhook-subscription-controller |
audit-log-controller
GET /audit/logs
Audit - List
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
page | query | no | integer | |
size | query | no | integer | |
cursor | query | no | string | |
username | query | no | string | |
actionType | query | no | string | |
entityType | query | no | string | |
entityId | query | no | string | |
success | query | no | boolean | |
ipAddress | query | no | string | |
sessionId | query | no | string | |
pspId | query | no | integer | |
start | query | no | string | |
end | query | no | string |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /audit/logs/entity
Audit - List
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
entityType | query | yes | string | |
entityId | query | yes | string | |
page | query | no | integer | |
size | query | no | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /audit/logs/range
Audit - List
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
start | query | yes | string | |
end | query | yes | string | |
page | query | no | integer | |
size | query | no | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /audit/logs/user/{username}
Audit - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
username | path | yes | string | |
page | query | no | integer | |
size | query | no | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /audit/logs/verify
Audit - List
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
startId | query | no | integer | |
limit | query | no | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
billing-rate-admin-controller
GET /admin/psps/{pspId}/billing-rates
Admin - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /admin/psps/{pspId}/billing-rates
Admin - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
rateId | integer | |
psp | object | |
serviceType | string | |
pricingModel | string | |
baseRate | number | |
currency | string | |
tierConfig | object | |
monthlyFee | number | |
includedRequests | integer | |
overageRate | number | |
effectiveFrom | string | |
effectiveTo | string | |
isActive | boolean | |
description | string | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /admin/psps/{pspId}/billing-rates/{rateId}
Admin - Delete
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
rateId | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /admin/psps/{pspId}/billing-rates/{rateId}
Admin - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
rateId | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
rateId | integer | |
psp | object | |
serviceType | string | |
pricingModel | string | |
baseRate | number | |
currency | string | |
tierConfig | object | |
monthlyFee | number | |
includedRequests | integer | |
overageRate | number | |
effectiveFrom | string | |
effectiveTo | string | |
isActive | boolean | |
description | string | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
console-list-export-controller
POST /console/exports
Console export - Create
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
viewType | string | |
format | string | |
filters | object | |
includeCorrelated | boolean | |
recordType | string | |
recordId | string |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /console/exports/jobs/{jobUuid}
Console export - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
jobUuid | path | yes | string |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /console/exports/jobs/{jobUuid}/download
Console export - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
jobUuid | path | yes | string |
Responses
| Status | Description |
|---|---|
200 | OK |
decision-orchestrator-admin-controller
GET /admin/decision-orchestrator
Admin - List
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /admin/decision-orchestrator
Admin - Update
Request body (application/json, required)
Schema: object
Responses
| Status | Description |
|---|---|
200 | OK |
edge-admin-controller
GET /edge/nodes
Edge - List
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | query | no | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /edge/nodes
Edge - Create
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
pspId | integer | |
displayName | string |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /edge/nodes/{id}
Edge - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /edge/nodes/{id}/approve
Edge - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /edge/nodes/{id}/reject
Edge - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /edge/nodes/{id}/revoke
Edge - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /edge/nodes/{id}/suspend
Edge - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /edge/nodes/analytics
Edge - List
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | query | no | integer | |
days | query | no | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
on-prem-instance-admin-controller
GET /admin/onprem/instances
Admin - List
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | query | no | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /admin/onprem/instances
Admin - Create
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
pspId (required) | integer | |
instanceId (required) | string | |
displayName (required) | string | |
approvedDays | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /admin/onprem/instances/{id}
Admin - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /admin/onprem/instances/{id}/approved-days
Admin - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
approvedDays (required) | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /admin/onprem/instances/{id}/revoke
Admin - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /admin/onprem/instances/{id}/suspend
Admin - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
onboarding-invite-admin-controller
POST /admin/onboarding/invites
Admin - Create
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
pspId | integer | |
role | string | |
expiresAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
psp-admin-billing-controller
POST /admin/psp-billing/{pspId}/invoice/generate
Admin - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
month | query | no | string |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /admin/psp-billing/{pspId}/invoices
Admin - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
status | query | no | string |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /admin/psp-billing/{pspId}/notify
Admin - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Request body (application/json, required)
Schema: object
Responses
| Status | Description |
|---|---|
200 | OK |
GET /admin/psp-billing/{pspId}/usage
Admin - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
month | query | no | string |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /admin/psp-billing/summary
Admin - List
Responses
| Status | Description |
|---|---|
200 | OK |
psp-api-key-admin-controller
GET /admin/psp-api-keys
Admin - List
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | query | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /admin/psp-api-keys
Admin - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | query | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /admin/psp-api-keys/{id}
Admin - Delete
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /admin/psp-api-keys/{id}/rotate
Admin - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
psp-controller
GET /psps
PSP - List
Responses
| Status | Description |
|---|---|
200 | OK |
POST /psps
PSP - Create
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
pspCode | string | |
legalName | string | |
tradingName | string | |
country | string | |
registrationNumber | string | |
taxId | string | |
contactEmail | string | |
contactPhone | string | |
contactAddress | string | |
billingPlan | string | |
billingCycle | string | |
currency | string | |
paymentTerms | integer | |
brandingTheme | string | |
logoUrl | string |
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /psps/{id}
PSP - Delete
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /psps/{id}
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /psps/{id}
PSP - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
legalName | string | |
tradingName | string | |
country | string | |
registrationNumber | string | |
taxId | string | |
contactEmail | string | |
contactPhone | string | |
contactAddress | string | |
billingPlan | string | |
billingCycle | string | |
currency | string | |
paymentTerms | integer | |
isTestMode | boolean | |
brandingTheme | string | |
logoUrl | string | |
primaryColor | string | |
secondaryColor | string | |
accentColor | string |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /psps/{id}/cbk-config
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /psps/{id}/cbk-config
PSP - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
cbkInstitutionCode | string | |
cbkReportingEnabled | boolean | |
cbkClientId | string | |
cbkClientSecret | string | |
cbkEnvironment | string | |
cbkAllowLive | boolean |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /psps/{id}/kyc-config
PSP - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | |
enabled | query | yes | boolean |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /psps/{id}/signal-settings
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /psps/{id}/signal-settings
PSP - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Request body (application/json, required)
Schema: object
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /psps/{id}/status
PSP - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
status | string |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /psps/me
PSP - List
Responses
| Status | Description |
|---|---|
200 | OK |
POST /psps/register
PSP - Create
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
pspCode | string | |
legalName | string | |
tradingName | string | |
country | string | |
registrationNumber | string | |
taxId | string | |
contactEmail | string | |
contactPhone | string | |
contactAddress | string | |
billingPlan | string | |
billingCycle | string | |
currency | string | |
paymentTerms | integer | |
brandingTheme | string | |
logoUrl | string |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /psps/users
PSP - Create
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
pspId | integer | |
email | string | |
fullName | string | |
password | string | |
role | string | |
permissions | array |
Responses
| Status | Description |
|---|---|
200 | OK |
psp-customer-complaint-controller
GET /psps/{pspId}/cbk/customer-complaints
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /psps/{pspId}/cbk/customer-complaints
PSP - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
complaintId | string | |
complaintCode | string | |
complainantGender | string | |
complaintFrequency | integer | |
complainantName | string | |
complainantAge | integer | |
complainantContactNumber | string | |
complainantSubCountyLocation | string | |
complainantEducationLevel | string | |
othersComplainantDetails | string | |
agentId | string | |
dateOfOccurrence | string | |
dateReportedToTheInstitution | string | |
dateResolved | string | |
remedialStatus | string | |
amountLost | number | |
amountRecovered | number | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /psps/{pspId}/cbk/customer-complaints/{id}
PSP - Delete
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /psps/{pspId}/cbk/customer-complaints/{id}
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /psps/{pspId}/cbk/customer-complaints/{id}
PSP - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
complaintId | string | |
complaintCode | string | |
complainantGender | string | |
complaintFrequency | integer | |
complainantName | string | |
complainantAge | integer | |
complainantContactNumber | string | |
complainantSubCountyLocation | string | |
complainantEducationLevel | string | |
othersComplainantDetails | string | |
agentId | string | |
dateOfOccurrence | string | |
dateReportedToTheInstitution | string | |
dateResolved | string | |
remedialStatus | string | |
amountLost | number | |
amountRecovered | number | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
psp-cyber-incident-controller
GET /psps/{pspId}/cbk/cyber-incidents
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /psps/{pspId}/cbk/cyber-incidents
PSP - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
incidentNumber | string | |
incidentDate | string | |
locationOfAttacker | string | |
incidentMode | string | |
lossType | string | |
details | string | |
actionTaken | string | |
resolutionDate | string | |
mitigationActions | string | |
amountInvolved | number | |
amountLost | number | |
currency | string | |
createdBy | integer | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /psps/{pspId}/cbk/cyber-incidents/{id}
PSP - Delete
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /psps/{pspId}/cbk/cyber-incidents/{id}
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /psps/{pspId}/cbk/cyber-incidents/{id}
PSP - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
incidentNumber | string | |
incidentDate | string | |
locationOfAttacker | string | |
incidentMode | string | |
lossType | string | |
details | string | |
actionTaken | string | |
resolutionDate | string | |
mitigationActions | string | |
amountInvolved | number | |
amountLost | number | |
currency | string | |
createdBy | integer | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
psp-director-controller
GET /psps/{pspId}/cbk/directors
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /psps/{pspId}/cbk/directors
PSP - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
directorNames | string | |
directorGender | string | |
typeOfDirector | string | |
dob | string | |
nationality | string | |
residentCountry | string | |
idNoPassport | string | |
pin | string | |
contactNumber | string | |
qualifications | string | |
otherDirectorships | string | |
dateOfAppointment | string | |
dateOfRetirement | string | |
retirementReason | string | |
disclosures | string | |
id | integer | |
pspId | integer | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /psps/{pspId}/cbk/directors/{id}
PSP - Delete
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /psps/{pspId}/cbk/directors/{id}
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /psps/{pspId}/cbk/directors/{id}
PSP - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
directorNames | string | |
directorGender | string | |
typeOfDirector | string | |
dob | string | |
nationality | string | |
residentCountry | string | |
idNoPassport | string | |
pin | string | |
contactNumber | string | |
qualifications | string | |
otherDirectorships | string | |
dateOfAppointment | string | |
dateOfRetirement | string | |
retirementReason | string | |
disclosures | string | |
id | integer | |
pspId | integer | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
psp-fraud-incident-controller
GET /psps/{pspId}/cbk/fraud-incidents
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /psps/{pspId}/cbk/fraud-incidents
PSP - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
reportingDate | string | |
subCountyCode | string | |
subFraudCode | string | |
fraudCategoryFlag | string | |
victimCategory | string | |
victimInformation | string | |
dateOfOccurrence | string | |
numberOfIncidences | integer | |
amountInvolved | number | |
amountLost | number | |
amountRecovered | number | |
actionTaken | string | |
recoveryDetails | string | |
alertIdLink | integer | |
caseIdLink | integer | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /psps/{pspId}/cbk/fraud-incidents/{id}
PSP - Delete
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /psps/{pspId}/cbk/fraud-incidents/{id}
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /psps/{pspId}/cbk/fraud-incidents/{id}
PSP - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
reportingDate | string | |
subCountyCode | string | |
subFraudCode | string | |
fraudCategoryFlag | string | |
victimCategory | string | |
victimInformation | string | |
dateOfOccurrence | string | |
numberOfIncidences | integer | |
amountInvolved | number | |
amountLost | number | |
amountRecovered | number | |
actionTaken | string | |
recoveryDetails | string | |
alertIdLink | integer | |
caseIdLink | integer | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
psp-product-controller
GET /psps/{pspId}/cbk/products
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /psps/{pspId}/cbk/products
PSP - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
productName | string | |
productOwnershipFlag | string | |
productOwnershipCategory | string | |
productPartnerName | string | |
productTransactionCode | string | |
genderSegment | string | |
statusCode | string | |
bandCode | string | |
noOfCustomers | integer | |
noOfTransactions | integer | |
valueOfTransactions | number | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /psps/{pspId}/cbk/products/{id}
PSP - Delete
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /psps/{pspId}/cbk/products/{id}
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /psps/{pspId}/cbk/products/{id}
PSP - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
productName | string | |
productOwnershipFlag | string | |
productOwnershipCategory | string | |
productPartnerName | string | |
productTransactionCode | string | |
genderSegment | string | |
statusCode | string | |
bandCode | string | |
noOfCustomers | integer | |
noOfTransactions | integer | |
valueOfTransactions | number | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
psp-reporting-config-controller
GET /psps/{pspId}/report-config
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /psps/{pspId}/report-config
PSP - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
reportUrl | string | |
allowedDomains | string | |
allowedIps | string | |
port | integer | |
active | boolean |
Responses
| Status | Description |
|---|---|
200 | OK |
psp-senior-management-controller
GET /psps/{pspId}/cbk/senior-management
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /psps/{pspId}/cbk/senior-management
PSP - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
officerNames | string | |
gender | string | |
designation | string | |
dob | string | |
nationality | string | |
idNo | string | |
taxId | string | |
qualification | string | |
dateOfEmp | string | |
empType | string | |
retirementDt | string | |
externalAffliates | string | |
otherDisclosure | string | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /psps/{pspId}/cbk/senior-management/{id}
PSP - Delete
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /psps/{pspId}/cbk/senior-management/{id}
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /psps/{pspId}/cbk/senior-management/{id}
PSP - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
officerNames | string | |
gender | string | |
designation | string | |
dob | string | |
nationality | string | |
idNo | string | |
taxId | string | |
qualification | string | |
dateOfEmp | string | |
empType | string | |
retirementDt | string | |
externalAffliates | string | |
otherDisclosure | string | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
psp-shareholder-controller
GET /psps/{pspId}/cbk/shareholders
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /psps/{pspId}/cbk/shareholders
PSP - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
shareholderName | string | |
shareholderGender | string | |
shareholderType | string | |
dobOrRegDate | string | |
nationality | string | |
residentCountry | string | |
countryOfInc | string | |
idNoPassport | string | |
pin | string | |
contactNumber | string | |
qualifications | string | |
previousEmployment | string | |
onboardingDate | string | |
noOfSharesHeld | integer | |
shareValue | number | |
percentageOfShare | number | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /psps/{pspId}/cbk/shareholders/{id}
PSP - Delete
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /psps/{pspId}/cbk/shareholders/{id}
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /psps/{pspId}/cbk/shareholders/{id}
PSP - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
shareholderName | string | |
shareholderGender | string | |
shareholderType | string | |
dobOrRegDate | string | |
nationality | string | |
residentCountry | string | |
countryOfInc | string | |
idNoPassport | string | |
pin | string | |
contactNumber | string | |
qualifications | string | |
previousEmployment | string | |
onboardingDate | string | |
noOfSharesHeld | integer | |
shareValue | number | |
percentageOfShare | number | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
psp-system-interruption-controller
GET /psps/{pspId}/cbk/system-interruptions
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /psps/{pspId}/cbk/system-interruptions
PSP - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
reportingDate | string | |
subCountyCode | string | |
systemOwnerFlag | string | |
thirdPartyOwnedCategory | string | |
thirdPartyName | string | |
productType | string | |
systemUnavailabilityTypeCode | string | |
thirdPartySystemAffected | string | |
serviceInterruptionCauseCode | string | |
severityInterruptionCode | string | |
recoveryTimeCode | string | |
remedialStatusCode | string | |
systemUptimePercentage | number | |
startedAt | string | |
resolvedAt | string | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /psps/{pspId}/cbk/system-interruptions/{id}
PSP - Delete
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /psps/{pspId}/cbk/system-interruptions/{id}
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /psps/{pspId}/cbk/system-interruptions/{id}
PSP - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
reportingDate | string | |
subCountyCode | string | |
systemOwnerFlag | string | |
thirdPartyOwnedCategory | string | |
thirdPartyName | string | |
productType | string | |
systemUnavailabilityTypeCode | string | |
thirdPartySystemAffected | string | |
serviceInterruptionCauseCode | string | |
severityInterruptionCode | string | |
recoveryTimeCode | string | |
remedialStatusCode | string | |
systemUptimePercentage | number | |
startedAt | string | |
resolvedAt | string | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
psp-tariff-template-controller
GET /psps/{pspId}/cbk/tariffs
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /psps/{pspId}/cbk/tariffs
PSP - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
channelUsed | string | |
channelPartnerName | string | |
chargeDescription | string | |
percentageTransactionCost | number | |
absoluteTransactionCost | number | |
effectiveFrom | string | |
effectiveTo | string | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /psps/{pspId}/cbk/tariffs/{id}
PSP - Delete
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /psps/{pspId}/cbk/tariffs/{id}
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /psps/{pspId}/cbk/tariffs/{id}
PSP - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
channelUsed | string | |
channelPartnerName | string | |
chargeDescription | string | |
percentageTransactionCost | number | |
absoluteTransactionCost | number | |
effectiveFrom | string | |
effectiveTo | string | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /psps/{pspId}/cbk/tariffs/active
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
psp-trust-account-controller
GET /psps/{pspId}/cbk/trust-accounts
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /psps/{pspId}/cbk/trust-accounts
PSP - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
bankId | string | |
bankAccountNumber | string | |
trustAccDrTypeCode | string | |
orgReceivingDonation | string | |
sectorCode | string | |
trustAccIntUtilizedDetails | string | |
openingBalance | number | |
principalAmount | number | |
interestEarned | number | |
closingBalance | number | |
interestUtilized | number | |
trustFields | string | |
asOfDate | string | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /psps/{pspId}/cbk/trust-accounts/{id}
PSP - Delete
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /psps/{pspId}/cbk/trust-accounts/{id}
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /psps/{pspId}/cbk/trust-accounts/{id}
PSP - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
bankId | string | |
bankAccountNumber | string | |
trustAccDrTypeCode | string | |
orgReceivingDonation | string | |
sectorCode | string | |
trustAccIntUtilizedDetails | string | |
openingBalance | number | |
principalAmount | number | |
interestEarned | number | |
closingBalance | number | |
interestUtilized | number | |
trustFields | string | |
asOfDate | string | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
psp-trustee-controller
GET /psps/{pspId}/cbk/trustees
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /psps/{pspId}/cbk/trustees
PSP - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
trustCompName | string | |
directorsTrustComp | string | |
trusteeNames | string | |
trusteeGender | string | |
dob | string | |
nationality | string | |
residentCountry | string | |
idNoPassport | string | |
pin | string | |
contactNumber | string | |
qualifications | string | |
othersTrusteeships | string | |
disclosures | string | |
shareholders | string | |
shareholdingPercentage | number | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /psps/{pspId}/cbk/trustees/{id}
PSP - Delete
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /psps/{pspId}/cbk/trustees/{id}
PSP - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /psps/{pspId}/cbk/trustees/{id}
PSP - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer | |
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
pspId | integer | |
trustCompName | string | |
directorsTrustComp | string | |
trusteeNames | string | |
trusteeGender | string | |
dob | string | |
nationality | string | |
residentCountry | string | |
idNoPassport | string | |
pin | string | |
contactNumber | string | |
qualifications | string | |
othersTrusteeships | string | |
disclosures | string | |
shareholders | string | |
shareholdingPercentage | number | |
createdAt | string | |
updatedAt | string |
Responses
| Status | Description |
|---|---|
200 | OK |
role-controller
GET /roles
Role - List
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | query | no | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /roles
Role - Create
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
name | string | |
description | string | |
pspId | integer | |
permissions | array |
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /roles/{id}
Role - Delete
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /roles/{id}
Role - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /roles/{id}
Role - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
name | string | |
description | string | |
permissions | array |
Responses
| Status | Description |
|---|---|
200 | OK |
role-permission-controller
GET /auth/permissions
Auth - List
Responses
| Status | Description |
|---|---|
200 | OK |
GET /auth/role-permissions
Auth - List
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
roleId | query | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /auth/roles
Auth - List
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | query | no | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
rules-controller
GET /rules
Rule - List
Responses
| Status | Description |
|---|---|
200 | OK |
POST /rules
Rule - Create
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string | |
description | string | |
ruleJson | string | |
drlContent | string | |
ruleType | string | |
ruleExpression | string | |
score | integer | |
action | string | |
priority | integer | |
enabled | boolean | |
createdAt | string | |
updatedAt | string | |
pspId | integer | |
createdBy | integer | |
updatedBy | integer | |
systemManaged | boolean | |
derivedFromRuleId | integer | |
category | string | |
ruleSubtype | string | |
appliesTo | string | |
typology | string | |
checksFor | string | |
externalCode | string | |
recommended | boolean | |
sampleUseCase | string | |
parameters | string | |
lifecycleStatus | string | |
currentVersionNumber | integer | |
currentVersionId | integer | |
pendingVersionId | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /rules/{id}
Rule - Delete
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /rules/{id}
Rule - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /rules/{id}
Rule - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
id | integer | |
name | string | |
description | string | |
ruleJson | string | |
drlContent | string | |
ruleType | string | |
ruleExpression | string | |
score | integer | |
action | string | |
priority | integer | |
enabled | boolean | |
createdAt | string | |
updatedAt | string | |
pspId | integer | |
createdBy | integer | |
updatedBy | integer | |
systemManaged | boolean | |
derivedFromRuleId | integer | |
category | string | |
ruleSubtype | string | |
appliesTo | string | |
typology | string | |
checksFor | string | |
externalCode | string | |
recommended | boolean | |
sampleUseCase | string | |
parameters | string | |
lifecycleStatus | string | |
currentVersionNumber | integer | |
currentVersionId | integer | |
pendingVersionId | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /rules/{id}/disable
Rule - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /rules/{id}/effectiveness
Rule - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /rules/{id}/enable
Rule - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /rules/{id}/rollback
Rule - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
targetVersionId | integer | |
reason | string |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /rules/{id}/versions
Rule - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /rules/generate
Rule - Create
Request body (application/json, required)
Schema: object
Responses
| Status | Description |
|---|---|
200 | OK |
GET /rules/governance/pending
Rule - List
Responses
| Status | Description |
|---|---|
200 | OK |
POST /rules/governance/versions/{versionId}/approve
Rule - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
versionId | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
reason | string | |
effectiveFrom | string |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /rules/governance/versions/{versionId}/reject
Rule - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
versionId | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
reason | string | |
effectiveFrom | string |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /rules/reload
Rule - Create
Responses
| Status | Description |
|---|---|
200 | OK |
runtime-error-controller
GET /admin/runtime-errors
Admin - List
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
page | query | no | integer | |
size | query | no | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
settings-controller
GET /settings
Settings - List
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /settings
Settings - Update
Request body (application/json, required)
Schema: object
Responses
| Status | Description |
|---|---|
200 | OK |
GET /settings/config
Settings - List
Responses
| Status | Description |
|---|---|
200 | OK |
GET /settings/psps
Settings - List
Responses
| Status | Description |
|---|---|
200 | OK |
GET /settings/psps/{pspId}/theme
Settings - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /settings/psps/{pspId}/theme
Settings - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
brandingTheme | string | |
primaryColor | string | |
secondaryColor | string | |
accentColor | string | |
logoUrl | string | |
faviconUrl | string | |
fontFamily | string | |
fontSize | string | |
buttonRadius | string | |
buttonStyle | string | |
navStyle | string | |
customCss | string |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /settings/system
Settings - List
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /settings/system
Settings - Update
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
maintenanceMode | boolean | |
debugLogging | boolean | |
riskThresholdHigh | integer | |
riskThresholdMedium | integer | |
auditRetentionDays | integer | |
allowCrossBorderTxns | boolean |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /settings/themes/presets
Settings - List
Responses
| Status | Description |
|---|---|
200 | OK |
user-controller
GET /users
User - List
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
pspId | query | no | integer | |
page | query | no | integer | |
size | query | no | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /users
User - Create
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
username | string | |
email | string | |
firstName | string | |
lastName | string | |
password | string | |
roleId | integer | |
pspId | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /users/{id}
User - Delete
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /users/{id}
User - Get
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
PUT /users/{id}
User - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
firstName | string | |
lastName | string | |
email | string | |
roleId | integer |
Responses
| Status | Description |
|---|---|
200 | OK |
POST /users/{id}/{action}
User - Create
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer | |
action | path | yes | string |
Responses
| Status | Description |
|---|---|
200 | OK |
PATCH /users/{id}/toggle
User - Update
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
enabled | boolean |
Responses
| Status | Description |
|---|---|
200 | OK |
webhook-subscription-controller
POST /webhooks/subscribe
Webhook - Create
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
callbackUrl | string | |
eventType | string |
Responses
| Status | Description |
|---|---|
200 | OK |
GET /webhooks/subscriptions
Webhook - List
Responses
| Status | Description |
|---|---|
200 | OK |
DELETE /webhooks/subscriptions/{id}
Webhook - Delete
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | integer |
Responses
| Status | Description |
|---|---|
200 | OK |