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

# List payments

> Retrieve a list of payments with optional filters

# List Payments

Retrieving a list of all payments provides an overview of all transactions made through your Adullam account. Use the List Payments API to access a comprehensive list of payments, allowing you to monitor and manage your financial activities.


## OpenAPI

````yaml get /v1/payments
openapi: 3.0.3
info:
  title: Adullam Payment API
  version: 1.0.0
  description: >
    Adullam is a payment processing platform for mobile money transactions in
    West Africa.


    This API enables developers to:

    - Collect payments from customers via mobile money

    - Send money to recipients

    - Track transactions and account balance


    ## Authentication

    All endpoints (except auth endpoints) require Bearer token authentication.


    ## Base URL

    Production: `https://api.adullam.dev`


    ## Rate Limiting

    - 100 requests per minute

    - 1000 requests per hour
  contact:
    email: support@adullam.dev
    url: https://docs.adullam.dev
  license:
    name: Proprietary
    url: https://adullam.dev/terms
servers:
  - url: https://api.adullam.dev
    description: Production server
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Partner authentication and token management
  - name: Payments
    description: Collect money from customers via mobile money
  - name: Transfers
    description: Send money to recipients via mobile money
  - name: Account
    description: Account and balance management
paths:
  /v1/payments:
    get:
      tags:
        - Payments
      summary: List payments
      description: Retrieve a list of payments with optional filters
      parameters:
        - name: status
          in: query
          schema:
            type: string
            enum:
              - created
              - pending
              - processing
              - completed
              - failed
              - expired
              - cancelled
          description: Filter by payment status
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          description: Number of results to return
        - name: cursor
          in: query
          schema:
            type: string
          description: Cursor for pagination
        - name: customer_phone
          in: query
          schema:
            type: string
          description: Filter by customer phone number
        - name: channel
          in: query
          schema:
            type: string
            enum:
              - orangeCI
              - mtnCI
              - moovCI
              - waveCI
          description: Filter by payment channel
        - name: amount_min
          in: query
          schema:
            type: integer
          description: Minimum amount filter (in XOF)
        - name: amount_max
          in: query
          schema:
            type: integer
          description: Maximum amount filter (in XOF)
        - name: created_after
          in: query
          schema:
            type: string
            format: date-time
          description: Filter payments created after this date
        - name: created_before
          in: query
          schema:
            type: string
            format: date-time
          description: Filter payments created before this date
      responses:
        '200':
          description: List of payments
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentList'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    PaymentList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Payment'
        has_more:
          type: boolean
          example: true
        next_cursor:
          type: string
          nullable: true
          example: def456
    Payment:
      type: object
      properties:
        id:
          type: string
          example: pay_abc123
        status:
          type: string
          enum:
            - created
            - pending
            - processing
            - completed
            - failed
            - expired
            - cancelled
          example: pending
        amount:
          type: integer
          example: 5000
        currency:
          type: string
          example: XOF
        customer_phone:
          type: string
          example: '+22507987654'
        customer_name:
          type: string
          nullable: true
          description: Name retrieved from mobile money operator
          example: KONE ADAMA
        channel:
          type: string
          enum:
            - orangeCI
            - mtnCI
            - moovCI
            - waveCI
          example: orangeCI
        description:
          type: string
          example: 'Order #12345'
        reference:
          type: string
          description: Internal reference
          example: REF_ABC123
        ussd_reference:
          type: string
          nullable: true
          description: Mobile money operator reference
          example: MP240115.1030.A12345
        fees:
          type: integer
          example: 25
        net_amount:
          type: integer
          description: Amount minus fees
          example: 4975
        metadata:
          type: object
          additionalProperties:
            type: string
          example:
            order_id: '12345'
        created_at:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00Z'
        completed_at:
          type: string
          format: date-time
          nullable: true
          example: '2024-01-15T10:32:00Z'
        failure_reason:
          type: string
          nullable: true
          example: null
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - authentication_error
                - invalid_request
                - insufficient_funds
                - rate_limit_exceeded
                - channel_error
                - transaction_failed
                - server_error
              example: invalid_request
            code:
              type: string
              example: amount_too_low
            message:
              type: string
              example: Amount must be at least 100 XOF
            field:
              type: string
              nullable: true
              example: amount
            request_id:
              type: string
              example: req_abc123
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: authentication_error
              code: invalid_token
              message: Invalid or expired access token
              request_id: req_abc123
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use the access token obtained from /v1/auth/token

````