> ## Documentation Index > Fetch the complete documentation index at: https://docs.crossmint.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Order > Retrieves an onramp order by its ID to track its progress through KYC, recipient verification, payment, and delivery. ## OpenAPI ````yaml api-reference/_open-api/OnrampAPIs.json GET /2022-06-09/orders/{orderId} openapi: 3.0.1 info: description: | N/A version: 1.0.0 title: Onramp contact: name: Crossmint Onramp APIs url: https://www.crossmint.com email: support@crossmint.com servers: - url: https://staging.crossmint.com/api description: Staging environment (testnets) - url: https://www.crossmint.com/api description: Production environment (mainnets) security: [] tags: - name: Onramp description: APIs to buy tokens with a card (onramp) paths: /2022-06-09/orders/{orderId}: get: tags: - Onramp summary: Get Order description: > Retrieves an onramp order by its ID. Use this endpoint to poll the order and track its progress through the onramp flow: KYC, recipient verification (for external wallets), payment, and delivery. Read `payment.status` to determine the next action for the buyer. **Authentication**: Use either a server-side API key with the `orders.read` scope, or the `clientSecret` returned when the order was created, passed as an `Authorization` header. operationId: get-onramp-order parameters: - $ref: '#/components/parameters/orderId' responses: '200': description: Order successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/OrderObject' '400': description: >- Invalid arguments. Make sure you are following the API specification. content: application/json: schema: $ref: '#/components/schemas/400Response' '403': description: Forbidden error. Ensure the credentials are correct. content: application/json: schema: $ref: '#/components/schemas/403Response' '404': description: Not found error. content: application/json: schema: $ref: '#/components/schemas/404Response' '503': description: >- Try again in a few minutes. If the issue still persists, contact Crossmint support. content: application/json: schema: $ref: '#/components/schemas/503Response' '524': description: A timeout occurred. content: application/json: schema: $ref: '#/components/schemas/524Response' security: - apiKey: [] - orderClientSecret: [] components: parameters: orderId: name: orderId in: path description: | The identifier of the onramp order, in UUID format. **Example:** `9c82ef99-617f-497d-9abb-fd355291681b` required: true schema: type: string schemas: OrderObject: type: object properties: orderId: type: string example: b2959ca5-65e4-466a-bd26-1bd05cb4f837 phase: type: string enum: - quote - payment - delivery - completed description: The current phase of the order lifecycle. example: payment lineItems: type: array items: type: object properties: chain: type: string example: solana metadata: type: object properties: name: type: string example: USDC description: type: string example: USDC Token imageUrl: type: string example: https://cryptologos.cc/logos/usd-coin-usdc-logo.svg quote: type: object properties: status: type: string example: valid charges: type: object properties: unit: type: object properties: amount: type: string example: '1.47' currency: type: string example: usd totalPrice: type: object properties: amount: type: string example: '5' currency: type: string example: usd executionMode: type: string example: exact-in executionParams: type: object properties: mode: type: string example: exact-in amount: type: string example: '5' quote: type: object properties: status: type: string enum: - valid - expired - requires-recipient - all-line-items-unavailable example: valid quotedAt: type: string example: '2025-03-07T23:04:11.996Z' expiresAt: type: string example: '2025-03-07T23:14:11.996Z' totalPrice: type: object properties: amount: type: string example: '5' currency: type: string example: usd payment: type: object properties: status: type: string enum: - requires-quote - requires-email - requires-recipient-verification - requires-kyc - manual-kyc - failed-kyc - pending-kyc-review - awaiting-payment - in-progress - completed description: >- Status of the payment, used to determine the next action in the onramp flow. `requires-recipient-verification` applies to external wallet recipients that must prove ownership. `requires-kyc`, `manual-kyc`, `failed-kyc`, and `pending-kyc-review` cover the identity verification step. `awaiting-payment` means the buyer can complete the card payment. `in-progress` and `completed` track fulfillment. example: requires-kyc method: type: string example: card currency: type: string example: usd preparation: type: object properties: kyc: type: object properties: provider: type: string enum: - persona example: persona inquiryId: type: string description: >- The identity verification inquiry identifier used to resume or complete KYC with the provider. example: inq_example-inquiry-id sessionToken: type: string description: >- Optional session token used to continue the identity verification inquiry. environmentId: type: string nullable: true description: The provider environment identifier for the inquiry. 400Response: type: object properties: error: type: boolean example: true message: type: string description: Human-readable error message describing what went wrong code: type: string description: Machine-readable error code for programmatic handling 403Response: type: object properties: error: type: boolean example: true message: type: string example: Malformed API key. / API key provided doesn't have required scopes. 404Response: type: object properties: error: type: boolean example: true message: type: string example: Not found 503Response: type: object properties: error: type: boolean example: true message: type: string example: >- Please try again in a few minutes. If the issue still persists, contact Crossmint support. 524Response: type: object properties: error: type: boolean example: true message: type: string example: A timeout occurred. securitySchemes: apiKey: type: apiKey name: X-API-KEY in: header orderClientSecret: type: apiKey name: Authorization in: header description: >- The `clientSecret` returned when the order was created, used to read the order without a server-side API key. ````