> ## Documentation Index > Fetch the complete documentation index at: https://docs.feddi.io/llms.txt > Use this file to discover all available pages before exploring further. # Configure reload-bonus tiers (merchant control plane) > Operator endpoint: configure the reload-bonus tiers for a wallet program, the amount-banded promotional bonus a merchant grants on a top-up (for example, 'top up QAR 50+ get 10% bonus'). Each tier is `{ min_topup_minor, max_topup_minor?, bonus_type (PERCENTAGE | FIXED_AMOUNT), bonus_value }`; tiers must not overlap and percentages are `0`-`100`. Money is minor-units integers throughout. Config is **forward-looking only**: it governs future top-ups and never retroactively re-grants. The bonus this config produces accrues as a promotional grant (promo balance that expires and is never cashable), distinct from the customer's actual cashable balance. Requires the enterprise-admin `integrations` permission. ## OpenAPI ````yaml /api-reference/openapi.yaml post /topup/reload-bonus/config openapi: 3.1.0 info: title: Feddi Partner API version: '2026-06-01' description: >- Operate a Feddi closed-loop wallet and loyalty program at the point of sale: identify customers, read balances, accept wallet payments, run top-ups, and reconcile transactions. All amounts are integer minor units with an explicit ISO-4217 currency. Balances are merchant-held and closed-loop. Every response uses a typed envelope (`ok` / `data` / `error` / `meta`) with string error codes (never a bare HTTP number) and an idempotency-replay flag. Authenticate with the `x-api-key` header; exchange it for a short-lived POS terminal JWT for hot-path calls. Self-validate against this document (`GET /openapi`) and read `GET /capabilities` for the credential types, currencies, and features enabled for your integration before assuming any enum. Operations are tagged `x-feddi-availability: ga` (stable) or `beta` (callable, contract may still change additively); confirm what is enabled for your credentials via `GET /capabilities`. Sandbox access is granted per partner agreement; request credentials from your Feddi contact. servers: - url: https://api.feddi.io/v1/partner description: production - url: https://api.dev.feddi.io/v1/partner description: dev security: - ApiKeyAuth: [] tags: - name: platform description: >- Platform cross-cutting: health, capabilities, openapi self-serve, merchant provisioning, settlement, reconciliation. - name: checkout_session description: >- Checkout sessions: every interaction opens a session, then identity and basket attach to it, and payment, top-up, and offers run against it. - name: auth description: >- Partner authentication + onboarding: API key lifecycle, POS terminal JWT exchange, terminal heartbeat. - name: customers description: >- Customer lookup + identification: resolve identity, cashier-panel summaries, preferences, GDPR export/erase. - name: enrollment description: >- Enrollment + signup: OTP enroll, cashback claims, identity/consent, customer correction + merge. - name: payments description: >- Payments + redemption: debit wallet (promo-first), balance-check, void, refund, QR mint. - name: topup description: >- Wallet top-up: 2-step prepare/confirm, reload-bonus grants, SKU top-up, settlement + reconciliation. - name: incentives description: >- Incentives + offers: offer feeds, apply/redeem/release locks, proposals, budget envelopes, points, grant clawback. - name: transactions description: >- Transactions + receipts: transaction detail, void, receipts, disputes, settlements, reconciliation, exports. - name: webhooks description: >- Webhooks + events: subscriptions, delivery history + retry, event catalog, polling fallback. paths: /topup/reload-bonus/config: post: tags: - topup summary: Configure reload-bonus tiers (merchant control plane) description: >- Operator endpoint: configure the reload-bonus tiers for a wallet program, the amount-banded promotional bonus a merchant grants on a top-up (for example, 'top up QAR 50+ get 10% bonus'). Each tier is `{ min_topup_minor, max_topup_minor?, bonus_type (PERCENTAGE | FIXED_AMOUNT), bonus_value }`; tiers must not overlap and percentages are `0`-`100`. Money is minor-units integers throughout. Config is **forward-looking only**: it governs future top-ups and never retroactively re-grants. The bonus this config produces accrues as a promotional grant (promo balance that expires and is never cashable), distinct from the customer's actual cashable balance. Requires the enterprise-admin `integrations` permission. operationId: topupReloadBonusConfigSet parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReloadBonusConfigRequest' example: meta: partner_request_id: ee01... occurred_at: '2026-06-05T07:00:00Z' sent_at: '2026-06-05T07:00:00Z' api_version: '2026-06-01' context: merchant_id: 11111111-1111-1111-1111-111111111111 wallet_program_id: wp_77 currency: QAR expiry_days: 90 tiers: - min_topup_minor: 5000 max_topup_minor: 9999 bonus_type: PERCENTAGE bonus_value: 10 - min_topup_minor: 10000 max_topup_minor: null bonus_type: PERCENTAGE bonus_value: 15 responses: '200': description: Reload-bonus config saved (governs future top-ups only). content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: data: $ref: '#/components/schemas/ReloadBonusConfig' example: ok: true data: config_id: rbc_01 wallet_program_id: wp_77 currency: QAR expiry_days: 90 status: active tiers: - min_topup_minor: 5000 max_topup_minor: 9999 bonus_type: PERCENTAGE bonus_value: 10 - min_topup_minor: 10000 max_topup_minor: null bonus_type: PERCENTAGE bonus_value: 15 updated_at: '2026-06-05T07:00:00Z' error: null meta: request_id: req_rb1 idempotency_replayed: false api_version: '2026-06-01' '400': description: >- `VALIDATION_ERROR` (HTTP 400), malformed body, missing required field, or a domain rule violated. `details` carries the field errors. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: error: $ref: '#/components/schemas/Error' '401': description: >- `INVALID_API_KEY` (HTTP 401), missing/invalid `x-api-key` or POS terminal JWT (expired, malformed, or wrong audience). content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: error: $ref: '#/components/schemas/Error' '403': description: >- `FORBIDDEN` (HTTP 403), the key is valid but not authorized for this merchant/branch scope or this operation (cross-tenant or insufficient RBAC). content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: error: $ref: '#/components/schemas/Error' '422': description: >- `IDEMPOTENCY_KEY_REUSED` (same key, different payload). Tier-structure violations (overlapping tiers, percentage out of 0-100, non-positive band) are `VALIDATION_ERROR` on the `400` response, not here. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: error: $ref: '#/components/schemas/Error' security: - ApiKeyAuth: [] components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: true description: >- Partner-generated UUID; the ONE dedup key for all mutating endpoints. 24h TTL. Same key + same payload -> byte-identical replay; same key + different payload -> IDEMPOTENCY_KEY_REUSED (422). schema: type: string format: uuid schemas: ReloadBonusConfigRequest: type: object description: >- Body for POST /topup/reload-bonus/config. Forward-looking only (never retroactive). required: - context - wallet_program_id - currency - tiers properties: meta: $ref: '#/components/schemas/RequestMeta' context: $ref: '#/components/schemas/RequestContext' wallet_program_id: type: string description: The wallet program these tiers govern. currency: type: string minLength: 3 maxLength: 3 example: QAR expiry_days: type: - integer - 'null' minimum: 1 description: >- How long an accrued bonus grant lives before expiring (days). Drives `expires_at`. tiers: type: array minItems: 1 items: $ref: '#/components/schemas/ReloadBonusTier' description: Non-overlapping bonus bands. ResponseEnvelope: type: object description: >- The standard response envelope that every enveloped endpoint serializes through. `ok` is a boolean discriminator: when `ok` is `true`, the typed result is carried in `data`; when `ok` is `false`, a typed error object is returned instead. The `meta` object is uniform across the entire API surface. required: - ok - meta properties: ok: type: boolean data: type: - object - 'null' error: oneOf: - $ref: '#/components/schemas/Error' - type: 'null' meta: $ref: '#/components/schemas/Meta' ReloadBonusConfig: type: object description: Persisted reload-bonus config. required: - config_id - wallet_program_id - currency - status - tiers properties: config_id: type: string format: uuid wallet_program_id: type: string currency: type: string expiry_days: type: - integer - 'null' status: type: string enum: - active - inactive tiers: type: array items: $ref: '#/components/schemas/ReloadBonusTier' updated_at: type: string format: date-time Error: type: object description: >- The typed error object returned with every non-2xx response. `code` is a string enum (for example `WALLET_PROGRAM_AMBIGUOUS`, `CREDENTIAL_TYPE_UNSUPPORTED`, `INSUFFICIENT_FUNDS`, `IDEMPOTENCY_KEY_REUSED`, `CURRENCY_NOT_SUPPORTED`), **never a bare HTTP status number**. Inspect `code` for programmatic branching, not the HTTP status. Some codes echo the valid set in `details` so clients can present or reconcile the accepted values: for example `CREDENTIAL_TYPE_UNSUPPORTED` lists the supported credential types, `CURRENCY_NOT_SUPPORTED` lists the supported ISO-4217 currencies, and `WALLET_PROGRAM_AMBIGUOUS` lists the candidate `wallet_program_id` values that matched the request. required: - code - message properties: code: type: string enum: - INSUFFICIENT_FUNDS - INVALID_API_KEY - CREDENTIAL_TYPE_UNSUPPORTED - CURRENCY_NOT_SUPPORTED - IDEMPOTENCY_KEY_REUSED - WALLET_PROGRAM_AMBIGUOUS - REQUIRES_DYNAMIC_CREDENTIAL - NOT_FOUND - FORBIDDEN - VALIDATION_ERROR - RATE_LIMITED - CONFLICT - INTERNAL_SERVER_ERROR message: type: string details: type: object additionalProperties: true RequestMeta: type: object description: >- Common request metadata shared across all Partner API domains. `partner_request_id` is a correlation identifier only: it appears in logs and responses for tracing but is **never used as the deduplication key**. Request deduplication is keyed exclusively on the `Idempotency-Key` header. required: - partner_request_id - api_version properties: partner_request_id: type: string format: uuid description: Partner's own correlation id. NOT the idempotency basis. occurred_at: type: string format: date-time description: >- When the event happened at the POS (RFC3339). Clock-drift signal vs sent_at. sent_at: type: string format: date-time description: When the partner sent the request (RFC3339). api_version: type: string description: The single API version field. example: '2026-06-01' RequestContext: type: object description: >- Canonical request context, shared across all partner domains. `merchant_id` is key-enforced to a merchant the calling credential is authorized for (a platform-scoped credential acts only on its own tenants), so it is **never a free-text trust field**: a `merchant_id` outside the credential's authority is rejected rather than honored. required: - merchant_id properties: merchant_id: type: string format: uuid description: Resolved Feddi tenant (enterprise). branch_id: type: - string - 'null' format: uuid terminal_id: type: - string - 'null' cashier_id: type: - string - 'null' description: Server-trusted only when signed into the terminal JWT. partner_session_id: type: - string - 'null' description: The partner's own order/session ref. feddi_session_id: type: - string - 'null' format: uuid description: >- The checkout_session this call anchors to. On session sub-resource calls it is redundant with the path `{id}` and must match it. ReloadBonusTier: type: object description: One amount-banded reload-bonus tier. Tiers must not overlap. required: - min_topup_minor - bonus_type - bonus_value properties: min_topup_minor: type: integer minimum: 0 description: Inclusive lower bound of the top-up band, minor units. max_topup_minor: type: - integer - 'null' description: >- Inclusive upper bound, minor units; null = open-ended (highest tier). bonus_type: type: string enum: - PERCENTAGE - FIXED_AMOUNT description: PERCENTAGE = % of the top-up; FIXED_AMOUNT = fixed minor-unit grant. bonus_value: type: integer minimum: 0 description: 0-100 when PERCENTAGE; minor units when FIXED_AMOUNT. Meta: type: object description: >- The uniform response metadata block returned on every response. `data_completeness_score` is computed per call and reports the completeness of the returned data. `decision_trace_id` is present on responses that carry decision or insight output and can be used to correlate the response with its reasoning. `capabilities` is an additive, response-level array of hints advertising features the caller may use, and may be extended over time without notice. required: - request_id - api_version properties: request_id: type: string description: Feddi-issued correlation id for this response. idempotency_replayed: type: boolean description: True when this response was replayed from the idempotency store. api_version: type: string description: The single API version field. example: '2026-06-01' data_completeness_score: type: integer minimum: 0 maximum: 100 description: >- 0-100, computed per call (basket/identity/tax/category/consent presence). decision_trace_id: type: - string - 'null' description: Opaque trace id on intelligence-bearing responses; one per response. capabilities: type: object additionalProperties: true description: Additive response-level capability hints. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- Partner API key (platform- or merchant-scoped). Contract key-enforces context.merchant_id. ````