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

# List a customer's payments

> Every payment attempt (PENDING, COMPLETED, FAILED), newest first. Pass nextCursor as cursor for the next page.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v3/partners/{shortName}/customers/{externalUserId}/payments
openapi: 3.0.0
info:
  title: Ndovu Partner API
  description: API for partners distributing Ndovu investment products to their customers.
  version: '3'
  contact: {}
servers:
  - url: https://be-dev-1.dev.ndovu.co
    description: Development
security: []
tags: []
paths:
  /api/v3/partners/{shortName}/customers/{externalUserId}/payments:
    get:
      tags:
        - partners
      summary: List a customer's payments
      description: >-
        Every payment attempt (PENDING, COMPLETED, FAILED), newest first. Pass
        nextCursor as cursor for the next page.
      operationId: PartnerMoneyController_listPayments_v3
      parameters:
        - name: shortName
          required: true
          in: path
          description: Your partner short name
          schema:
            type: string
        - name: externalUserId
          required: true
          in: path
          description: Your own ID for the customer
          schema:
            type: string
        - name: cursor
          required: false
          in: query
          description: The previous page's nextCursor
          schema:
            minimum: 1
            type: number
        - name: limit
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 50
            default: 20
            type: number
        - name: planId
          required: false
          in: query
          description: Only this plan
          schema:
            type: number
        - name: status
          required: false
          in: query
          schema:
            enum:
              - PENDING
              - COMPLETED
              - FAILED
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerPaymentPageDto'
      security:
        - bearer: []
components:
  schemas:
    PartnerPaymentPageDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PartnerPaymentDto'
        nextCursor:
          type: number
          nullable: true
          description: Pass as cursor for the next page; null on the last page
      required:
        - data
    PartnerPaymentDto:
      type: object
      properties:
        reference:
          type: string
          example: NDV7F3K9Q
          description: >-
            The PaymentReference. For a bank transfer, quote it as the transfer
            memo
        channel:
          type: string
          enum:
            - MPESA
            - BANK_TRANSFER
        amount:
          type: number
          example: 5000
        finalAmount:
          type: number
          example: 5000
          description: The amount to pay
        currency:
          type: string
          example: KES
        status:
          enum:
            - PENDING
            - COMPLETED
            - FAILED
          type: string
        mnoReference:
          type: string
          nullable: true
          description: The M-Pesa receipt
        bankReference:
          type: string
          nullable: true
          description: The bank's own transaction id, once reconciled
        phoneNumber:
          type: string
          nullable: true
          example: +2547...5678
          description: The paying number, redacted (M-Pesa)
        plan:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/PartnerPlanRefDto'
        transactionId:
          type: number
          nullable: true
          description: >-
            The Transaction this Payment funds. Null until the Payment is
            COMPLETED, when the Transaction is created
        createdAt:
          format: date-time
          type: string
        completedAt:
          format: date-time
          type: string
          nullable: true
      required:
        - reference
        - channel
        - amount
        - finalAmount
        - currency
        - status
        - createdAt
    PartnerPlanRefDto:
      type: object
      properties:
        id:
          type: number
          example: 12
        name:
          type: string
          example: Ndovu Money Market Fund
      required:
        - id
        - name
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````

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