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

# Get Payin

> Retrieves a specific payment by ID



## OpenAPI

````yaml GET /v1/payments/{paymentId}
openapi: 3.1.0
info:
  title: Payment Platform API
  version: 0.0.0
servers: []
security: []
tags:
  - name: Accounts
  - name: Payouts
  - name: Payments
paths:
  /v1/payments/{paymentId}:
    get:
      tags:
        - Payments
      summary: Get Payment
      description: Retrieves a specific payment by ID
      operationId: Payments_getPayment
      parameters:
        - $ref: '#/components/parameters/PaymentId'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  parameters:
    PaymentId:
      name: paymentId
      in: path
      required: true
      description: The unique identifier of the payment, prefixed with "pmt_"
      schema:
        type: string
  schemas:
    Payment:
      type: object
      required:
        - paymentId
        - object
        - amount
        - assetCode
        - method
        - status
        - metadata
        - createdAt
        - updatedAt
      properties:
        paymentId:
          type: string
          description: Unique identifier for the payment transaction, prefixed with "pmt_".
          readOnly: true
        object:
          type: string
          enum:
            - payment
          description: >-
            String representing the type of object, always "payment" for payment
            objects.
          readOnly: true
        amount:
          type: string
          description: >-
            The amount of the payment in asset subunits. Precision depends on
            the asset.
        assetCode:
          type: string
          description: >-
            The code identifying the asset or currency used for the payment
            (e.g., "USD", "BTC").
        method:
          allOf:
            - $ref: '#/components/schemas/PaymentMethod'
          description: The method used for executing the payment (e.g., CRYPTO, OTHER).
        status:
          allOf:
            - $ref: '#/components/schemas/PaymentStatus'
          description: >-
            The current status of the payment (e.g., COMPLETED, FAILED).

            This field is typically managed by the system based on transaction
            processing.
          readOnly: true
        provider:
          type: string
          description: >-
            Optional: The external payment provider used, if any (e.g.,
            "Stripe", "Coinbase").
        providerPaymentId:
          type: string
          description: >-
            Optional: The unique identifier for the payment transaction within
            the external provider's system.
        description:
          type: string
          description: 'Optional: A description or memo for the payment.'
        initiatedAt:
          type: string
          format: date-time
          description: >-
            Timestamp when the payment process was initiated. May be null if
            initiation tracking differs.
          readOnly: true
        processedAt:
          type: string
          format: date-time
          description: >-
            Timestamp when the payment processing by the provider or internal
            system began. May be null.
          readOnly: true
        completedAt:
          type: string
          format: date-time
          description: >-
            Timestamp when the payment reached a final state (COMPLETED or
            FAILED). May be null if not yet finalized.
          readOnly: true
        metadata:
          type: object
          unevaluatedProperties: {}
          description: >-
            A flexible object for storing additional custom key-value data
            related to the payment.

            Defaults to an empty object `{}` if not provided.
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the payment record was created in the system.
          readOnly: true
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the payment record was last updated.
          readOnly: true
      description: |-
        Represents a payment transaction within the system.
        Records the movement of funds between accounts or external parties.
      examples:
        - paymentId: pmt_abc123xyz
          object: payment
          amount: '15075'
          assetCode: USDC
          method: OTHER
          status: COMPLETED
          provider: Stripe
          providerPaymentId: pi_3JZ...
          description: Monthly subscription fee
          initiatedAt: '2025-04-28T10:00:00.000Z'
          processedAt: '2025-04-28T10:05:00.000Z'
          completedAt: '2025-04-28T10:05:30.123Z'
          metadata:
            orderId: ORD-9876
            customerId: cust_5432
          createdAt: '2025-04-28T09:59:50.500Z'
          updatedAt: '2025-04-28T10:05:30.123Z'
    ApiError:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
        target:
          type: string
      description: Standard error structure
    PaymentMethod:
      type: string
      enum:
        - CRYPTO
        - OTHER
      description: The method used to make the payment.
    PaymentStatus:
      type: string
      enum:
        - COMPLETED
        - FAILED
      description: Represents the final status of a payment transaction.

````