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

# View a transaction

> Read the details and current status of one transaction.

**Required scope:** `transactions:read`

Use this endpoint to check an individual deposit, conversion or payment in your business's history.


## OpenAPI

````yaml /openapi/public.yaml get /v1/transactions/{id}
openapi: 3.1.0
info:
  title: Ledig payments API
  version: 0.1.0
  description: >-
    Use the Ledig payments engine to receive funds, view balances, convert
    currencies and send payments.


    Choose Sandbox to test your integration or Live for production payments.
    Each endpoint explains the fields, permissions and errors you need to
    handle.


    Sign API requests with your business API key and HMAC-SHA256. Endpoints
    listing BearerAuth also accept a user access token. Follow
    https://docs.ledig.io/auth/authentication to sign your requests.
  contact:
    name: Ledig
    email: support@ledig.io
    url: https://docs.ledig.io
servers:
  - url: https://api-sandbox.ledig.io
    description: Sandbox
  - url: https://api.ledig.io
    description: Live
security:
  - LedigApiKey: []
    LedigTimestamp: []
    LedigSignature: []
tags:
  - name: Managed businesses
    description: Onboarding for businesses you manage.
  - name: System
    description: Health and availability.
  - name: Balances
    description: Your available and reserved funds by currency.
  - name: Currencies and rates
    description: Supported currencies, networks and indicative rates.
  - name: Funding accounts
    description: Fiat accounts that receive customer deposits.
  - name: Deposit wallets
    description: Crypto addresses that receive customer deposits.
  - name: Recipients
    description: Saved payout destinations.
  - name: Ledig businesses
    description: Find a business before paying through the Ledig network.
  - name: Payment options
    description: Available payout methods, fees and limits.
  - name: Quotes
    description: Confirm rates, fees and amounts before sending.
  - name: Transfers
    description: Start and track conversions and payments.
  - name: Transactions
    description: Customer transaction history.
paths:
  /v1/transactions/{id}:
    parameters:
      - $ref: '#/components/parameters/ResourceId'
    get:
      tags:
        - Transactions
      summary: View a transaction
      description: Read the details and current status of one transaction.
      operationId: getTransaction
      responses:
        '200':
          description: Transaction.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Success'
                  - type: object
                    required:
                      - data
                    properties:
                      data:
                        $ref: '#/components/schemas/ClientTransaction'
              example:
                status: success
                data:
                  id: transaction_example_001
                  profileId: profile_example_001
                  currency: USD
                  amount: '250.00'
                  category: deposit
                  reference: deposit-example-001
                  description: USD deposit
                  subDescription: Bank transfer
                  status: completed
                  statusDescription: Completed
                  type: fiat
                  createdAt: '2026-01-15T10:00:00.000Z'
                  displayStatus: completed
                  displayStatusDescription: Completed
                  data:
                    grossAmount: '250.00'
                    netAmount: '250.00'
                    feeAmount: '0.00'
                    feeCurrency: USD
                  isCredit: true
                  isFiat: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: >-
            import { createHmac } from "node:crypto";


            // Node.js 18+. Set credentials and resource values on your server.

            function required(name) {
              const value = process.env[name];
              if (!value) throw new Error(`Set ${name} before running this example.`);
              return value;
            }


            const baseUrl = process.env.LEDIG_API_BASE_URL ??
            "https://api-sandbox.ledig.io";

            const method = "GET";

            const id = required("LEDIG_TRANSACTION_ID");

            const path = `/v1/transactions/${encodeURIComponent(id)}`;

            const pathWithQuery = path;

            const rawBody = "";

            const headers = { "Accept": "application/json" };

            const timestamp = Math.floor(Date.now() / 1000).toString();

            const payload =
            `${timestamp}.${method}.${pathWithQuery}.${rawBody}`;

            headers["x-ledig-key"] = required("LEDIG_API_KEY");

            headers["x-ledig-timestamp"] = timestamp;

            headers["x-ledig-signature"] = "v1=" + createHmac("sha256",
            required("LEDIG_API_SECRET"))
              .update(payload).digest("base64");

            const response = await fetch(`${baseUrl}${pathWithQuery}`, {
              method,
              headers,
            });

            const result = await response.json();

            // Use result in your application; do not log credentials or upload
            links.

            console.log(response.status);
