> ## 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. # Cashier-initiated enrollment: create a PENDING_PROOF wallet + SMS a verification link > Initiates cashier-led customer enrollment by creating a wallet identity in the `PENDING_PROOF` state and sending the customer an SMS verification link. This is step 1 of the two-step signup flow; step 2 is `POST /enroll/verify`, where the customer proves phone ownership. The request supplies a phone number, which is normalized to E.164 and used to find-or-create the customer's wallet identity in the `PENDING_PROOF` state, scoped to `(merchant_id, normalized_phone)`. A single-use, short-TTL signed verification link is then issued and delivered by SMS. **No money moves and no provider-customer link is created at this step.** Both occur only at `POST /enroll/verify` once the customer proves ownership of the phone number. The `PENDING_PROOF` wallet identity acts as an escrow target. Any promotional value accrued for an unverified customer (for example a top-up bonus or cashback) is held as a `LOCKED` promotional grant until verification flips the state and releases it. A wallet identity is unique on `(merchant_id, normalized_phone)`: **the same phone number at a different merchant is a different customer.** Wallet balances and grants are isolated per merchant in a closed loop and do not cross merchant boundaries. This endpoint is idempotent on the `Idempotency-Key` header. A retry with the same key replays the original wallet identity and verification link without sending a new SMS and without resetting the resend rate-limit window. If a `feddi_session_id` is supplied, the enrollment is associated with the live checkout session; otherwise the enrollment is standalone. The verification SMS is transactional and does not require marketing consent opt-in. ## OpenAPI ````yaml /api-reference/openapi.yaml post /enroll/initiate 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: /enroll/initiate: post: tags: - enrollment summary: >- Cashier-initiated enrollment: create a PENDING_PROOF wallet + SMS a verification link description: >- Initiates cashier-led customer enrollment by creating a wallet identity in the `PENDING_PROOF` state and sending the customer an SMS verification link. This is step 1 of the two-step signup flow; step 2 is `POST /enroll/verify`, where the customer proves phone ownership. The request supplies a phone number, which is normalized to E.164 and used to find-or-create the customer's wallet identity in the `PENDING_PROOF` state, scoped to `(merchant_id, normalized_phone)`. A single-use, short-TTL signed verification link is then issued and delivered by SMS. **No money moves and no provider-customer link is created at this step.** Both occur only at `POST /enroll/verify` once the customer proves ownership of the phone number. The `PENDING_PROOF` wallet identity acts as an escrow target. Any promotional value accrued for an unverified customer (for example a top-up bonus or cashback) is held as a `LOCKED` promotional grant until verification flips the state and releases it. A wallet identity is unique on `(merchant_id, normalized_phone)`: **the same phone number at a different merchant is a different customer.** Wallet balances and grants are isolated per merchant in a closed loop and do not cross merchant boundaries. This endpoint is idempotent on the `Idempotency-Key` header. A retry with the same key replays the original wallet identity and verification link without sending a new SMS and without resetting the resend rate-limit window. If a `feddi_session_id` is supplied, the enrollment is associated with the live checkout session; otherwise the enrollment is standalone. The verification SMS is transactional and does not require marketing consent opt-in. operationId: enrollInitiate parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EnrollInitiateRequest' example: meta: partner_request_id: 1a2b3c4d-0001-4f9b-9d1e-1a2b3c4d5e6f occurred_at: '2026-06-05T09:40:00Z' sent_at: '2026-06-05T09:40:01Z' 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 cashier_id: cashier-42 partner_session_id: ord-99841 feddi_session_id: 33333333-3333-3333-3333-333333333333 phone: '+97433001122' provider_customer_id: odoo-cust-5521 wallet_program_id: null language: en responses: '200': description: >- PENDING_PROOF proto-wallet created (or idempotent replay) and the verification SMS dispatched. No money moved, no provider-customer link yet. content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: data: $ref: '#/components/schemas/EnrollInitiateResult' example: ok: true data: wallet_user_id: wu_aa01 customer_state: pending_proof phone: '+97433001122' wallet_program_id: wp_77 verification_sent: true verification_channel: sms verification_expires_at: '2026-06-05T10:10:00Z' provider_customer_map_created: false is_new: true session_id: 33333333-3333-3333-3333-333333333333 error: null meta: request_id: req_en1 idempotency_replayed: false api_version: '2026-06-01' data_completeness_score: 55 '400': description: >- `VALIDATION_ERROR` (HTTP 400), malformed body, missing/invalid phone, unsupported country code, 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 (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), `WALLET_PROGRAM_AMBIGUOUS` (phone resolves to multiple programs and none specified; candidates listed), or a resend rate-limit breach surfaced at initiate (`details.retry_after_seconds`). content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseEnvelope' - type: object properties: error: $ref: '#/components/schemas/Error' example: ok: false data: null error: code: WALLET_PROGRAM_AMBIGUOUS message: >- Phone resolves to multiple wallet programs; specify wallet_program_id. details: candidates: - wp_77 - wp_91 meta: request_id: req_en9 idempotency_replayed: false api_version: '2026-06-01' 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: EnrollInitiateRequest: type: object description: >- Body for POST /enroll/initiate. The cashier supplies a phone (E.164-normalized server-side) and optionally the POS provider customer-id. required: - context - phone properties: meta: $ref: '#/components/schemas/RequestMeta' context: $ref: '#/components/schemas/RequestContext' phone: type: string description: >- The customer's phone; normalized to E.164 server-side. The identity key is (merchant_id, normalized_phone). provider_customer_id: type: - string - 'null' description: >- The POS provider's customer id; bound to the wallet identity at verify (provider-customer link), not at initiate. wallet_program_id: type: - string - 'null' description: >- Explicit program when the customer could map to several; NULL uses the integration's current assignment. Ambiguity → WALLET_PROGRAM_AMBIGUOUS. language: type: - string - 'null' description: >- Preferred SMS language (e.g. en, ar); defaults to the program/branch default. example: en 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' EnrollInitiateResult: type: object description: >- Result of `POST /enroll/initiate`. The customer's wallet identity now exists in a `PENDING_PROOF` state and a verification SMS has been sent to the supplied phone number. **No funds move during initiation**, and the provider-customer link is not yet established. The link is created only once the verification step completes. required: - wallet_user_id - customer_state - verification_sent properties: wallet_user_id: type: string description: The PENDING_PROOF wallet identity id. customer_state: type: string enum: - pending_proof - verified description: >- pending_proof for a new/unverified enrollment; verified if the phone was already a verified customer (idempotent no-op enroll). phone: type: string description: The normalized E.164 phone. wallet_program_id: type: - string - 'null' verification_sent: type: boolean description: >- Whether a verification SMS was dispatched (false on an idempotent replay that did not re-send). verification_channel: type: - string - 'null' enum: - sms - whatsapp - null verification_expires_at: type: - string - 'null' format: date-time description: When the verification link/token expires. provider_customer_map_created: type: boolean description: Always false at initiate; the map is created at verify. is_new: type: boolean description: >- True if this call created the proto-wallet; false if it already existed. session_id: type: - string - 'null' format: uuid description: >- The checkout_session this enrollment anchored to, when feddi_session_id was supplied. 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. 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). ````