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

# Get Payment Order



## OpenAPI

````yaml get /v1/wallets/{id}/deposit/fiat/orders/{orderId}
openapi: 3.0.3
info:
  title: Blockradar Documentation
  description: >-
    The OpenAPI specification of the Blockradar API that enables fintechs and
    developers to seamlessly integrate stablecoin deposits and payments into
    their products.
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.blockradar.co
security:
  - apiKey: []
tags:
  - name: Rewards
    description: >-
      Non-custodial yield (Earn) on stablecoins via regulated (Fija) and DeFi
      (Aave) strategies. Deposit, withdraw, preview fees, and read positions and
      earnings at the business, wallet, and sub-address level. Amounts are
      returned net of the platform fee, which applies only to interest earned.
  - name: Wallet
    description: >-
      Wallet Management System


      Comprehensive wallet management API for multi-blockchain operations. This
      system handles wallet creation, configuration, balance monitoring, and
      integration with various blockchain networks.


      Core Functionality:


      - Multi-blockchain wallet creation and management

      - Balance monitoring and asset tracking

      - Auto-settlement rule configuration

      - Gateway wallet integration

      - Address generation and management

      - Transaction monitoring and processing
  - name: Addresses
    description: >-
      Address Management System


      Comprehensive blockchain address management API for operations. This
      system handles address creation, validation, monitoring, and management
      across multiple blockchain networks.


      Core Functionality:


      - Multi-blockchain address generation

      - Address validation and verification

      - Balance monitoring and tracking

      - Transaction history management

      - Address labeling and organization

      - Integration with wallet systems

      - Real-time address monitoring
  - name: Asset
  - name: Transactions
  - name: Withdraw
    description: >-
      The Withdraw feature allows you to programmatically withdraw stablecoins
      from your master wallet with ease
  - name: Withdraw Fiat
  - name: Signing
    description: >-
      Typed data signing service for secure transaction authorization. Supports
      all EIP-712 standards including EIP-3009 (TransferWithAuthorization) and
      EIP-2612 (Permit).
  - name: Swap
    description: >-
      The Swap feature enables users to exchange one stabelcoin asset for
      another across different blockchains. This feature provides a seamless way
      to convert between different stablecoins while maintaining security and
      compliance standards.
  - name: Liquidity Pool
  - name: Virtual Accounts
    description: >-
      Virtual Accounts API provides endpoints for managing virtual bank accounts
      linked to master wallets or child addresses. This API enables businesses
      to:


      - Create virtual accounts for customers to receive payments

      - Retrieve virtual account details

      - Activate/deactivate virtual accounts


      **Virtual Account Types:**


      Virtual accounts support different types with varying behaviors:


      1. **AUTO_FUNDING** (Default):

          - Automatically mints stablecoin when fiat payments are received

          - Transfers the stablecoin to the linked wallet/address immediately

          - Best for real-time payment processing


      **How It Works - Auto-Funding Flow (AUTO_FUNDING type only):**


      When a customer sends fiat currency to a virtual account with type
      AUTO_FUNDING:


      1. **Payment Receipt**: The payment is received in the virtual account

      2. **Automatic Minting**: The system automatically mints the stablecoin
      equivalent

      3. **Blockchain Transfer**: The minted stablecoin is transferred to the
      virtual account's linked wallet or address


      **Note**: The auto-funding flow only applies to virtual accounts with type
      `AUTO_FUNDING`.

      Other types have different processing behaviors.


      ## Prerequisites


      Before creating virtual accounts, ensure:


      - **Compliance requirements must be completed** (see [Compliance
      Requirements](http://localhost:3000/essentials/virtual-accounts#compliance-requirements)
      section below)

      - **Virtual accounts feature must be enabled** for your business (reach
      out to [support@blockradar.co](https://mailto:support@blockradar.co) or
      use live chat on the dashboard to enable the feature after compliance
      approval)

      - **Only available on MAINNET environment** (not available on testnet)

      - **Master Wallet must support stablecoin asset** - Your account plan must
      include stablecoin access (upgrade from Dashboard → Settings →
      Subscription if needed)


      **Supported Currency:**


      - Fiat: NGN (Nigerian Naira)

      - Stablecoin: cNGN - minted automatically on blockchain (for AUTO_FUNDING
      type)
  - name: Auto Settlements
    description: >-
      Creates a new auto settlement rule for a wallet. Auto settlement
      automatically transfers/swap assets based on configured rules when certain
      conditions are met.


      Rules can be configured for:


      - Source blockchain and assets

      - Destination blockchain and asset

      - Amount ranges (min/max)

      - Slippage tolerance

      - Gateway vs non-gateway wallets


      Gateway rules are required for testnet wallets and must have matching
      source/destination assets.
  - name: Smart Contract
    description: >-
      This API provides endpoints for interacting with smart contracts on the
      blockchain. It allows for reading contract data, executing contract
      functions, and estimating network fees.
  - name: Gateway
    description: >-
      The Gateway feature enables you to programmatically deposit USDC into a
      unified, chain-abstracted balance and instantly mint USDC on any supported
      blockchain, streamlining crosschain transfers and eliminating manual
      bridging steps and rebalancing complexities.
  - name: Payment Links
    description: >-
      The Payment Pages API provides a quick and secure way to collect payment
      for servcies.
  - name: Beneficiaries
    description: >-
      This API allows you to create beneficiaries with automatic settlements to
      your external wallets on a periodic basis.


      Example frequencies: INSTANT, DAILY, WEEKLY, MONTHLY, YEARLY
  - name: AML
    description: >-
      The AML (Anti Money Laundering) API provides a quick way for you to check
      if an address is blacklisted or sanctioned
  - name: Asset Recovery
    description: >-
      Enables the recovery (salvage) of both native blockchain assets and tokens
      from a specified sender address to a recipient address. This feature
      supports emergency fund recovery and asset consolidation operations.
  - name: Miscellaneous
    description: >-
      The Miscellaneous API are supporting APIs that can be used to provide more
      details to other APIs.
  - name: Asset1
  - name: Blockchain
  - name: Webhooks
    description: >-
      Webhooks allow you to set up a notification system that can be used to
      receive updates on certain requests made to the Blockradar API.

      To see full list and instructions
      [https://docs.blockradar.co/essentials/webhooks](https://docs.blockradar.co/essentials/webhooks)


      ##
  - name: Deposit
  - name: Withdraw1
  - name: Swap1
  - name: Gateway1
paths:
  /v1/wallets/{id}/deposit/fiat/orders/{orderId}:
    get:
      tags:
        - Deposit Fiat
      summary: Get Payment Order
      operationId: DepositFiatController_getPaymentOrder
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
            format: uuid
          description: Wallet identifier.
          example: 4465468a-3c36-4536-918a-91d689e18a74
        - name: orderId
          required: true
          in: path
          schema:
            type: string
            format: uuid
          description: Payment order identifier.
          example: 80ea45ab-38b9-4506-b213-52da8bc7e825
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentOrderResponse'
              example:
                statusCode: 200
                message: Successful
                data:
                  id: 80ea45ab-38b9-4506-b213-52da8bc7e825
                  type: deposit
                  rail: one_time_virtual_account
                  reference: dep_20260719_001
                  providerReference: provider_order_839201
                  transactionId: null
                  status: pending
                  currency: NGN
                  amount: '100.00'
                  amountFiat: '155000.00'
                  feeFiat: '1500.00'
                  amountFiatPayable: '156500.00'
                  amountFiatReceived: null
                  amountSettled: null
                  expiresAt: '2026-07-19T13:00:00.000Z'
                  paymentInstructions:
                    type: one_time_virtual_account
                    bank:
                      name: Example Bank
                      code: '999'
                      accountName: Blockradar / Acme Ltd
                      accountNumber: '0123456789'
                    paymentLink: null
                    qrCode: null
                    expiresAt: '2026-07-19T13:00:00.000Z'
                    metadata: null
                  metadata:
                    checkoutId: checkout_123
                  provider:
                    id: 1128dd40-2c94-4c16-a6bf-fbbc6afee52c
                    slug: example-provider
                    name: Example Provider
                  wallet:
                    id: 4465468a-3c36-4536-918a-91d689e18a74
                    address: '0x947514e4B803e312C312da0F1B41fEDdbe15ae7a'
                  address: null
                  asset:
                    id: ae455f23-3824-4125-baab-d158315cbcbd
                    symbol: USDC
                    name: USD Coin
                  customer:
                    id: 18d2f159-e0cd-4a45-b735-e9dfe0f7520a
                  createdAt: '2026-07-19T12:30:00.000Z'
                  updatedAt: '2026-07-19T12:30:00.000Z'
components:
  schemas:
    PaymentOrderResponse:
      type: object
      properties:
        statusCode:
          type: integer
          example: 200
        message:
          type: string
          description: Human-readable result.
          example: Payment order fetched successfully
        data:
          $ref: '#/components/schemas/PaymentOrder'
      required:
        - statusCode
        - message
        - data
    PaymentOrder:
      type: object
      properties:
        id:
          type: string
          description: Payment order identifier.
          example: 80ea45ab-38b9-4506-b213-52da8bc7e825
          format: uuid
        type:
          type: string
          description: Order type.
          example: deposit
        rail:
          $ref: '#/components/schemas/CurrencyConversionRouteRailEnum'
        reference:
          type: string
          description: Client-provided or generated idempotency reference.
          example: dep_20260719_001
        providerReference:
          type: string
          description: Provider order reference.
          example: provider_order_839201
          nullable: true
        transactionId:
          type: string
          description: Settlement transaction identifier.
          example: null
          format: uuid
          nullable: true
        status:
          $ref: '#/components/schemas/ProviderPaymentOrderStatusEnum'
        currency:
          type: string
          description: ISO 4217 fiat currency.
          example: NGN
        amount:
          type: string
          description: Stablecoin amount to settle.
          example: '100.00'
        amountFiat:
          type: string
          description: Fiat equivalent before fees.
          example: '155000.00'
        feeFiat:
          type: string
          description: Fiat fee.
          example: '1500.00'
        amountFiatPayable:
          type: string
          description: Total fiat amount payable.
          example: '156500.00'
        amountFiatReceived:
          type: string
          description: Fiat amount received.
          example: null
          nullable: true
        amountSettled:
          type: string
          description: Stablecoin amount settled.
          example: null
          nullable: true
        expiresAt:
          type: string
          description: Payment expiry time.
          example: '2026-07-19T13:00:00.000Z'
          format: date-time
          nullable: true
        paymentInstructions:
          $ref: '#/components/schemas/PaymentInstructions'
          nullable: true
        metadata:
          type: object
          nullable: true
          additionalProperties: true
        provider:
          type: object
          properties:
            id:
              type: string
              description: Provider identifier.
              example: 1128dd40-2c94-4c16-a6bf-fbbc6afee52c
              format: uuid
            slug:
              type: string
              description: Provider slug.
              example: example-provider
            name:
              type: string
              description: Provider name.
              example: Example Provider
          required:
            - id
            - slug
            - name
        wallet:
          type: object
          properties:
            id:
              type: string
              description: Wallet identifier.
              example: 4465468a-3c36-4536-918a-91d689e18a74
              format: uuid
            address:
              type: string
              description: Wallet blockchain address.
              example: '0x947514e4B803e312C312da0F1B41fEDdbe15ae7a'
          required:
            - id
            - address
        address:
          type: object
          nullable: true
          properties:
            id:
              type: string
              description: Child address identifier.
              example: a2746f77-56b1-4b34-b0f3-53ad99bf53e2
              format: uuid
            address:
              type: string
              description: Child blockchain address.
              example: 0x8Fcb...f12
          required:
            - id
            - address
        asset:
          type: object
          properties:
            id:
              type: string
              description: Asset identifier.
              example: ae455f23-3824-4125-baab-d158315cbcbd
              format: uuid
            symbol:
              type: string
              description: Asset symbol.
              example: USDC
            name:
              type: string
              description: Asset name.
              example: USD Coin
          required:
            - id
            - symbol
            - name
        customer:
          type: object
          nullable: true
          properties:
            id:
              type: string
              description: Customer identifier.
              example: 18d2f159-e0cd-4a45-b735-e9dfe0f7520a
              format: uuid
          required:
            - id
        createdAt:
          type: string
          description: Creation timestamp.
          example: '2026-07-19T12:30:00.000Z'
          format: date-time
        updatedAt:
          type: string
          description: Last update timestamp.
          example: '2026-07-19T12:30:00.000Z'
          format: date-time
      required:
        - id
        - type
        - rail
        - reference
        - status
        - currency
        - amount
        - amountFiat
        - feeFiat
        - amountFiatPayable
        - provider
        - wallet
        - asset
        - createdAt
        - updatedAt
    CurrencyConversionRouteRailEnum:
      type: string
      enum:
        - one_time_virtual_account
        - payment_link
        - qr_code
      description: Supported fiat collection rail.
    ProviderPaymentOrderStatusEnum:
      type: string
      enum:
        - pending
        - paid
        - processing
        - expired
        - failed
        - cancelled
      description: Current payment-order lifecycle status.
    PaymentInstructions:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CurrencyConversionRouteRailEnum'
        bank:
          type: object
          nullable: true
          properties:
            name:
              type: string
              description: Bank name.
              example: Example Bank
            code:
              type: string
              description: Bank code.
              example: '999'
              nullable: true
            accountName:
              type: string
              description: Account holder name.
              example: Blockradar / Acme Ltd
            accountNumber:
              type: string
              description: Account number.
              example: '0123456789'
          required:
            - name
            - accountName
            - accountNumber
        paymentLink:
          type: object
          nullable: true
          properties:
            url:
              type: string
              description: Hosted payment URL.
              example: https://pay.example.com/order/839201
              format: uri
          required:
            - url
        qrCode:
          type: object
          nullable: true
          properties:
            payload:
              type: string
              description: Raw QR payload.
              example: 000201010212...
              nullable: true
            imageUrl:
              type: string
              description: QR image URL.
              example: https://pay.example.com/qr/839201.png
              format: uri
              nullable: true
        expiresAt:
          type: string
          description: Instruction expiry time.
          example: '2026-07-19T13:00:00.000Z'
          format: date-time
          nullable: true
        metadata:
          type: object
          nullable: true
          additionalProperties: true
      required:
        - type
  securitySchemes:
    apiKey:
      type: apiKey
      name: x-api-key
      in: header

````