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

# Get Payment

> Retrieve the full details of a specific payment using its ID.



## OpenAPI

````yaml get /v1/payments/{id}
openapi: 3.0.3
info:
  title: Monime API
  description: Monime REST API. Please visit https://docs.momime.io/api for more details.
  termsOfService: https://monime.io/legal/terms-of-service
  contact:
    name: Monime Developers
    url: https://github.com/monimesl
    email: dev@monime.io
  version: v1
servers:
  - url: https://api.monime.io/
security:
  - bearerAuth: []
paths:
  /v1/payments/{id}:
    get:
      tags:
        - Payment
      summary: Get Payment
      description: Retrieve the full details of a specific payment using its ID.
      operationId: GetPayment
      parameters:
        - name: id
          in: path
          description: ID of the payment object to retrieve.
          required: true
          schema:
            type: string
            description: ID of the payment object to retrieve.
        - name: Monime-Version
          in: header
          description: Specifies which version of the Monime API will handle this request.
          schema:
            enum:
              - caph.2025-08-23
              - caph.2025-06-20
            type: string
            description: >-
              Specifies which version of the Monime API will handle this
              request.
            nullable: true
        - name: Monime-Space-Id
          in: header
          description: >-
            The value is the tenancy parameter that Monime uses to determine
            which space the request is intended for.
          required: true
          schema:
            maxLength: 64
            pattern: ^spc-.*$
            type: string
            description: >-
              The value is the tenancy parameter that Monime uses to determine
              which space the request is intended for.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: >-
                      Represents the status of the query operation, confirming
                      if it was successful. This field is always true
                  messages:
                    type: array
                    items: {}
                    description: >-
                      Contains a list of messages providing relevant information
                      or feedback related to the query or operation
                  result:
                    $ref: '#/components/schemas/Payment'
