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

# Create a conversion quote

> Locks a rate between two of your balances for 10 minutes. Give the amount on exactly one side: `from.amount` ("sell exactly this much") or `to.amount` ("buy exactly this much"). The quoted `rate` already includes our spread, so `to.amount` is exactly what lands in your balance. Nothing moves until you execute the quote.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/conversions/quote
openapi: 3.1.0
info:
  title: Chipper Platform API
  version: '2026-02-20'
  description: >-
    Payouts, collections, and FX across African rails — bank, mobile money, and
    stablecoins — through one API.
servers:
  - url: https://api.platform.chipper.ai
    description: Production (sk_live_ keys)
  - url: https://sandbox-api.platform.chipper.ai
    description: Sandbox (sk_test_ keys — simulated rails, no real money)
security:
  - bearerAuth: []
paths:
  /v1/conversions/quote:
    post:
      tags:
        - Conversions
      summary: Create a conversion quote
      description: >-
        Locks a rate between two of your balances for 10 minutes. Give the
        amount on exactly one side: `from.amount` ("sell exactly this much") or
        `to.amount` ("buy exactly this much"). The quoted `rate` already
        includes our spread, so `to.amount` is exactly what lands in your
        balance. Nothing moves until you execute the quote.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                from:
                  type: object
                  properties:
                    amount:
                      type: number
                      exclusiveMinimum: 0
                    currency:
                      type: string
                      minLength: 2
                      maxLength: 10
                  required:
                    - currency
                to:
                  type: object
                  properties:
                    amount:
                      type: number
                      exclusiveMinimum: 0
                    currency:
                      type: string
                      minLength: 2
                      maxLength: 10
                  required:
                    - currency
              required:
                - from
                - to
      responses:
        '201':
          description: The quote, valid until `expiresAt`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  quote:
                    $ref: '#/components/schemas/ConversionQuote'
                required:
                  - quote
        '400':
          description: Invalid request — the body failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: validation_error
                message: Request validation failed
                requestId: req_q7vei435zifs51ia0lqr
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: unauthorized
                message: Invalid API key
                requestId: req_q7vei435zifs51ia0lqr
        '403':
          description: The API key lacks the required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: forbidden
                message: API key does not have the required scope
                requestId: req_q7vei435zifs51ia0lqr
      security:
        - bearerAuth: []
components:
  schemas:
    ConversionQuote:
      type: object
      properties:
        id:
          type: string
          example: qte_k3m9x2pw7fqz1ncv8hdt
        status:
          type: string
          enum:
            - pending
            - executed
            - expired
          description: '`pending` until executed or `expiresAt` passes.'
        from:
          type: object
          properties:
            accountNumber:
              type:
                - string
                - 'null'
              description: Your balance account that is debited.
              example: GHS12345678
            amount:
              type: string
              description: Decimal string — never parse as float for arithmetic.
              example: '1000.00'
            currency:
              type: string
              example: GHS
          required:
            - accountNumber
            - amount
            - currency
        to:
          type: object
          properties:
            accountNumber:
              type:
                - string
                - 'null'
              description: Your balance account that is credited.
              example: USD87654321
            amount:
              type: string
              description: Decimal string — never parse as float for arithmetic.
              example: '62.50'
            currency:
              type: string
              example: USD
          required:
            - accountNumber
            - amount
            - currency
        rate:
          type: string
          description: >-
            Units of `to.currency` per 1 unit of `from.currency`. Spread is
            already included — this is exactly what you get.
          example: '0.0625'
        expiresAt:
          type: string
          format: date-time
          description: Quotes hold their rate for 10 minutes.
          example: '2026-08-01T09:22:44.000Z'
        createdAt:
          type: string
          format: date-time
          example: '2026-08-01T09:12:44.000Z'
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - status
        - from
        - to
        - rate
        - expiresAt
        - createdAt
        - updatedAt
    Error:
      type: object
      properties:
        error:
          type: string
          description: Stable machine-readable code.
        message:
          type: string
          description: Human-readable explanation.
        requestId:
          type: string
          description: Echoed in the x-request-id response header — quote it to support.
      required:
        - error
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `sk_test_…` (sandbox) or `sk_live_…` (production).'

````