components:
  parameters:
    ResourceId:
      in: path
      name: id
      required: true
      schema:
        type: string
      example: resource_example_001
  schemas:
    Success:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          const: success
        message:
          type: string
    ClientTransaction:
      type: object
      additionalProperties: false
      description: >-
        A deposit, conversion or payment in your history. status describes its
        financial state; displayStatus also reflects current restrictions. A
        received deposit may still be held and unavailable to spend.
      required:
        - id
        - profileId
        - currency
        - amount
        - category
        - reference
        - description
        - subDescription
        - status
        - statusDescription
        - type
        - createdAt
        - data
        - isCredit
        - isFiat
      properties:
        id:
          type: string
        profileId:
          type: string
        currency:
          type: string
        amount:
          type: string
        category:
          type: string
        reference:
          type: string
        description:
          type: string
        subDescription:
          type: string
        status:
          type: string
        statusDescription:
          type: string
        type:
          type: string
        createdAt:
          type: string
        displayStatus:
          type: string
        displayStatusDescription:
          type: string
        transactionHash:
          type:
            - string
            - 'null'
        network:
          type:
            - string
            - 'null'
        data:
          $ref: '#/components/schemas/ClientTransactionData'
        isCredit:
          type: boolean
        isFiat:
          type: boolean
        balanceImpact:
          $ref: '#/components/schemas/ClientBalanceImpact'
    ClientTransactionData:
      type: object
      additionalProperties: false
      description: Details for a deposit, payout or other transaction in your history.
      properties:
        sourceType:
          type: string
        source_type:
          type: string
        sourceId:
          type: string
        recordKind:
          type: string
        id:
          type: string
        status:
          type: string
        rate:
          type: string
        sourceAmount:
          type: string
        sourceDebitAmount:
          type: string
        grossAmount:
          type: string
        netAmount:
          type: string
        fee:
          type: string
        feeAmount:
          type: string
        feeCurrency:
          type: string
        fromCurrency:
          type: string
        toCurrency:
          type: string
        destinationAmount:
          type: string
        pair:
          type: string
        baseCurrency:
          type: string
        quoteCurrency:
          type: string
        direction:
          type: string
        selectedSide:
          type: string
        bid:
          type: string
        ask:
          type: string
        agreedRate:
          type: string
        rateConvention:
          type: string
        calculatedDestinationAmount:
          type: string
        tradeDate:
          type: string
        completedAt:
          type: string
        receiptUrl:
          type: string
        affectsBalance:
          type: boolean
        settlement:
          type: object
          additionalProperties: false
          properties:
            method:
              type: string
            reference:
              type: string
            transactionHash:
              type: string
            network:
              type: string
            evidenceIds:
              type: array
              items:
                type: string
              description: >-
                References for settlement documents available for you to
                download.
    ClientBalanceImpact:
      type: object
      additionalProperties: false
      description: >-
        How the transfer affected your balance, shown separately from its
        processing status.
      required:
        - state
        - lines
      properties:
        state:
          type: string
          enum:
            - not_started
            - on_hold
            - deducted
            - hold_released
            - returned
            - still_checking
            - return_pending
            - finishing_completion
        lines:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - code
              - currency
              - amount
              - state
            properties:
              code:
                type: string
                enum:
                  - principal
                  - transfer_fee
                  - conversion_fee
                  - converted_principal
              currency:
                type: string
              amount:
                type: string
              state:
                type: string
                enum:
                  - no_effect
                  - reserved
                  - settled
                  - released
                  - returned
                  - late_settled
                  - pending_finalization
                  - pending_return
                  - unknown
    Error:
      type: object
      required:
        - status
        - message
        - code
      properties:
        status:
          type: string
          const: error
        message:
          type: string
        code:
          type: string
        details:
          description: >-
            Additional information to help resolve an error, such as a file
            problem, allowed amount range or remaining payment allowance. The
            fields depend on the error code.
          oneOf:
            - type: object
              additionalProperties: false
              description: >-
                File-validation details returned with HTTP 400, 413 or 422
                BAD_REQUEST.
              required:
                - validationCode
                - reasonCode
                - retryable
              properties:
                validationCode:
                  type: string
                  enum:
                    - document_unreadable
                    - document_type_mismatch
                    - document_password_protected
                    - document_limits_exceeded
                reasonCode:
                  type: string
                  enum:
                    - document_unreadable
                    - document_type_mismatch
                    - document_password_protected
                    - document_limits_exceeded
                retryable:
                  type: boolean
                  const: false
                documentId:
                  type: string
                  maxLength: 128
                requirementType:
                  type: string
                maxSizeBytes:
                  type: integer
                  minimum: 1
                  maximum: 1073741824
                  description: >-
                    Maximum accepted file size in bytes, when supplied with HTTP
                    413.
            - type: object
              additionalProperties: false
              required:
                - reason
              properties:
                reason:
                  type: string
                  enum:
                    - current_password_incorrect
                    - unsupported_asset_network
                    - recipient_unavailable
                    - recipient_incompatible
                    - payout_method_unavailable
                    - payout_method_incompatible
                    - network_unavailable
                    - quote_expired
                    - quote_already_used
                    - quote_changed
                    - invoice_required
                    - invoice_invalid
                    - amount_invalid
                    - amount_precision_invalid
                    - onboarding_revision_required
                    - onboarding_revision_changed
                    - onboarding_document_kind_mismatch
                precision:
                  type: integer
                  minimum: 0
                  maximum: 18
                  description: >-
                    Allowed number of decimal places when reason is
                    amount_precision_invalid.
            - type: object
              additionalProperties: false
              required:
                - period
                - sourceCurrency
                - requested
                - remaining
                - limit
                - resetsAt
                - timezone
              properties:
                period:
                  type: string
                  enum:
                    - daily
                    - monthly
                sourceCurrency:
                  type: string
                  pattern: ^[A-Z][A-Z0-9]{1,19}$
                requested:
                  type: string
                  pattern: ^(0|[1-9][0-9]*)(\.[0-9]+)?$
                remaining:
                  type: string
                  pattern: ^(0|[1-9][0-9]*)(\.[0-9]+)?$
                limit:
                  type: string
                  pattern: ^(0|[1-9][0-9]*)(\.[0-9]+)?$
                resetsAt:
                  type: string
                  format: date-time
                timezone:
                  type: string
                  const: UTC
            - type: object
              additionalProperties: false
              required:
                - sourceCurrency
                - minimumAmount
                - maximumAmount
              properties:
                sourceCurrency:
                  type: string
                minimumAmount:
                  type: string
                maximumAmount:
                  type: string
              description: >-
                Returned with HTTP 422 RATE_ROUTE_AMOUNT_OUT_OF_RANGE. These
                limits apply to the amount being converted, in the source
                currency.
            - type: object
              additionalProperties: false
              required:
                - currency
                - requestedUsd
                - limitUsd
              properties:
                currency:
                  type: string
                  const: USD
                requestedUsd:
                  type: string
                limitUsd:
                  type: string
              description: >-
                Returned with HTTP 422 PAYOUT_TRANSACTION_LIMIT_EXCEEDED. This
                per-payment limit uses USD equivalent and is separate from the
                payout method's currency limits.
            - type: object
              additionalProperties: false
              required:
                - currency
                - requestedUsd
                - remainingUsd
                - resetsAt
                - timezone
              properties:
                currency:
                  type: string
                  const: USD
                requestedUsd:
                  type: string
                remainingUsd:
                  type: string
                resetsAt:
                  type: string
                  format: date-time
                timezone:
                  type: string
                  const: UTC
              description: >-
                Returned with HTTP 422 PAYOUT_MONTHLY_LIMIT_EXCEEDED. Shows your
                business's remaining monthly allowance and when it resets.
  responses:
    Unauthorized:
      description: >-
        Authentication is missing, invalid or expired. Check your credentials
        and request signature.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: UNAUTHORIZED
            message: Authentication is required.
    Forbidden:
      description: >-
        Your account is inactive, the business selection is missing, or your
        credentials do not have the required permission.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: FORBIDDEN
            message: You do not have permission to perform this action.
    NotFound:
      description: The requested resource could not be found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: NOT_FOUND
            message: The requested resource was not found.
    RateLimited:
      description: >-
        A request or operation allowance has been reached. Wait before retrying.
        If the endpoint uses an idempotency key, keep the same key for the
        retry.
      headers:
        Retry-After:
          description: The number of seconds to wait before retrying.
          schema:
            type: integer
            minimum: 1
        Cache-Control:
          description: >-
            Responses use private, no-store or no-store. Do not cache this
            response.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: error
            code: RATE_LIMITED
            message: Too many requests. Wait before trying again.
  securitySchemes:
    LedigApiKey:
      type: apiKey
      in: header
      name: x-ledig-key
      description: >-
        Your business API key ID. Keep its secret on your server and use that
        secret to sign each request.
    LedigTimestamp:
      type: apiKey
      in: header
      name: x-ledig-timestamp
      description: The current Unix timestamp in seconds, used in the signed request.
    LedigSignature:
      type: apiKey
      in: header
      name: x-ledig-signature
      description: >-
        The request's HMAC-SHA256 signature. Use the v1= prefix for supported
        own-business requests, or v2= when acting for a managed business with
        signed business-selection headers. Follow the authentication guide to
        construct and sign the exact request.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.