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

# Get invoice status

> Lightweight status poll including deposit details and swap processing state.



## OpenAPI

````yaml /openapi.yaml get /v1/invoices/{id}/status
openapi: 3.1.0
info:
  title: Meum Public Merchant API
  version: 1.0.0
  description: >
    Public merchant API for programmatic payment management: invoices,
    transactions,

    payment links, webhooks, and WooCommerce integration.


    Authenticate with a store-scoped API key (`sk_live_*`) via Bearer token.

    Base URL: https://api.meum.io
  contact:
    name: Meum Support
    email: support@meum.io
    url: https://meum.io
servers:
  - url: https://api.meum.io
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Health
    description: Service health checks
  - name: Invoices
    description: Invoice lifecycle
  - name: Transactions
    description: On-chain payment transactions
  - name: Payment Links
    description: Reusable payment link management
  - name: Webhooks
    description: Webhook endpoint and delivery management
  - name: Integrations
    description: Third-party platform integrations
paths:
  /v1/invoices/{id}/status:
    get:
      tags:
        - Invoices
      summary: Get invoice status
      description: >-
        Lightweight status poll including deposit details and swap processing
        state.
      operationId: getInvoiceStatus
      parameters:
        - $ref: '#/components/parameters/InvoiceId'
      responses:
        '200':
          description: Invoice status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceStatusResponse'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    InvoiceId:
      name: id
      in: path
      required: true
      description: Invoice ID from create or list responses (starts with `inv_`).
      schema:
        type: string
        pattern: ^(inv_|txn_|plink_|wh_|whd_|evt_|int_)[0-9a-z]{20,32}$
  schemas:
    InvoiceStatusResponse:
      type: object
      description: >-
        Lightweight status for polling. Use this to check if a customer has
        paid.
      properties:
        id:
          type: string
          pattern: ^(inv_|txn_|plink_|wh_|whd_|evt_|int_)[0-9a-z]{20,32}$
          description: Invoice ID (`inv_...`).
        status:
          $ref: '#/components/schemas/InvoiceStatus'
        swap_status:
          type:
            - string
            - 'null'
          enum:
            - processing
          description: >
            `processing`: customer paid; funds are being converted and sent to
            you.

            Only present during this step; omit or null otherwise.
          example: processing
        paid_amount:
          type:
            - string
            - 'null'
          description: What the customer sent (e.g. `"100.00"`). `null` if not paid yet.
          example: '100.00'
        received_amount:
          type:
            - string
            - 'null'
          description: >-
            What lands in your wallet after fees (e.g. `"99.50"`). `null` until
            settled.
          example: '99.50'
        difference_amount:
          type:
            - string
            - 'null'
          description: >-
            Difference between received_amount and paid_amount (e.g. "-0.50" for
            fees). null if not paid.
          example: '-0.50'
        transaction_hash:
          type:
            - string
            - 'null'
          description: Blockchain transaction ID once payment is confirmed.
        paid_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When payment was confirmed (UTC). `null` if unpaid.
        deposit_address:
          type:
            - string
            - 'null'
          description: Address shown to the customer during checkout to send payment.
        deposit_memo:
          type:
            - string
            - 'null'
          description: >-
            Extra reference the customer must include with payment, if required
            by the network.
        return_url:
          type:
            - string
            - 'null'
          format: uri
          description: Redirect URL after checkout, if configured.
    InvoiceStatus:
      type: string
      description: |
        Where the invoice is in the payment flow:
        - `pending`: created, not yet ready for payment
        - `quoted`: price quote ready; customer can proceed to pay
        - `awaiting_payment`: waiting for the customer to send funds
        - `paid`: payment received and confirmed
        - `underpaid`: customer paid less than the requested amount
        - `expired`: not paid before the deadline
        - `failed`: payment or processing failed
        - `refunded`: payment was returned to the customer
        - `cancelled`: invoice was cancelled before completion
      enum:
        - pending
        - quoted
        - awaiting_payment
        - paid
        - underpaid
        - expired
        - failed
        - refunded
        - cancelled
    PublicApiError:
      type: object
      description: Standard error envelope for Public API v1 endpoints.
      required:
        - error
      properties:
        error:
          type: object
          description: Error details for the failed request.
          required:
            - type
            - code
            - message
            - request_id
          properties:
            type:
              type: string
              description: High-level error category used for programmatic handling.
              enum:
                - invalid_request
                - authentication_error
                - permission_error
                - not_found
                - conflict
                - rate_limit_error
                - api_error
              example: not_found
            code:
              type: string
              description: >-
                Stable machine-readable error code (for example
                `invoice_not_found`).
              example: invoice_not_found
            message:
              type: string
              description: Human-readable explanation suitable to show in logs or UI.
              example: Invoice not found
            param:
              type: string
              description: Request field associated with the error, when applicable.
              example: url
            request_id:
              type: string
              description: Unique request ID. Include when contacting support.
              example: req_a1b2c3d4e5f6789012345678
      example:
        error:
          type: not_found
          code: invoice_not_found
          message: Invoice not found
          request_id: req_a1b2c3d4e5f6789012345678
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Store-scoped API key. Prefix with `sk_live_`.
        Example: `Authorization: Bearer sk_live_EXAMPLE_DO_NOT_USE`

````