System/Admin

7 API calls in this section.

System • List Payment Method Types

Billing & Subscriptions / System/Admin

GET/payment/system/method-types

Lists active payment method types.

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request GET "$ONDI_BASE_URL/payment/system/method-types" \2  --header "Authorization: Bearer {{access_token}}"

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

JWT token (system admin)

Responses

No response example is available for this endpoint yet.

System • List System Gateway Configs

Billing & Subscriptions / System/Admin

GET/payment/system/gateway-configs

Retrieves all system gateway configurations (e.g., NASS).

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request GET "$ONDI_BASE_URL/payment/system/gateway-configs" \2  --header "Authorization: Bearer {{access_token}}"

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

JWT token (system admin)

Responses

No response example is available for this endpoint yet.

System • List System Gateway Configs (safe)

Billing & Subscriptions / System/Admin

GET/payment/system/gateway-configs

Lists system gateway configs with secrets redacted.

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request GET "$ONDI_BASE_URL/payment/system/gateway-configs" \2  --header "Authorization: Bearer {{access_token}}"

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

JWT token (system admin)

Responses

No response example is available for this endpoint yet.

System • Upsert System Gateway Config (NASS)

Billing & Subscriptions / System/Admin

POST/payment/system/gateway-configs

Create or update the system NASS configuration (system scope).

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request POST "$ONDI_BASE_URL/payment/system/gateway-configs" \2  --header "Authorization: Bearer {{access_token}}" \3  --header "Content-Type: application/json" \4  --header "Content-Type: application/json" \5  --data '{6  "provider_code": "nass",7  "display_name": "Nass (System)",8  "api_keys": {9    "username": "merchant_username",10    "password": "merchant_password"11  },12  "base_url": "https://uat-gateway.nass.iq:9746",13  "webhook_secret": "wh_secret",14  "is_active": true15}'

Request body

json

1{2  "provider_code": "nass",3  "display_name": "Nass (System)",4  "api_keys": {5    "username": "merchant_username",6    "password": "merchant_password"7  },8  "base_url": "https://uat-gateway.nass.iq:9746",9  "webhook_secret": "wh_secret",10  "is_active": true11}

Request body fields

provider_codeExample

string

Example field from the request body.

display_nameExample

string

Example field from the request body.

api_keysExample

object

Example field from the request body.

api_keys.usernameExample

string

Example field from the request body.

api_keys.passwordExample

string

Example field from the request body.

base_urlExample

string

Example field from the request body.

webhook_secretExample

string

Example field from the request body.

is_activeExample

boolean

Example field from the request body.

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

JWT token (system admin)

Content-TypeOptional

header string

application/json

Responses

No response example is available for this endpoint yet.

Admin • List Payment Methods

Billing & Subscriptions / System/Admin

GET/payment/admin/payment-methods

Returns payment method types with commission and activation flags.

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request GET "$ONDI_BASE_URL/payment/admin/payment-methods" \2  --header "Authorization: Bearer {{access_token}}"

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

JWT token (system admin)

Responses

No response example is available for this endpoint yet.

Admin • Update Payment Method

Billing & Subscriptions / System/Admin

PUT/payment/admin/payment-methods/:pm_id

