> ## 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. # Trigger a payment OTP, SMS a 6-digit code bound to this order + amount > Triggers the OTP leg of a wallet payment: resolves the customer's wallet from the phone, mints an OTP session bound to the calling integration, the order, and the amount, and sends the customer a 6-digit code by SMS. No money moves on this call. The point of sale then submits the code via `POST /payments` with `credential.type: otp`, carrying the returned `otp_session_id` plus the code; verification and debit are atomic there (one call, no hold). The order and amount binding is the anti-replay boundary: a session minted for one order cannot authorize another, and an amount change requires a fresh send. This is an SMS-cost and abuse surface, so it is aggressively rate-limited per phone and per terminal; re-sending before `resend_after_seconds` elapses returns `RATE_LIMITED` with a `Retry-After` header. Idempotent on the `Idempotency-Key` header: a retried send replays the same session without a duplicate SMS. Cross-tenant requests resolve to `403` or `404`; a `pending_proof` wallet may not pay. ## OpenAPI ````yaml /api-reference/openapi.yaml post /payments/otp/send 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: /payments/otp/send: post: tags: - payments summary: Trigger a payment OTP, SMS a 6-digit code bound to this order + amount description: >- Triggers the OTP leg of a wallet payment: resolves the customer's wallet from the phone, mints an OTP session bound to the calling integration, the order, and the amount, and sends the customer a 6-digit code by SMS. No money moves on this call. The point of sale then submits the code via `POST /payments` with `credential.type: otp`, carrying the returned `otp_session_id` plus the code; verification and debit are atomic there (one call, no hold). The order and amount binding is the anti-replay boundary: a session minted for one order cannot authorize another, and an amount change requires a fresh send. This is an SMS-cost and abuse surface, so it is aggressively rate-limited per phone and per terminal; re-sending before `resend_after_seconds` elapses returns `RATE_LIMITED` with a `Retry-After` header. Idempotent on the `Idempotency-Key` header: a retried send replays the same session without a duplicate SMS. Cross-tenant requests resolve to `403` or `404`; a `pending_proof` wallet may not pay. operationId: paymentOtpSend parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OtpSendRequest' example: meta: partner_request_id: a1b2c3d4-0007-0007-0007-000000000007 occurred_at: '2026-06-05T09:59:00Z' sent_at: '2026-06-05T09:59:00Z' api_version: '2026-06-01' context: merchant_id: 11111111-1111-1111-1111-111111111111 branch_id: 22222222-2222-2222-2222-222222222222 terminal_id: POS-360-0007 phone: '+97433001122' amount_minor: 3500 currency: QAR order_ref: odoo-pos-000123 responses: '200': description: >- OTP session minted + code SMSed. Submit the code via `POST /payments` with the `otp` credential. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: data: $ref: '#/components/schemas/OtpSendResult' example: ok: true data: otp_session_id: otps_cc01 phone_masked: +9743300**** expires_at: '2026-06-05T10:04:00Z' resend_after_seconds: 30 error: null meta: request_id: req_otp1 idempotency_replayed: false api_version: '2026-06-01' '400': description: >- `VALIDATION_ERROR`, malformed body, non-E.164 phone, or non-positive amount. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: error: $ref: '#/components/schemas/Error' '401': description: '`INVALID_API_KEY`, missing/invalid POS terminal JWT.' content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: error: $ref: '#/components/schemas/Error' '403': description: '`FORBIDDEN`, cross-tenant or `PENDING_PROOF` wallet.' content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: error: $ref: '#/components/schemas/Error' '404': description: '`NOT_FOUND`, customer wallet not found in this enterprise.' content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: error: $ref: '#/components/schemas/Error' '422': description: '`IDEMPOTENCY_KEY_REUSED` or `WALLET_PROGRAM_AMBIGUOUS`.' content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: error: $ref: '#/components/schemas/Error' '429': description: >- `RATE_LIMITED`, per-phone / per-terminal OTP send budget exhausted, or resend attempted before `resend_after_seconds` elapsed. Honor `Retry-After`. headers: Retry-After: $ref: '#/components/headers/RetryAfter' X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/XRateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/XRateLimitReset' content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: error: $ref: '#/components/schemas/Error' security: - PosTerminalJWT: [] 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: OtpSendRequest: type: object description: >- Body for `POST /payments/otp/send`, the OTP trigger leg. Binds the minted OTP session to the order and amount so the code cannot be replayed across orders. required: - meta - context - phone - amount_minor - currency - order_ref properties: meta: $ref: '#/components/schemas/RequestMeta' context: $ref: '#/components/schemas/RequestContext' phone: type: string description: Customer phone in E.164 format. Used to resolve the wallet. example: '+97433001122' amount_minor: type: integer minimum: 1 description: >- The amount this OTP session authorizes, minor units. The subsequent `POST /payments` must match. example: 3500 currency: type: string description: ISO-4217 currency code for `amount_minor`. example: QAR order_ref: type: string description: >- The partner order identifier this OTP session is bound to (the anti-replay boundary). MUST equal the `order_ref` sent on the subsequent `POST /payments`, or, when that request omits `order_ref`, its `context.partner_session_id`. A session minted for one order cannot authorize another. example: odoo-pos-000123 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' OtpSendResult: type: object description: >- Result of `POST /payments/otp/send`. Carry `otp_session_id` into the `otp` credential of `POST /payments`. required: - otp_session_id - expires_at properties: otp_session_id: type: string description: >- The OTP session id, REQUIRED in `OtpCredential.otp_session_id` on the subsequent `POST /payments`. Bound to (integration, order, amount). example: otps_cc01 phone_masked: type: string description: >- Masked phone the code was sent to (cashier-facing confirmation; never the full number). example: +9743300**** expires_at: type: string format: date-time description: >- OTP expiry. After this, `POST /payments` with this session returns `CREDENTIAL_EXPIRED_OR_REPLAYED`. example: '2026-06-05T10:04:00Z' resend_after_seconds: type: integer description: >- Seconds the POS must wait before requesting a re-send for the same phone + order. example: 30 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. 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. headers: RetryAfter: description: >- Seconds to wait before retrying (RFC 9110 Retry-After). Present on `429` responses. schema: type: integer XRateLimitLimit: description: >- The per-minute request budget for this operation + integration (mirrors `Capabilities.rate_limits`). schema: type: integer XRateLimitRemaining: description: Requests remaining in the current window. schema: type: integer XRateLimitReset: description: Unix epoch seconds at which the current rate-limit window resets. schema: type: integer securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- Partner API key (platform- or merchant-scoped). Contract key-enforces context.merchant_id. PosTerminalJWT: type: http scheme: bearer bearerFormat: JWT description: >- POS terminal JWT minted by /auth/token; carries integrationId + terminal/cashier claims (server-trusted). ````