> ## 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.

# Send an off-ramp cash-out

> Cashes out to a beneficiary's real-world (non-CRYPTO) payment
destination, executed asynchronously against a quote from
POST /v1/quotes. `paymentDestinationId` must be a non-CRYPTO
destination; crypto goes via P2P or swap. Pricing is never accepted
from the caller: `amount`, `receiveAmount`, `receiveCurrency`, and the
service commission are resolved server-side from the quote. Discover the
acceptable `purpose`/`sourceOfFunds` values with GET /v1/payments/enums
and GET /v1/payments/requirements. Returns 202.




## OpenAPI

````yaml /api-reference/openapi.yaml post /payments/offramp
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:
  /payments/offramp:
    post:
      tags:
        - Payments
      summary: Send an off-ramp cash-out
      description: |
        Cashes out to a beneficiary's real-world (non-CRYPTO) payment
        destination, executed asynchronously against a quote from
        POST /v1/quotes. `paymentDestinationId` must be a non-CRYPTO
        destination; crypto goes via P2P or swap. Pricing is never accepted
        from the caller: `amount`, `receiveAmount`, `receiveCurrency`, and the
        service commission are resolved server-side from the quote. Discover the
        acceptable `purpose`/`sourceOfFunds` values with GET /v1/payments/enums
        and GET /v1/payments/requirements. Returns 202.
      operationId: createOfframpPayment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OfframpPaymentRequest'
            example:
              idempotencyKey: 3d594650-3436-11e5-bf7f-0002a5d5c51b
              transactionId: order-9950
              walletId: 66666666-6666-6666-6666-666666666666
              beneficiaryId: 77777777-7777-7777-7777-777777777777
              paymentDestinationId: aaaa1111-2222-3333-4444-555566667777
              quoteId: bbbb1111-2222-3333-4444-555566667777
              sendingAssetCode: USDZ
              purpose: FAMILY_SUPPORT
              sourceOfFunds: SALARY
      responses:
        '202':
          description: Off-ramp accepted for asynchronous processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAccepted'
        '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'
        '504':
          $ref: '#/components/responses/UpstreamTimeout'
components:
  schemas:
    OfframpPaymentRequest:
      type: object
      required:
        - idempotencyKey
        - transactionId
        - walletId
        - beneficiaryId
        - paymentDestinationId
        - quoteId
        - sendingAssetCode
      properties:
        idempotencyKey:
          type: string
        transactionId:
          type: string
        externalReference:
          type: string
          description: Optional; defaults to idempotencyKey downstream.
        walletId:
          type: string
          format: uuid
          description: Source wallet.
        beneficiaryId:
          type: string
          format: uuid
        paymentDestinationId:
          type: string
          format: uuid
          description: A non-CRYPTO payment destination.
        quoteId:
          type: string
          format: uuid
          description: A quote from POST /v1/quotes.
        sendingAssetCode:
          type: string
          description: >-
            Asset to send — bare code (e.g. USDZ). The issuer is resolved
            server-side from the asset registry.
          example: USDZ
        purpose:
          type: string
          description: >-
            Purpose of remittance. Discover values via GET /v1/payments/enums
            and /v1/payments/requirements.
        sourceOfFunds:
          type: string
          description: Sender source of funds, when the connector requires it.
        beneficiarySourceOfFunds:
          type: string
          description: Beneficiary source of funds, when the connector requires it.
    PaymentAccepted:
      type: object
      required:
        - transactionRecordId
        - status
      description: >-
        A 202 means the submission was accepted for asynchronous execution, not
        that it settled. Track completion with the Transactions routes or
        webhooks.
      properties:
        transactionRecordId:
          type: string
          format: uuid
          description: >-
            The transaction record id, used with GET
            /v1/transactions/{transactionId}.
        intentId:
          type: string
          description: Downstream intent id, when present.
        status:
          type: string
          description: Submission status; not a terminal transaction status.
          example: accepted
        isIdempotent:
          type: boolean
          description: >-
            True when this response replays a prior submission with the same
            idempotencyKey.
        message:
          type: string
    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'
    UpstreamTimeout:
      description: A downstream service timed out.
      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.

````