> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sakawave.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quote a purchase

> What a plan costs from a particular account, holding the exchange rate when that account is not USD.

Moves no money and commits you to nothing. It exists so the figure you show a customer is the figure that leaves their account.

## USD accounts need no quote

When the account is already USD, `payable` is simply price plus fee, and `fxQuoteId`, `rate` and `expiresAt` are all null. You may buy without quoting at all.

## Any other currency does

The catalog is USD; the account is not. The quote holds a rate for about two minutes and returns an `fxQuoteId`. Send that id when you buy — without it the purchase is refused.

<Note>A quote is bound to one account, one plan, and one price. It cannot be re-pointed at a different account, and it can back exactly one order.</Note>

## Error codes

| Status | `code` | Cause |
| - | - | - |
| `404` | `account_not_found` | No such account for this business. |
| `409` | `esim_account_ineligible` | The account is inactive, cannot be debited, or is a customer wallet. |
| `503` | `esim_fx_quote_unavailable` | The rate provider could not be reached. |
| `401` | `INVALID_API_KEY` | The key is missing, invalid, inactive, expired, from the other environment, or blocked by its IP allowlist. |
| `429` | `api_key_rate_limit_exceeded` | The per-minute limit for this key was exceeded. |
| `503` | `esim_feature_disabled` | eSIM is not enabled on this deployment. |
| `503` | `esim_catalog_unavailable` | The catalog is empty and could not be refreshed from the provider. |
| `503` | `esim_provider_unavailable` | The eSIM provider could not be reached. Nothing was charged. |


## OpenAPI

````yaml /openapi.json post /v1/esims/quote
openapi: 3.1.0
info:
  title: Sakawave Business API
  version: 1.0.0-draft
  summary: >-
    Accounts, transfers, FX quotes, and transaction reconciliation for Sakawave
    businesses.
  description: >-
    Generated from the public NestJS controllers and their Zod request schemas.
    Public URLs and policy statements remain draft until the Phase 1 contract
    checklist is approved.
  contact:
    name: Sakawave API Support
    email: api-support@sakawave.example
servers:
  - url: https://sandbox-api.sakawave.example
    description: Sandbox (default)
  - url: https://api.sakawave.example
    description: Live
security:
  - bearerAuth: []
tags:
  - name: Bill payments
    description: Browse the biller catalog, validate a customer, and pay a bill.
  - name: Cards
    description: Issue, fund, and control USD virtual and disposable cards.
  - name: eSIM
    description: >-
      Sell mobile data abroad: browse the catalog, buy an eSIM, and manage it
      once installed.
  - name: Currencies and countries
    description: >-
      Reference data: what may be held, what may be sent where, and which
      jurisdictions are served.
  - name: Customers
    description: Create and manage customers of your business.
  - name: Accounts
    description: >-
      Open business and customer accounts, and issue the destinations that fund
      them.
  - name: Transfer destinations
    description: Resolve temporary destinations and saved recipients.
  - name: FX quotes
    description: Create and retrieve time-limited cross-currency quotes.
  - name: Transfers
    description: Preview, create, and monitor transfers.
  - name: Transactions
    description: Read ledger entries for reconciliation.
paths:
  /v1/esims/quote:
    post:
      tags:
        - eSIM
      summary: Quote a purchase
      description: >-
        What a plan costs from a particular account, holding the exchange rate
        when that account is not USD.
      operationId: quoteEsimPurchase
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QuoteEsimRequest'
            example:
              packageSlug: united-states-5gb-30d-pkgus5gb
              quantity: 1
              debitAccountId: 01K2Z3AB4D5E6F7G8H9JKMNPQR
      responses:
        '200':
          description: Successful response.
          headers:
            X-Request-ID:
              description: >-
                The request identifier assigned by Sakawave. Include it in
                support requests.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EsimQuoteResponse'
              example:
                package:
                  slug: united-states-5gb-30d-pkgus5gb
                  name: United States 5GB
                quantity: 1
                price:
                  amount: '999'
                  currency: USD
                  display: '9.99'
                fee:
                  amount: '0'
                  currency: USD
                  display: '0.00'
                payable:
                  amount: '1568430'
                  currency: NGN
                  display: 15,684.30
                rate: '1570.000000000000'
                fxQuoteId: 01K2Z3AB4W5X6Y7Z8ABCDEFGHJ
                expiresAt: '2026-08-29T10:32:00.000Z'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '409':
          $ref: '#/components/responses/ConflictError'
        '429':
          $ref: '#/components/responses/RateLimitError'
        '500':
          $ref: '#/components/responses/ServerError'
        '503':
          $ref: '#/components/responses/ProviderUnavailableError'
      security:
        - bearerAuth: []
