Skip to main content

System Admin

4 API calls in this section.

Payment APIs for system administrators to manage payment method types and tenant gateway configurations.

List Payment Method Types​

Billing & Subscriptions / System Admin
GET/payment/system/method-types

Retrieves all available payment method types in the system including COD, Wallet, and gateway payment methods. The COD record keeps canonical name Cash on Delivery, type COD, and gateway_code cod; its localized display_name is Cash.

Headers

ParameterTypeDescription
AuthorizationRequiredstring

JWT token for system admin users (required)

Example: Bearer {{access_token}}

Staging
Request
curl
1curl --globoff --request GET "https://staging-api.ondi.io/functions/v1/payment/system/method-types" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}"

Response examples

No saved response example. Use Try it to inspect a staging response.

List Tenant Gateway Configurations​

Billing & Subscriptions / System Admin
GET/payment/system/tenant-configs

Retrieves all tenant gateway configurations across the system for monitoring and management.

Headers

ParameterTypeDescription
AuthorizationRequiredstring

JWT token for system admin users (required)

Example: Bearer {{access_token}}

Staging
Request
curl
1curl --globoff --request GET "https://staging-api.ondi.io/functions/v1/payment/system/tenant-configs" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}"

Response examples

No saved response example. Use Try it to inspect a staging response.

Create Tenant Gateway Configuration​

Billing & Subscriptions / System Admin
POST/payment/system/tenant-configs

Creates a new payment gateway configuration for a specific tenant with validation and connectivity testing.

Headers

ParameterTypeDescription
AuthorizationRequiredstring

JWT token for system admin users (required)

Example: Bearer {{access_token}}

Content-Typestring

Example: application/json

Body parameters

ParameterTypeDescription
tenant_idstring—
payment_method_type_idstring—
gateway_codestring—
api_keysobject—
api_keys.key_idstring—
api_keys.key_secretstring—
webhook_secretstring—
base_urlstring—
settingsobject—
settings.currencystring—
settings.capture_methodstring—
Staging
Request
curl
1curl --globoff --request POST "https://staging-api.ondi.io/functions/v1/payment/system/tenant-configs" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}" \3  --header "Content-Type: application/json" \4  --data-raw '{5  "tenant_id": "{{tenant_id}}",6  "payment_method_type_id": "razorpay-method-uuid",7  "gateway_code": "razorpay",8  "api_keys": {9    "key_id": "rzp_test_1234567890",10    "key_secret": "your_razorpay_secret_key"11  },12  "webhook_secret": "your_webhook_secret",13  "base_url": "https://api.razorpay.com/v1",14  "settings": {15    "currency": "USD",16    "capture_method": "automatic"17  }18}'

Replace {{placeholders}} with your own values before sending.

Response examples

No saved response example. Use Try it to inspect a staging response.

Update Tenant Gateway Configuration​

Billing & Subscriptions / System Admin
PUT/payment/system/tenant-configs/:configId

Updates an existing tenant gateway configuration with validation and testing.

Path parameters

ParameterTypeDescription
configIdRequiredstring

UUID of the configuration to update

Example: config-uuid-1

Headers

ParameterTypeDescription
AuthorizationRequiredstring

JWT token for system admin users (required)

Example: Bearer {{access_token}}

Content-Typestring

Example: application/json

Body parameters

ParameterTypeDescription
api_keysobject—
api_keys.key_idstring—
api_keys.key_secretstring—
settingsobject—
settings.currencystring—
settings.capture_methodstring—
is_activeboolean—
Staging
Request
curl
1curl --globoff --request PUT "https://staging-api.ondi.io/functions/v1/payment/system/tenant-configs/${CONFIGID}" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}" \3  --header "Content-Type: application/json" \4  --data-raw '{5  "api_keys": {6    "key_id": "rzp_live_1234567890",7    "key_secret": "updated_secret_key"8  },9  "settings": {10    "currency": "USD",11    "capture_method": "manual"12  },13  "is_active": true14}'

Response examples

No saved response example. Use Try it to inspect a staging response.