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

# Get On-Ramp Purchase

> Look up a fiat on-ramp purchase by id. Use this to reconcile a purchase you may have missed the
`onramp.completed` webhook for, or to check one that is still in flight.

The response is the `onramp.completed` webhook payload plus a `status` field. A purchase that has not
settled yet returns partial data — `transactionHash` and `completedAt` are `null` until `status` is
`FINISHED` — so read `status` rather than inferring completion from the hash.

Scoped to the calling partner. A purchase that does not exist, is malformed, or belongs to a different
partner all return an identical `404`.




## OpenAPI

````yaml /openapi.yaml get /v1/onramp/purchases/{purchaseId}
openapi: 3.0.3
info:
  title: Para REST API
  version: '1.0'
  description: Server-to-server wallet creation and signing over HTTP
servers:
  - url: https://api.beta.getpara.com
    description: Beta
  - url: https://api.getpara.com
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /v1/onramp/purchases/{purchaseId}:
    get:
      tags:
        - On-Ramp
      summary: Get On-Ramp Purchase
      description: >
        Look up a fiat on-ramp purchase by id. Use this to reconcile a purchase
        you may have missed the

        `onramp.completed` webhook for, or to check one that is still in flight.


        The response is the `onramp.completed` webhook payload plus a `status`
        field. A purchase that has not

        settled yet returns partial data — `transactionHash` and `completedAt`
        are `null` until `status` is

        `FINISHED` — so read `status` rather than inferring completion from the
        hash.


        Scoped to the calling partner. A purchase that does not exist, is
        malformed, or belongs to a different

        partner all return an identical `404`.
      operationId: getOnRampPurchase
      parameters:
        - $ref: '#/components/parameters/RequestId'
        - name: purchaseId
          in: path
          required: true
          description: >-
            Para on-ramp purchase id — the `purchaseId` carried on the
            `ONRAMP_LAUNCHED` SDK event when the ramp launched, and on the
            `onramp.completed` webhook when it settled.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: On-ramp purchase record
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnRampPurchaseRecord'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    RequestId:
      name: X-Request-Id
      in: header
      required: false
      description: UUID for request tracing. Para returns one if omitted.
      schema:
        type: string
        format: uuid
  schemas:
    OnRampPurchaseRecord:
      type: object
      required:
        - status
        - userId
        - purchaseId
        - provider
        - transactionHash
        - asset
        - testMode
        - completedAt
      properties:
        status:
          type: string
          enum:
            - INITIATED
            - CANCELLED
            - FINISHED
          description: >
            Lifecycle state. `INITIATED` = created, not yet settled. `FINISHED`
            = the provider confirmed delivery

            (this is when `onramp.completed` fires). `CANCELLED` = the purchase
            will not settle. **Treat unknown

            status values as non-terminal** — future versions may add states.
        userId:
          type: string
          format: uuid
        purchaseId:
          type: string
          format: uuid
          description: Para's id for this purchase.
        provider:
          type: string
          enum:
            - COINBASE
            - MOONPAY
            - RAMP
            - STRIPE
          description: >-
            The provider that fulfilled the purchase. Coinbase Apple Pay reports
            as `COINBASE`; the surface is conveyed by `paymentMethod`.
        paymentMethod:
          type: string
          enum:
            - WIDGET
            - APPLE_PAY
          description: Checkout style used.
        transactionHash:
          type: string
          nullable: true
          description: >-
            On-chain hash of the crypto delivered to the user. `null` until
            settled, and also `null` when the provider settled without reporting
            one.
        asset:
          type: object
          description: >-
            The delivered token, resolved from the catalog. Fields are
            best-effort; an empty object means the token could not be resolved.
          properties:
            symbol:
              type: string
              example: USDC
            name:
              type: string
              example: USD Coin
            contractAddress:
              type: string
              nullable: true
              description: Token contract address, or `null` for a network's native asset.
            type:
              type: string
              description: Ecosystem — e.g. `EVM`, `SOLANA`, `COSMOS`.
            chainId:
              type: string
              example: '8453'
            networkName:
              type: string
              example: Base
            decimals:
              type: integer
              nullable: true
        assetQuantity:
          type: string
          description: Crypto amount delivered, as a decimal token amount.
        fiatAmount:
          type: string
        fiatCurrency:
          type: string
          example: USD
        walletId:
          type: string
          format: uuid
          nullable: true
          description: >-
            Set when the crypto landed in a Para wallet; absent for a raw
            external-address destination.
        destinationAddress:
          type: string
          nullable: true
          description: The on-chain address the crypto was delivered to.
        testMode:
          type: boolean
          description: >-
            Whether this was a test purchase. Test purchases run a real quote
            but are never charged — filter them out of production accounting.
        completedAt:
          type: string
          format: date-time
          nullable: true
          description: >-
            When the purchase was marked settled. `null` unless `status` is
            `FINISHED`.
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Machine-readable error code for programmatic handling
          example: INVALID_REQUEST
        message:
          type: string
          description: Human-readable error message
        transactionId:
          type: string
          format: uuid
          description: >-
            Persisted transaction record id. Present only when a broadcast
            request failed after a history row was created.
        failureStage:
          type: string
          enum:
            - mpc_sign
            - signature_apply
            - signer_verify
            - broadcast
            - monitor_timeout
          description: >-
            Which stage of the broadcast lifecycle failed. Present on persisted
            broadcast failures.
        failureCode:
          type: string
          description: >-
            Machine-readable failure reason from the underlying broadcast helper
            (e.g. `INSUFFICIENT_NATIVE_BALANCE`, `EXECUTION_FAILED`). Present on
            broadcast-stage failures.
        signedTransaction:
          type: string
          description: >-
            Signed transaction bytes. Present on broadcast failures that happen
            after signing completed.
      additionalProperties: true
      description: >
        All error responses include `code` and `message` fields. Some errors
        include extra fields (e.g. `walletId` on 409 Conflict).

        Broadcast failures that occur after a persisted transaction row is
        created include `transactionId`,

        `failureStage`, and (on broadcast-stage failures) `failureCode`, and
        also set the `x-transaction-id`

        response header. If signing completed before the failure,
        `signedTransaction` is included so callers

        can inspect or retry the already-signed bytes.


        Common error codes: `INVALID_REQUEST`, `UNAUTHORIZED`, `FORBIDDEN`,
        `NOT_FOUND`, `CONFLICT`, `WALLET_ALREADY_EXISTS`,
        `WALLET_ALREADY_CLAIMED`, `RATE_LIMITED`, `INTERNAL_ERROR`.
  responses:
    BadRequest:
      description: Invalid request body
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: INVALID_REQUEST
            message: type must be one of EVM, SOLANA, COSMOS, STELLAR, SUI
    Unauthorized:
      description: API key not provided
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: UNAUTHORIZED
            message: secret api key not provided
    NotFound:
      description: Wallet not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: NOT_FOUND
            message: wallet not found
    TooManyRequests:
      description: Rate limit exceeded
      headers:
        Retry-After:
          schema:
            type: integer
          description: Seconds until the rate limit window resets
          example: 60
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: RATE_LIMITED
            message: Rate limit exceeded, try again shortly.
    ServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: INTERNAL_ERROR
            message: Internal Server Error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your partner secret key (server-side only)
      x-default: sk_your_secret_key_here

````