components:
  schemas:
    QuoteEsimRequest:
      type: object
      additionalProperties: false
      properties:
        packageSlug:
          type: string
          maxLength: 200
        packageId:
          $ref: '#/components/schemas/Ulid'
        quantity:
          type: integer
          minimum: 1
          maximum: 10
          default: 1
        debitAccountId:
          $ref: '#/components/schemas/Ulid'
          description: Any active, debitable account you own, in any currency.
      required:
        - debitAccountId
      description: Provide exactly one of packageSlug or packageId.
    EsimQuoteResponse:
      type: object
      additionalProperties: false
      properties:
        package:
          type: object
          additionalProperties: false
          properties:
            slug:
              type: string
            name:
              type: string
          required:
            - slug
            - name
        quantity:
          type: integer
          minimum: 1
        price:
          $ref: '#/components/schemas/EsimMoney'
        fee:
          $ref: '#/components/schemas/EsimMoney'
        payable:
          $ref: '#/components/schemas/EsimMoney'
        rate:
          anyOf:
            - type: string
              description: >-
                Units of the paying currency per USD. Null when the account is
                already USD.
            - type: 'null'
        fxQuoteId:
          anyOf:
            - $ref: '#/components/schemas/Ulid'
              description: Send this when buying. Null when no conversion is needed.
            - type: 'null'
        expiresAt:
          anyOf:
            - $ref: '#/components/schemas/IsoTimestamp'
            - type: 'null'
      required:
        - package
        - quantity
        - price
        - fee
        - payable
        - rate
        - fxQuoteId
        - expiresAt
    Ulid:
      type: string
      minLength: 26
      maxLength: 26
      pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
      example: 01K2Z3AB4C5D6E7F8G9HJKMNPQ
      description: A 26-character ULID.
    EsimMoney:
      type: object
      additionalProperties: false
      properties:
        amount:
          type: string
          description: Minor units, as a string. Use this for arithmetic.
        currency:
          type: string
          description: ISO 4217 code.
        display:
          type: string
          description: The same figure rendered. Never use it in a calculation.
      required:
        - amount
        - currency
        - display
    IsoTimestamp:
      type: string
      format: date-time
      example: '2026-08-14T09:00:00.000Z'
    RequestError:
      anyOf:
        - $ref: '#/components/schemas/ValidationError'
        - $ref: '#/components/schemas/Error'
      description: >-
        Either a field-level validation failure carrying an errors array, or a
        rule the request broke, identified by code.
    Error:
      type: object
      additionalProperties: true
      properties:
        statusCode:
          type: integer
        message:
          type: string
          description: >-
            A sentence suitable for a log or a support conversation, not for a
            user interface.
        code:
          type: string
          description: >-
            The stable machine-readable reason. Branch on this, never on the
            message.
      required:
        - message
        - code
      description: >-
        An error body. Individual errors may add context fields alongside these
        three.
    RateLimitError:
      type: object
      additionalProperties: false
      properties:
        statusCode:
          const: 429
        message:
          type: string
        code:
          const: api_key_rate_limit_exceeded
        retryAfterSeconds:
          type: integer
          minimum: 1
      required:
        - statusCode
        - message
        - code
        - retryAfterSeconds
    ValidationError:
      type: object
      additionalProperties: false
      properties:
        statusCode:
          const: 400
        message:
          type: string
          description: The single failure, or a count when more than one field failed.
        code:
          const: validation_failed
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ValidationFailure'
      required:
        - statusCode
        - message
        - code
        - errors
    ValidationFailure:
      type: object
      additionalProperties: false
      properties:
        message:
          type: string
        field:
          type: string
        code:
          type: string
        path:
          type: array
          items:
            anyOf:
              - type: string
              - type: integer
      required:
        - message
        - field
        - code
        - path
  responses:
    ValidationError:
      description: >-
        The request was rejected before it was acted on. Field failures list
        every failing field.
      headers:
        X-Request-ID:
          description: >-
            The request identifier assigned by Sakawave. Include it in support
            requests.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestError'
          example:
            statusCode: 400
            message: Must be a valid identifier.
            code: validation_failed
            errors:
              - message: Must be a valid identifier.
                field: accountId
                code: custom
                path:
                  - accountId
    AuthenticationError:
      description: >-
        The API key is missing, invalid, inactive, expired, for another
        environment, or blocked by its IP allowlist.
      headers:
        X-Request-ID:
          description: >-
            The request identifier assigned by Sakawave. Include it in support
            requests.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 401
            code: INVALID_API_KEY
            message: Invalid or inactive API credentials.
    NotFoundError:
      description: The requested resource was not found for this business.
      headers:
        X-Request-ID:
          description: >-
            The request identifier assigned by Sakawave. Include it in support
            requests.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 404
            code: resource_not_found
            message: Resource not found.
    ConflictError:
      description: The request conflicts with the current resource state.
      headers:
        X-Request-ID:
          description: >-
            The request identifier assigned by Sakawave. Include it in support
            requests.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 409
            code: resource_conflict
            message: The request conflicts with the current resource state.
    RateLimitError:
      description: The API key rate limit was exceeded.
      headers:
        X-Request-ID:
          description: >-
            The request identifier assigned by Sakawave. Include it in support
            requests.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitError'
          example:
            statusCode: 429
            message: Too many API requests. Try again later.
            code: api_key_rate_limit_exceeded
            retryAfterSeconds: 17
    ServerError:
      description: An unexpected server error occurred.
      headers:
        X-Request-ID:
          description: >-
            The request identifier assigned by Sakawave. Include it in support
            requests.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 500
            code: internal_server_error
            message: An unexpected error occurred.
    ProviderUnavailableError:
      description: >-
        A payment provider could not be reached. The request had no effect;
        retry shortly.
      headers:
        X-Request-ID:
          description: >-
            The request identifier assigned by Sakawave. Include it in support
            requests.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            statusCode: 503
            code: provider_unavailable
            message: We could not issue an account number just now. Try again shortly.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sakawave API key
      description: >-
        A secret API key, sent as `Authorization: Bearer sk_test_…` in sandbox
        or `Bearer sk_live_…` in live.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.