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

# Get a currency order

> Retrieve detailed information about a specific currency order including buyer details, quantity, pricing, and delivery status.



## OpenAPI

````yaml /api/openapi.json get /v2/currency-orders/{currencyOrder}
openapi: 3.1.0
info:
  title: GameBoost
  version: 2.0.0
servers:
  - url: https://api.gameboost.com
    description: GameBoost API
security:
  - BearerTokenSecurityScheme: []
tags:
  - name: Games
    description: Games
  - name: Seller Breaks
    description: Seller Breaks
  - name: Payments
    description: Payments
  - name: Payouts
    description: Payouts
  - name: Account Offers
    description: Account Offers
  - name: Account Orders
    description: Account Orders
  - name: Item Offers
    description: Item Offers
  - name: Item Orders
    description: Item Orders
  - name: Currency Offers
    description: Currency Offers
  - name: Currency Orders
    description: Currency Orders
  - name: Webhooks
    description: Webhook events sent to your endpoints when specific actions occur
  - name: Gift Card Offers
    description: Gift Card Offers
  - name: Gift Card Orders
    description: Gift Card Orders
paths:
  /v2/currency-orders/{currencyOrder}:
    get:
      tags:
        - Currency Orders
      summary: Get a currency order
      description: >-
        Retrieve detailed information about a specific currency order including
        buyer details, quantity, pricing, and delivery status.
      parameters:
        - name: currencyOrder
          in: path
          description: >-
            The ID of the currency order. Can be retrieved from the list of
            currency orders, or from the parent currency offer, or from
            webhooks.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: A single currency order
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CurrencyOrder'
        '401':
          $ref: '#/components/responses/ErrorUnauthenticated'
        '403':
          $ref: '#/components/responses/ErrorForbidden'
        '404':
          $ref: '#/components/responses/ErrorNotFound'
        '429':
          $ref: '#/components/responses/ErrorRateLimited'
      security:
        - BearerToken: []
components:
  schemas:
    CurrencyOrder:
      description: Currency order object representing a purchase of in-game currency
      type: object
      properties:
        id:
          description: Unique identifier for the currency order
          type: integer
        currency_offer_id:
          description: ID of the related currency offer
          type: integer
        game:
          $ref: '#/components/schemas/GameRelation'
        buyer:
          $ref: '#/components/schemas/Buyer'
        rating:
          $ref: '#/components/schemas/Rating'
        title:
          description: Display title for the currency order
          type: string
        description:
          description: Detailed description of the currency being purchased
          type: string
          nullable: true
        quantity:
          description: Amount of currency units ordered
          type: integer
        currency_unit:
          $ref: '#/components/schemas/CurrencyUnit'
        parameters:
          description: Game-specific parameters such as server, realm, or faction
          type: object
          nullable: true
        status:
          description: Current status of the currency order
          enum:
            - pending
            - in_delivery
            - delivered
            - refunded
          type: string
        is_disputed:
          description: Indicates if the currency order currently has an active dispute case
          type: boolean
        dispute_case_id:
          description: >-
            Identifier of the active dispute case for this currency order, or
            null if not disputed
          type: integer
          nullable: true
        delivery_time:
          $ref: '#/components/schemas/DeliveryTime'
        credentials:
          description: Account credentials provided by buyer for currency delivery
          type: object
          example:
            uid: 1234567890
        completion_proof_url:
          description: URL to proof of order completion (screenshot or video)
          type: string
          nullable: true
        price_eur:
          description: Total order price in EUR currency
          type: string
        price_usd:
          description: Total order price converted to USD using current exchange rates
          type: string
        unit_price_eur:
          description: Price per unit in EUR
          type: string
        unit_price_usd:
          description: Price per unit in converted to USD using current exchange rates
          type: string
        created_at:
          description: Unix timestamp when the currency order was created
          type: integer
        updated_at:
          description: Unix timestamp of the last modification to the currency order
          type: integer
        purchased_at:
          description: Unix timestamp when the currency order was purchased
          type: integer
          nullable: true
        completed_at:
          description: Unix timestamp when the currency order was successfully delivered
          type: integer
          nullable: true
        refunded_at:
          description: Unix timestamp when the currency order was refunded
          type: integer
          nullable: true
    GameRelation:
      description: Basic game information used in relations
      type: object
      properties:
        id:
          description: Unique identifier for the game
          type: integer
        name:
          description: Display name of the game
          type: string
        slug:
          description: URL-friendly identifier for the game
          type: string
    Buyer:
      description: Buyer information for an order
      type: object
      properties:
        id:
          description: Unique identifier for the buyer
          type: integer
        username:
          description: Censored username of the buyer
          type: string
    Rating:
      description: Rating object representing feedback from a buyer
      type: object
      properties:
        id:
          description: Unique identifier for the rating
          type: integer
        labels:
          description: Array of predefined label names that categorize the rating feedback
          type: array
          items:
            type: string
          nullable: true
        rating:
          description: Rating value (0=negative, 1=positive)
          type: integer
        comment:
          description: Rating comment text
          type: string
        created_at:
          description: Unix timestamp when the rating was created
          type: integer
        updated_at:
          description: Unix timestamp of the last modification to the rating
          type: integer
    CurrencyUnit:
      description: Currency unit object representing a denomination of in-game currency
      type: object
      properties:
        slug:
          description: URL-friendly identifier for the currency unit
          type: string
        currency_name:
          description: Full name of the in-game currency (e.g., "Gold", "Credits")
          type: string
        name:
          description: Display name of this unit denomination
          type: string
        symbol:
          description: Symbol or abbreviation for the unit (e.g., "K", "M", "B")
          type: string
        multiplier:
          description: >-
            Numeric multiplier for unit conversion (e.g., 1000 for thousands,
            1000000 for millions)
          type: integer
    DeliveryTime:
      description: Delivery time object representing expected delivery duration
      type: object
      properties:
        duration:
          description: Numeric value representing the delivery time
          type: integer
        unit:
          description: Time unit for the duration (minutes, hours, days)
          enum:
            - minutes
            - hours
            - days
          type: string
        format:
          description: Human-readable delivery time (e.g., "2 hr")
          type: string
        format_long:
          description: Extended format delivery time (e.g., "2 hours")
          type: string
        seconds:
          description: Total delivery time converted to seconds
          type: integer
  responses:
    ErrorUnauthenticated:
      description: >-
        User is not authenticated, happens when the API key is missing, expired
        or invalid
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Unauthenticated.
    ErrorForbidden:
      description: >-
        User is not authorized to perform this action, happens when you try to
        access a resource you do not have permission to access
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: This action is unauthorized.
    ErrorNotFound:
      description: Resource not found, happens when the requested resource does not exist
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Resource not found.
    ErrorRateLimited:
      description: >-
        Rate limit exceeded, happens when you exceed the rate limit for the
        endpoint
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Too many requests.
  securitySchemes:
    BearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT

````