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

# Get the status of a fiat on-ramp payment

> Get the current status of a fiat on-ramp payment.

Poll this after `create` until `status` is `delivered`. The `status` field
is one of:

- `pending` — awaiting the card payment in the hosted checkout.
- `processing` — payment received; bridging/swapping the proceeds to USDC.
- `delivered` — USDC has been delivered to the destination wallet
  (`delivery_tx_hash` and `output_amount_delivered` are populated).
- `failed` — the payment failed, expired, or was refunded.

State is re-read live from the on-ramp provider on every call — Compass
stores nothing of its own.



## OpenAPI

````yaml /v2/combined_spec.json get /v2/onramp/status
openapi: 3.1.0
info:
  title: Compass API
  description: Compass Labs DeFi API
  version: 0.0.1
servers:
  - url: https://api.compasslabs.ai
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /v2/onramp/status:
    get:
      tags:
        - Onramp
      summary: Get the status of a fiat on-ramp payment
      description: >-
        Get the current status of a fiat on-ramp payment.


        Poll this after `create` until `status` is `delivered`. The `status`
        field

        is one of:


        - `pending` — awaiting the card payment in the hosted checkout.

        - `processing` — payment received; bridging/swapping the proceeds to
        USDC.

        - `delivered` — USDC has been delivered to the destination wallet
          (`delivery_tx_hash` and `output_amount_delivered` are populated).
        - `failed` — the payment failed, expired, or was refunded.


        State is re-read live from the on-ramp provider on every call — Compass

        stores nothing of its own.
      operationId: v2_onramp_status
      parameters:
        - name: payment_id
          in: query
          required: true
          schema:
            type: string
            description: The `payment_id` returned by `POST /v2/onramp/create`.
            title: Payment Id
          description: The `payment_id` returned by `POST /v2/onramp/create`.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnrampStatus'
        '404':
          description: '`PAYMENT_NOT_FOUND` — no payment matches the provided id.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnrampErrorResponse'
        '422':
          description: >-
            `UNSUPPORTED_ONRAMP_OUTPUT` — delivery is limited to USDC on
            Ethereum.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnrampErrorResponse'
        '502':
          description: '`HALLIDAY_API_UNAVAILABLE` — the on-ramp provider is unavailable.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnrampErrorResponse'
      x-codeSamples:
        - lang: python
          label: Python (SDK)
          source: |-
            from compass_api_sdk import CompassAPI


            with CompassAPI(
                api_key_auth="<YOUR_API_KEY_HERE>",
            ) as compass_api:

                res = compass_api.onramp.onramp_status(payment_id="<id>")

                # Handle response
                print(res)
        - lang: typescript
          label: Typescript (SDK)
          source: |-
            import { CompassApiSDK } from "@compass-labs/api-sdk";

            const compassApiSDK = new CompassApiSDK({
              apiKeyAuth: "<YOUR_API_KEY_HERE>",
            });

            async function run() {
              const result = await compassApiSDK.onramp.onrampStatus({
                paymentId: "<id>",
              });

              console.log(result);
            }

            run();
components:
  schemas:
    OnrampStatus:
      properties:
        payment_id:
          type: string
          title: Payment Id
          description: Halliday's payment id, echoed straight through.
        status:
          type: string
          enum:
            - pending
            - processing
            - delivered
            - failed
          title: Status
          description: >-
            Lifecycle state: `pending` (awaiting card payment), `processing`
            (payment received, bridging/swapping to USDC), `delivered` (USDC
            received in the destination wallet), or `failed`.
        output_amount_delivered:
          anyOf:
            - type: string
            - type: 'null'
          title: Output Amount Delivered
          description: USDC delivered so far, human-readable. Set once delivered.
        delivery_tx_hash:
          anyOf:
            - type: string
            - type: 'null'
          title: Delivery Tx Hash
          description: Ethereum tx hash of the USDC delivery, once available.
        destination_address:
          anyOf:
            - type: string
            - type: 'null'
          title: Destination Address
          description: The wallet the USDC is delivered to.
        updated_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Updated At
          description: ISO-8601 timestamp of the last status change, if provided.
      type: object
      required:
        - payment_id
        - status
      title: OnrampStatus
      description: >-
        Current state of a fiat on-ramp payment.


        Re-read on demand from Halliday (the system of record) — Compass holds
        no

        state of its own.
    OnrampErrorResponse:
      properties:
        error:
          type: string
          title: Error
          description: >-
            Short human-readable error label (e.g. `Payment not found.`,
            `On-ramp provider unavailable`, `Identity verification required`).
        message:
          type: string
          title: Message
          description: Human-readable explanation.
      type: object
      required:
        - error
        - message
      title: OnrampErrorResponse
      description: >-
        Standard error envelope returned by every non-2xx on-ramp response.


        Surfaced in OpenAPI ``responses`` declarations so SDK consumers can
        decode

        failures uniformly without inspecting per-status-code shapes.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your Compass API Key. Get your key
        [here](https://www.compasslabs.ai/dashboard).

````