components:
  schemas:
    Payment:
      title: Payment
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the payment object.
        status:
          enum:
            - pending
            - processing
            - completed
          type: string
          description: |-
            Current status of the payment. Can be one of:
            - pending: Created but not yet processed.
            - processing: Payment is currently being processed.
            - completed: Payment was successfully completed.
        amount:
          type: object
          properties:
            currency:
              type: string
              description: >-
                The [3-letter](https://en.wikipedia.org/wiki/ISO_4217) ISO
                currency code. Currently supported: 'SLE'
            value:
              type: integer
              description: >-
                The value representation in the currency's minor unit. E.g. For
                1 Leone (SLE 1), the value should be 100, denoting cents, the
                minor unit.
          additionalProperties: false
          description: Total payment amount requested from the payer.
        channel:
          type: object
          oneOf:
            - title: Bank
              type: object
              properties:
                type:
                  enum:
                    - bank
                  type: string
                  description: >-
                    **Type** of channel. This is always set to 'bank' for Bank
                    payments.
                provider:
                  type: string
                  description: >-
                    **Provider code** for the bank or financial institution
                    facilitating the payment.
                reference:
                  maxLength: 64
                  type: string
                  description: >-
                    **Bank transaction reference** assigned by the provider when
                    the payment was made. Often used for reconciliation and
                    tracing within the bank’s system.
                accountNumber:
                  type: string
                  description: >-
                    **Bank account number** used to initiate the payment. This
                    is usually masked to protect user privacy.
                fingerprint:
                  type: string
                  description: >-
                    **Hashed account number**. A hashed identifier derived from
                    the account number. Enables repeat usage recognition, fraud
                    analysis, and loyalty program tracking — without exposing
                    raw account number.
                metadata:
                  maxProperties: 64
                  type: object
                  additionalProperties:
                    maxLength: 100
                    type: string
                    description: >-
                      Metadata values are free-form strings up to 100
                      characters.
                  description: >-
                    **Optional metadata** for attaching contextual information
                    relevant for audits, reconciliation, or internal processing.
                  nullable: true
            - title: Card
              type: object
              properties:
                type:
                  enum:
                    - card
                  type: string
                  description: >-
                    **Type** of channel. This is always set to 'card' for
                    card-based payments.
                scheme:
                  enum:
                    - mastercard
                    - visa
                  type: string
                  description: '**Card scheme** such as ''visa'' or ''mastercard''.'
                last4:
                  maxLength: 4
                  type: string
                  description: >-
                    **Last four digits** of the card number used. Helpful for
                    user recognition and support.
                fingerprint:
                  type: string
                  description: >-
                    **Card fingerprint**. A hashed identifier derived from the
                    card number. Enables repeat usage recognition, fraud
                    analysis, and loyalty program tracking — without exposing
                    the card number.
                metadata:
                  maxProperties: 64
                  type: object
                  additionalProperties:
                    maxLength: 100
                    type: string
                    description: >-
                      Metadata values are free-form strings up to 100
                      characters.
                  description: >-
                    **Optional metadata** for attaching contextual information
                    useful for audit trails or internal reconciliation.
                  nullable: true
            - title: Digital Wallet
              type: object
              properties:
                type:
                  enum:
                    - wallet
                  type: string
                  description: >-
                    **Type** of channel. This is always set to 'wallet' for
                    digital wallet payments.
                provider:
                  type: string
                  description: '**Wallet provider** code or identifier.'
                reference:
                  maxLength: 64
                  type: string
                  description: >-
                    **Wallet transaction reference** assigned when the payment
                    was executed. Often used for reconciliation and user
                    support.
                walletId:
                  type: string
                  description: >-
                    **Wallet identifier** representing the source wallet
                    involved in the transaction. Usually masked or obfuscated.
                fingerprint:
                  type: string
                  description: >-
                    **Hashed wallet identifier**. Enables secure correlation,
                    repeat-usage detection, and loyalty programs — while
                    preserving privacy.
                metadata:
                  maxProperties: 64
                  type: object
                  additionalProperties:
                    maxLength: 100
                    type: string
                    description: >-
                      Metadata values are free-form strings up to 100
                      characters.
                  description: >-
                    **Optional metadata** for attaching contextual or
                    audit-related details about the wallet transaction.
                  nullable: true
            - title: Mobile Money
              type: object
              properties:
                type:
                  enum:
                    - momo
                  type: string
                  description: >-
                    **Type** of channel. This is always set to 'momo' for Mobile
                    Money payments.
                provider:
                  type: string
                  description: >-
                    **Provider code** for the Mobile Money operator (e.g., 'm17'
                    for Orange Money) that is facilitating the payment.
                reference:
                  maxLength: 64
                  type: string
                  description: >-
                    **Network transaction reference** assigned by the Mobile
                    Money operator when the payment was made. This is often
                    visible to the payer and useful for tracing the transaction
                    in the provider’s system.
                phoneNumber:
                  type: string
                  description: >-
                    **Phone number (MSISDN)** of the Mobile Money wallet that
                    initiated the payment. This is usually masked for privacy
                    and security.
                fingerprint:
                  type: string
                  description: >-
                    **Hashed phone number**. A hashed identifier derived from
                    the phone number. Enables repeat usage recognition, fraud
                    analysis, and loyalty program tracking — without exposing
                    the raw phone number.
                metadata:
                  maxProperties: 64
                  type: object
                  additionalProperties:
                    maxLength: 100
                    type: string
                    description: >-
                      Metadata values are free-form strings up to 100
                      characters.
                  description: >-
                    **Optional metadata** for attaching extra contextual
                    information useful for audit logs, reconciliation, or
                    internal tracking.
                  nullable: true
          properties:
            type:
              enum:
                - bank
                - card
                - momo
                - wallet
              type: string
              description: >-
                **Type** of payment channel used to process the payment.
                Supported values:

                - bank: Bank account payments

                - card: Debit or credit card payments

                - momo: Mobile money payments

                - wallet: Digital wallet payments.
          description: >-
            Payment channel details (e.g., Mobile Money, Bank, Card) used to
            complete this payment.
        name:
          type: string
          description: >-
            Optional label for identifying or grouping the payment. Useful in
            dashboards or reporting tools.
          nullable: true
        reference:
          type: string
          description: >-
            External reference to associate this payment with a system outside
            Monime (e.g., an order ID or invoice number).
          nullable: true
        orderNumber:
          type: string
          description: >-
            Monime Order Number — internal order identifier associated with this
            payment. Used to track payments initiated from an embedded commerce
            or checkout session.
          nullable: true
        financialAccountId:
          type: string
          description: >-
            ID of the destination financial account where the funds will be
            credited after a successful payment.
          nullable: true
        financialTransactionReference:
          type: string
          description: >-
            Reference to the resulting financial transaction(s), if the payment
            was successful.
          nullable: true
        fees:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                description: The type of fee applied.
              amount:
                type: object
                properties:
                  currency:
                    type: string
                    description: >-
                      The [3-letter](https://en.wikipedia.org/wiki/ISO_4217) ISO
                      currency code. Currently supported: 'SLE'
                  value:
                    type: integer
                    description: >-
                      The value representation in the currency's minor unit.
                      E.g. For 1 Leone (SLE 1), the value should be 100,
                      denoting cents, the minor unit.
                additionalProperties: false
                description: The amount of the fee that was applied for the payment.
              metadata:
                maxProperties: 64
                type: object
                additionalProperties:
                  maxLength: 100
                  type: string
                  description: Metadata values are free-form strings up to 100 characters.
                description: Further metadata describing the fee.
                nullable: true
          description: >-
            List of applied fees associated with this payment, such as platform
            or processing fees.
          nullable: true
        createTime:
          type: string
          description: Timestamp indicating when the payment was created.
          format: date-time
        updateTime:
          type: string
          description: Timestamp indicating when the payment was last updated.
          format: date-time
          nullable: true
        ownershipGraph:
          title: OwnershipGraph
          type: object
          properties:
            owner:
              title: OwnershipObject
              type: object
              properties:
                id:
                  type: string
                  description: '**Unique ID** of the object instance that owns this entity.'
                  readOnly: true
                type:
                  type: string
                  description: >-
                    **Type of the object** that owns this entity. Examples
                    include: 'internal_transfer', 'checkout_session',
                    'payment_code'.
                  readOnly: true
                metadata:
                  maxProperties: 64
                  type: object
                  additionalProperties:
                    maxLength: 100
                    type: string
                    description: >-
                      Metadata values are free-form strings up to 100
                      characters.
                  description: '**Arbitrary metadata** describing the owning object.'
                  nullable: true
                  readOnly: true
                owner:
                  $ref: '#/components/schemas/CoreresourcesParentOwningObject'
              additionalProperties: false
              description: >-
                **Immediate object** that owns this entity. This is the direct
                originator or source object.
              readOnly: true
          additionalProperties: false
          description: >-
            Ownership chain showing how this payment was initiated — enabling
            full audit traceability.
          nullable: true
        metadata:
          maxProperties: 64
          type: object
          additionalProperties:
            maxLength: 100
            type: string
            description: Metadata values are free-form strings up to 100 characters.
          description: Custom metadata attached to the payment
          nullable: true
      description: >-
        A **Payment** represents a customer payment made through Monime’s
        platform.  

        It captures high-level information about the user-initiated payment,
        including the **amount**, **status**, **channel** (e.g., **Mobile
        Money**, **Card**, **Bank**), associated **order**, **fees applied**,
        and links to **downstream financial transactions**.  


        The **Payment** is a business object — the single record developers and
        merchants interact with when tracking or reconciling user payments.  

        It should not be confused with **Financial Transactions**, which are
        lower-level, fine-grained ledger entries.  

        In fact, **one Payment usually generates multiple Financial
        Transactions** — for example:  

        - A **credit** of the received funds into the merchant’s account.  

        - One or more **debits** representing platform charges or processing
        fees.
    CoreresourcesParentOwningObject:
      title: OwnershipObject
      type: object
      properties:
        id:
          type: string
          description: '**Unique ID** of the object instance that owns this entity.'
          readOnly: true
        type:
          type: string
          description: >-
            **Type of the object** that owns this entity. Examples include:
            'internal_transfer', 'checkout_session', 'payment_code'.
          readOnly: true
        metadata:
          maxProperties: 64
          type: object
          additionalProperties:
            maxLength: 100
            type: string
            description: Metadata values are free-form strings up to 100 characters.
          description: '**Arbitrary metadata** describing the owning object.'
          nullable: true
          readOnly: true
        owner:
          $ref: '#/components/schemas/CoreresourcesParentOwningObject'
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: auth-scheme
      description: >-
        Bearer HTTP authentication specified with the header Authorization:
        Bearer <access_token>

````