Updates payment method type fields (commission_percent, is_active). If provided, also merges partial provider system configuration for the related gateway (by payment method's gateway_code): - system_gateway_config.api_keys.username/password are individually optional and merged into existing credentials (others unchanged). - base_url, webhook_secret, display_name, is_active update only if present.

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request PUT "$ONDI_BASE_URL/payment/admin/payment-methods/:pm_id" \2  --header "Authorization: Bearer {{access_token}}" \3  --header "Content-Type: application/json" \4  --header "Content-Type: application/json" \5  --data '{6  "commission_percent": 2.5,7  "is_active": true,8  "icon_url": "https://cdn.example.com/icons/nass.png",9  "system_gateway_config": {10    "api_keys": {11      "username": "new_username_optional",12      "password": "new_password_optional"13    },14    "base_url": "https://gateway.example.com",15    "webhook_secret": "wh_secret_optional",16    "display_name": {17      "en": "NASS Gateway",18      "ar": "بوابة ناس"19    },20    "is_active": true21  }22}'

Request body

json

1{2  "commission_percent": 2.5,3  "is_active": true,4  "icon_url": "https://cdn.example.com/icons/nass.png",5  "system_gateway_config": {6    "api_keys": {7      "username": "new_username_optional",8      "password": "new_password_optional"9    },10    "base_url": "https://gateway.example.com",11    "webhook_secret": "wh_secret_optional",12    "display_name": {13      "en": "NASS Gateway",14      "ar": "بوابة ناس"15    },16    "is_active": true17  }18}

Path parameters

pm_idRequired

path string

<payment_method_type_uuid>

Request body fields

commission_percentExample

number

Example field from the request body.

is_activeExample

boolean

Example field from the request body.

icon_urlExample

string

Example field from the request body.

system_gateway_configExample

object

Example field from the request body.

system_gateway_config.api_keysExample

object

Example field from the request body.

system_gateway_config.api_keys.usernameExample

string

Example field from the request body.

system_gateway_config.api_keys.passwordExample

string

Example field from the request body.

system_gateway_config.base_urlExample

string

Example field from the request body.

system_gateway_config.webhook_secretExample

string

Example field from the request body.

system_gateway_config.display_nameExample

object

Example field from the request body.

system_gateway_config.display_name.enExample

string

Example field from the request body.

system_gateway_config.display_name.arExample

string

Example field from the request body.

system_gateway_config.is_activeExample

boolean

Example field from the request body.

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

JWT token (system admin)

Content-TypeOptional

header string

application/json

Responses

No response example is available for this endpoint yet.

Admin • Create System Gateway Config

Billing & Subscriptions / System/Admin

POST/payment/admin/system-gateway-configs

Creates a system-level gateway configuration (separate from system scope upsert).

Send a bearer token in the Authorization header for an authenticated OnDi user session.

Request

curl

1curl --request POST "$ONDI_BASE_URL/payment/admin/system-gateway-configs" \2  --header "Authorization: Bearer {{access_token}}" \3  --header "Content-Type: application/json" \4  --header "Content-Type: application/json" \5  --data '{6  "provider_code": "nass",7  "display_name": "Nass (Ondi)",8  "api_keys": {9    "username": "u",10    "password": "p"11  },12  "base_url": "https://uat-gateway.nass.iq:9746",13  "webhook_secret": "wh_secret",14  "is_active": true15}'

Request body

json

1{2  "provider_code": "nass",3  "display_name": "Nass (Ondi)",4  "api_keys": {5    "username": "u",6    "password": "p"7  },8  "base_url": "https://uat-gateway.nass.iq:9746",9  "webhook_secret": "wh_secret",10  "is_active": true11}

Request body fields

provider_codeExample

string

Example field from the request body.

display_nameExample

string

Example field from the request body.

api_keysExample

object

Example field from the request body.

api_keys.usernameExample

string

Example field from the request body.

api_keys.passwordExample

string

Example field from the request body.

base_urlExample

string

Example field from the request body.

webhook_secretExample

string

Example field from the request body.

is_activeExample

boolean

Example field from the request body.

Headers

AuthorizationOptional

header string

Bearer {{access_token}}

JWT token (system admin)

Content-TypeOptional

header string

application/json

Responses

No response example is available for this endpoint yet.

System • List Payment Method Types​

Headers

Responses

System • List System Gateway Configs​

Headers

Responses

System • List System Gateway Configs (safe)​

Headers

Responses

System • Upsert System Gateway Config (NASS)​

Request body fields

Headers

Responses

Admin • List Payment Methods​

Headers

Responses

Admin • Update Payment Method​

Path parameters

Request body fields

Headers

Responses

Admin • Create System Gateway Config​

Request body fields

Headers

Responses

System • List Payment Method Types

System • List System Gateway Configs

System • List System Gateway Configs (safe)

System • Upsert System Gateway Config (NASS)

Admin • List Payment Methods

Admin • Update Payment Method

Admin • Create System Gateway Config