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

# Find a portal payment by its id

> Returns a portal payment and its per-invoice breakdown (which invoice was paid for which amount). Note: `status` reflects the payment gateway outcome, not the final accounting settlement — a `succeeded` portal payment may still be reconciled onto another invoice or expire, so the allocations describe what was requested at payment time.



## OpenAPI

````yaml https://public.leanpay.fr/openapi/leanpay_api_documentation.swagger.yaml get /portal-payments/{portalPaymentId}
openapi: 3.1.1
info:
  version: 1.0.0
  title: LeanPay Api documentation
  contact:
    email: integration@leanpay.fr
servers:
  - url: https://api.leanpay.fr/v1/public
security: []
tags:
  - name: clients
    description: Routes related to clients
  - name: invoices
    description: Routes related to invoices
  - name: credit-notes
    description: Routes related to credit notes
  - name: misc-operations
    description: Routes related to misc operations
  - name: contacts
    description: Routes related to client contacts
  - name: addresses
    description: Routes related to client addresses
  - name: payments
    description: Routes related to invoice payments
  - name: portal-payments
    description: >-
      Routes related to portal payments (online payments made by debtors from
      the customer portal)
  - name: paybacks
    description: Routes related to credit note paybacks
  - name: links
    description: Routes related to invoice/credit note links
  - name: comments
    description: Routes related to comments
  - name: deleted-elements
    description: Routes related to deleted elements
  - name: client-properties
    description: Routes related to client properties
paths:
  /portal-payments/{portalPaymentId}:
    get:
      tags:
        - portal-payments
      summary: Find a portal payment by its id
      description: >-
        Returns a portal payment and its per-invoice breakdown (which invoice
        was paid for which amount). Note: `status` reflects the payment gateway
        outcome, not the final accounting settlement — a `succeeded` portal
        payment may still be reconciled onto another invoice or expire, so the
        allocations describe what was requested at payment time.
      parameters:
        - name: portalPaymentId
          in: path
          description: Id of the portal payment
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Found portal payment
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortalPaymentGetResponse'
        '400':
          description: Invalid portal payment id
        '404':
          description: Portal payment not found
      security:
        - authorization: []
components:
  schemas:
    PortalPaymentGetResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        uniqueId:
          type: string
          description: Human-readable transfer reference (e.g. "LP1A2B3C")
        status:
          type: string
          enum:
            - initiated
            - succeeded
            - failed
            - canceled
          description: >-
            Payment gateway status. Does not guarantee accounting settlement of
            the listed invoices.
        paymentMethod:
          type: string
          enum:
            - stripe
            - fintecture
        amount:
          type: integer
          description: Total amount in cents, equals the sum of the allocation amounts.
        currency:
          type: string
        clientId:
          type: string
          format: uuid
        allocations:
          type: array
          description: Per-target breakdown of the paid amount.
          items:
            type: object
            properties:
              target:
                type: object
                properties:
                  type:
                    type: string
                    enum:
                      - invoice
                  id:
                    type: string
                    format: uuid
              amount:
                type: integer
                description: Amount allocated to this target, in cents.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
  securitySchemes:
    authorization:
      type: apiKey
      name: Authorization
      in: header

````