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

# Create an off-ramp quote

> Creates an off-ramp quote for a connector and amount. `amount` is the
recipient amount in the sending currency (fee-exclusive): the fee is
added on top, so `total = amount + fee`. The returned `quoteId` is what
POST /v1/payments/offramp executes against, and it expires roughly two
minutes after creation. Send direction only.




## OpenAPI

````yaml /api-reference/openapi.yaml post /quotes
openapi: 3.1.0
info:
  title: Zeam API Gateway
  version: 1.0.0
  description: >
    The Zeam API Gateway is the single, REST-based external surface for
    registered

    integrators. Every protected request carries a bearer access token (issued
    by the

    Zeam Auth Service) and the application secret header `x-zeam-auth`. The
    gateway

    verifies the token and resolves the caller's association server-side — you
    do not

    need to supply an association id header. Errors use RFC 7807

    `application/problem+json`.
  license:
    name: Proprietary
    url: https://zeam.app
  contact:
    name: Zeam Platform Team
    url: https://zeam.app
servers:
  - url: https://api.zeam.money/gw/v1
    description: >-
      Zeam API Gateway. The sandbox and production environments share this base
      URL; your application's registration determines which one a request runs
      in.
security:
  - BearerAuth: []
    ZeamAuth: []
tags:
  - name: Auth
    description: Public token issuance.
  - name: Wallets
    description: Association wallets with embedded balances.
  - name: Assets
    description: Platform asset registry.
  - name: Beneficiaries
    description: Association beneficiaries and their payment destinations.
  - name: Connectors
    description: Connector discovery (Connect, surfaced as REST).
  - name: Quotes
    description: Off-ramp quotes.
  - name: Payments
    description: >-
      P2P transfers, swaps, and off-ramp cash-outs, plus the compliance
      reference lookups used when building an off-ramp.
  - name: Transactions
    description: Transaction records, the polling and history complement to webhooks.
  - name: Webhooks
    description: Association webhook registrations.
paths:
  /quotes:
    post:
      tags:
        - Quotes
      summary: Create an off-ramp quote
      description: |
        Creates an off-ramp quote for a connector and amount. `amount` is the
        recipient amount in the sending currency (fee-exclusive): the fee is
        added on top, so `total = amount + fee`. The returned `quoteId` is what
        POST /v1/payments/offramp executes against, and it expires roughly two
        minutes after creation. Send direction only.
      operationId: createQuote
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateQuoteRequest'
            example:
              connectorId: 44444444-4444-4444-4444-444444444444
              amount: 100
              transactionType: B2C
      responses:
        '200':
          description: Quote created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Quote'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/ValidationError'
        '502':
          $ref: '#/components/responses/UpstreamError'
components:
  schemas:
    CreateQuoteRequest:
      type: object
      required:
        - connectorId
        - amount
      properties:
        connectorId:
          type: string
          format: uuid
        amount:
          type: number
          description: >-
            Recipient amount in the sending currency (fee-exclusive). Must be
            greater than 0.
        transactionType:
          type: string
          description: Transaction type, e.g. C2C, B2C, B2B.
          example: B2C
    Quote:
      type: object
      required:
        - quoteId
        - connectorId
      properties:
        quoteId:
          type: string
          format: uuid
        connectorId:
          type: string
          format: uuid
        sendAmount:
          type: number
          description: >-
            Amount debited in the sending currency, as confirmed by the
            connector.
        sendCurrency:
          type: string
        receiveAmount:
          type: number
          description: Amount the beneficiary receives.
        receiveCurrency:
          type: string
        rate:
          type: number
        fee:
          type: number
          description: Zeam's fee for the connector, in feeCurrency.
        feeCurrency:
          type: string
        total:
          type: number
          description: sendAmount plus fee.
        expiresAt:
          type: string
          description: ISO 8601 expiry. Quotes expire roughly two minutes after creation.
    Problem:
      type: object
      required:
        - type
        - title
        - status
      description: RFC 7807 problem details.
      properties:
        type:
          type: string
          format: uri
          example: https://errors.zeam.app/validation-error
        title:
          type: string
          example: Validation Error
        status:
          type: integer
          example: 422
        detail:
          type: string
          example: The 'amount' field must be a positive decimal.
        instance:
          type: string
          example: /v1/quotes
        requestId:
          type: string
          example: 01J8Z6K3QW9F2
        errors:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
  responses:
    BadRequest:
      description: Malformed request.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Unauthorized:
      description: Missing or invalid authentication.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Forbidden:
      description: Authenticated but not permitted.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    ValidationError:
      description: Request failed validation.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    UpstreamError:
      description: A downstream service returned an unexpected error.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token issued by POST /v1/auth/token.
    ZeamAuth:
      type: apiKey
      in: header
      name: x-zeam-auth
      description: >-
        Application secret (the apiKey issued at registration), validated at the
        Kong edge.

````