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

# Get Order by ID

Retrieve an order by its unique ID.


## OpenAPI

````yaml openapi-v1.yaml GET /sender/orders/{id}
openapi: 3.0.3
info:
  title: Paycrest Aggregator API
  version: 1.0.0
  description: >
    OpenAPI schema for the Paycrest Aggregator API. This covers sender,
    provider, and general endpoints.
servers:
  - url: https://api.paycrest.io/v1
security: []
tags:
  - name: Sender
    description: Endpoints for senders to create and manage payment orders
  - name: Provider
    description: Endpoints for providers to manage and fulfill orders
  - name: General
    description: General protocol and utility endpoints
paths:
  /sender/orders/{id}:
    get:
      tags:
        - Sender
      summary: Get payment order by ID
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Payment order
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/StandardResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/SenderOrderResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    StandardResponse:
      type: object
      properties:
        status:
          type: string
          example: success
        message:
          type: string
          example: Operation successful
        data:
          type: object
          description: The actual response data (e.g., ReceiveAddressResponse, etc.)
    SenderOrderResponse:
      type: object
      properties:
        id:
          type: string
        amount:
          type: string
        amountInUsd:
          type: string
        amountPaid:
          type: string
        amountReturned:
          type: string
        token:
          type: string
          description: >-
            Token symbol (USDT, USDC, cNGN). See [Supported
            Stablecoins](/resources/supported-stablecoins) for available
            options.
        senderFee:
          type: string
        transactionFee:
          type: string
        rate:
          type: string
        network:
          type: string
          enum:
            - ethereum
            - base
            - bnb-smart-chain
            - lisk
            - scroll
            - celo
            - arbitrum-one
            - polygon
            - asset-chain
          description: Network identifier for the blockchain
        gatewayId:
          type: string
        recipient:
          $ref: '#/components/schemas/PaymentOrderRecipient'
        fromAddress:
          type: string
        returnAddress:
          type: string
          description: Deprecated — use refundAddress
        refundAddress:
          type: string
        receiveAddress:
          type: string
        feeAddress:
          type: string
        reference:
          type: string
        orderType:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        txHash:
          type: string
        status:
          type: string
        transactionLogs:
          type: array
          items:
            $ref: '#/components/schemas/TransactionLog'
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          example: error
        message:
          type: string
          example: Error message
        data:
          nullable: true
          description: >-
            null on most errors; an array of field-level errors on validation
            failures
          oneOf:
            - type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
            - type: object
              additionalProperties: true
    PaymentOrderRecipient:
      type: object
      required:
        - institution
        - accountIdentifier
        - accountName
        - memo
      properties:
        institution:
          type: string
          description: >-
            Institution code (SWIFT code or custom PayCrest code ending with
            'PC'). See [Code Standards](/resources/code-standards) for details.
        accountIdentifier:
          type: string
          description: Bank account number, mobile number, or other account identifier
        accountName:
          type: string
          description: Name of the account holder
        memo:
          type: string
          description: Memo or reference for the transaction
        providerId:
          type: string
          description: Optional provider ID for specific routing
        metadata:
          type: object
          description: Additional metadata for the transaction
        currency:
          type: string
          description: >-
            ISO 4217 currency code (e.g., NGN, KES, UGX). See [Supported
            Currencies](/resources/supported-currencies) for available options.
    TransactionLog:
      type: object
      properties:
        id:
          type: string
        gateway_id:
          type: string
        status:
          type: string
        tx_hash:
          type: string
        created_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: API-Key

````