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

# Get All Charges

> Retrieve a paginated list of charges.
This endpoint returns all charge objects created under the merchant account, optionally filtered by date range, currency, status, payment method, or search text.
Use pagination parameters to navigate through results efficiently.

Key Notes:
- Supports flexible filtering and sorting via query parameters.
- Results include both succeeded and pending charges.
- Useful for reconciliation, reporting, and transaction monitoring dashboards.



## OpenAPI

````yaml api-reference/openapi.json get /v1/charges
openapi: 3.0.1
info:
  title: Monxa API
  description: ''
  version: 1.0.0
servers: []
security:
  - Bearer: []
tags:
  - name: balances
  - name: customers
  - name: merchants
  - name: charges
  - name: payouts
paths:
  /v1/charges:
    get:
      tags:
        - charges
      summary: Get All Charges
      description: >-
        Retrieve a paginated list of charges.

        This endpoint returns all charge objects created under the merchant
        account, optionally filtered by date range, currency, status, payment
        method, or search text.

        Use pagination parameters to navigate through results efficiently.


        Key Notes:

        - Supports flexible filtering and sorting via query parameters.

        - Results include both succeeded and pending charges.

        - Useful for reconciliation, reporting, and transaction monitoring
        dashboards.
      parameters:
        - name: Currency
          in: query
          description: Filter results by ISO-4217 currency code (e.g., SGD, MYR, THB).
          required: false
          example: IDR
          schema:
            type: string
        - name: DateFrom
          in: query
          description: >-
            Start date for filtering charges (inclusive). Example:
            2025-10-01T00:00:00Z.
          required: false
          schema:
            type: string
            format: date-time
        - name: DateTo
          in: query
          description: >-
            End date for filtering charges (inclusive). Example:
            2025-10-21T23:59:59Z.
          required: false
          example: 2025-10-21T23:59:59Z.
          schema:
            type: string
            format: date-time
        - name: Id
          in: query
          description: >-
            Retrieve a specific charge by its unique ID (e.g.,
            chg_01JAB1XYN01P3).
          required: false
          example: chg_01JAB1XYN01P3
          schema:
            type: string
            format: uuid
        - name: ChannelCode
          in: query
          description: Filter by payment channel (e.g., qr-qris, wallet_dana).
          required: false
          example: qr_qris
          schema:
            type: string
        - name: Status
          in: query
          description: >-
            Filter by charge status (pending, succeeded, failed, expired,
            cancelled).
          required: false
          example: pending
          schema:
            type: string
        - name: SearchText
          in: query
          description: >-
            Keyword search across charge fields such as code, reference_id, or
            description.
          required: false
          schema:
            type: string
        - name: OrderBy
          in: query
          description: Field to sort results by (e.g., created_on, amount, status).
          required: false
          example: status
          schema:
            type: string
        - name: IsDescending
          in: query
          description: When true, sorts results in descending order. Default is false.
          required: false
          example: 'false'
          schema:
            type: boolean
        - name: PageNumber
          in: query
          description: Page number for paginated results. Default is 1.
          required: false
          example: 1
          schema:
            type: integer
            format: int32
        - name: PageSize
          in: query
          description: Number of records per page. Maximum allowed is 100.
          required: false
          example: 100
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  page_number:
                    type: integer
                    description: Current page number of the paginated result set.
                  page_size:
                    type: integer
                    description: Number of records returned per page.
                  page_count:
                    type: integer
                    description: Total number of pages available.
                  total_item_count:
                    type: integer
                    description: >-
                      Total number of charge records that match the query
                      filters.
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Unique identifier for the charge object (e.g.,
                        code:
                          type: string
                          description: >-
                            Unique charge code generated by Monxa. (e.g.,
                            chg_01JAB1XYN01P3).
                        reference_id:
                          type: string
                          description: >-
                            Merchant’s reference identifier (e.g., invoice or
                            order number).
                        merchant_id:
                          type: string
                          description: >-
                            Unique identifier of the merchant who created the
                            charge.
                        amount:
                          type: integer
                          description: >-
                            Amount charged, expressed in minor units (e.g.,
                            10000 = 100.00).
                        currency:
                          type: string
                          description: ISO-4217 currency code (e.g., SGD, MYR, THB, IDR).
                        channel_code:
                          type: string
                          description: >-
                            Payment channel used for this charge (e.g.,
                            qr_qris,  wallet_dana).
                        status:
                          type: string
                          description: >-
                            Current status of the charge (pending, succeeded,
                            failed, expired, cancelled).
                        fee_amount:
                          type: integer
                          description: Total fee deducted for processing the charge.
                        net_amount:
                          type: integer
                          description: Net amount credited to the merchant after fees.
                        settlement_status:
                          type: string
                          description: Settlement progress (pending, settled, reversed).
                        description:
                          type: string
                          description: Optional description provided by the merchant.
                        metadata:
                          type: object
                          properties: {}
                          description: >-
                            Additional key–value pairs attached to the charge
                            for reconciliation or analytics.
                        created_by:
                          type: string
                          description: >-
                            Identifier of the user or API key that created the
                            charge.
                        created_on:
                          type: string
                          description: Timestamp when the charge was created.
                        updated_by:
                          type: string
                          description: >-
                            Identifier of the user or API key that last modified
                            the charge.
                        updated_on:
                          type: string
                          description: Timestamp of the last update to the charge.
                        failed_on:
                          type: string
                          description: Timestamp when the charge failed, if applicable.
                        settlement_on:
                          type: string
                          description: Timestamp when the chage is settled
                      required:
                        - fee_amount
                        - net_amount
                        - settlement_status
                        - amount
                        - channel_code
                        - code
                        - currency
                        - status
                        - created_by
                        - created_on
                        - id
                        - reference_id
                        - merchant_id
                        - description
                        - updated_by
                        - updated_on
                        - settlement_on
                    description: >-
                      List of charge objects. Each object represents one
                      transaction record.
                required:
                  - page_number
                  - page_size
                  - page_count
                  - total_item_count
                  - items
              example:
                page_number: 1
                page_size: 100
                page_count: 1
                total_item_count: 5
                items:
                  - fee_amount: 50
                    net_amount: 950
                    settlement_status: UNKNOWN
                    meta_data:
                      name: the value
                    action_flow: PAYLOAD
                    amount: 1000
                    channel_code: QR_QRIS
                    code: CHG_251095D600C40328C247
                    currency: IDR
                    description: New description for the Charge.
                    merchant_id: 019a0423-2941-735f-9a93-819df469ad39
                    reference_id: Your Reference Id
                    status: PENDING
                    created_by: drunk@sandbox.dev
                    created_on: '2025-10-21T05:17:13.6507292+00:00'
                    updated_by: drunk@sandbox.dev
                    updated_on: '2025-10-21T05:49:07.1573109+00:00'
                    id: 019a0533-3632-772a-95d6-00c40328c247
                  - failed_on: '2025-10-21T01:05:40.5145731+00:00'
                    fee_amount: 100
                    net_amount: 900
                    settlement_status: UNKNOWN
                    meta_data: {}
                    action_flow: REDIRECTION
                    amount: 1000
                    channel_code: QR_QRIS
                    code: CHG_2510A87B019974399F1C
                    currency: IDR
                    description: hello
                    merchant_id: 019a0423-2941-735f-9a93-819df469ad39
                    reference_id: steven
                    status: FAILED
                    created_by: drunk@sandbox.dev
                    created_on: '2025-10-21T00:35:47.9006924+00:00'
                    updated_by: System
                    updated_on: '2025-10-21T01:05:40.514819+00:00'
                    id: 019a0431-8e3c-79ee-a87b-019974399f1c
                  - fee_amount: 100
                    net_amount: 900
                    paid_on: '2025-10-21T03:06:54.7019641+00:00'
                    settlement_date: '2025-10-23T03:06:54.7019641+00:00'
                    settlement_status: PENDING
                    meta_data: {}
                    action_flow: EMBEDDED
                    amount: 1000
                    channel_code: QR_QRIS
                    code: CHG_2510A4A536F6CCD43176
                    currency: IDR
                    description: ''
                    merchant_id: 019a0423-2941-735f-9a93-819df469ad39
                    reference_id: ''
                    status: SUCCEEDED
                    created_by: drunk@sandbox.dev
                    created_on: '2025-10-21T03:06:44.4340741+00:00'
                    updated_by: System
                    updated_on: '2025-10-21T03:06:54.7023067+00:00'
                    id: 019a04bb-bf52-7aea-a4a5-36f6ccd43176
                  - fee_amount: 100
                    net_amount: 900
                    paid_on: '2025-10-21T00:27:58.9597338+00:00'
                    settlement_date: '2025-10-23T00:27:58.9597338+00:00'
                    settlement_status: PENDING
                    meta_data: {}
                    action_flow: REDIRECTION
                    amount: 1000
                    channel_code: QR_QRIS
                    code: CHG_2510B55639243FBD761F
                    currency: IDR
                    description: hello
                    merchant_id: 019a0423-2941-735f-9a93-819df469ad39
                    reference_id: hello
                    status: SUCCEEDED
                    created_by: drunk@sandbox.dev
                    created_on: '2025-10-21T00:22:39.3040746+00:00'
                    updated_by: System
                    updated_on: '2025-10-21T00:27:58.9651536+00:00'
                    id: 019a0425-85c7-76d2-b556-39243fbd761f
                  - fee_amount: 200
                    net_amount: 1800
                    paid_on: '2025-10-21T02:44:22.6329921+00:00'
                    settlement_date: '2025-10-23T02:44:22.6329921+00:00'
                    settlement_status: PENDING
                    meta_data: {}
                    action_flow: PAYLOAD
                    amount: 2000
                    channel_code: QR_QRIS
                    code: CHG_2510BEF48B4721EC7E93
                    currency: IDR
                    description: The payment for Steven
                    merchant_id: 019a0423-2941-735f-9a93-819df469ad39
                    reference_id: Steven
                    status: SUCCEEDED
                    created_by: drunk@sandbox.dev
                    created_on: '2025-10-21T02:35:17.8509877+00:00'
                    updated_by: System
                    updated_on: '2025-10-21T02:44:22.6400573+00:00'
                    id: 019a049e-f5da-7c68-bef4-8b4721ec7e93
          headers: {}
      deprecated: false
      security:
        - Bearer: []
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````