---
title: "Get All Charges"
method: GET
path: "/v1/charges"
---

# Get All Charges

`GET /v1/charges`

Get all charges

## Query parameters

- `per_page` integer
- `cursor` string — The cursor parameter accepts a next_cursor value obtained from the previous response's meta object (meta.next_cursor). Use this parameter to fetch the next page of results when implementing pagination.
- `keywords` string
- `status` 'succeeded' | 'failed' | 'refunded'
- `location_ids` string[]
- `user_ids` string[]
- `statuses` string[]
- `date_from` string
- `date_to` string
- `amount_from` number
- `amount_to` number
- `payment_request_id` string, uuid
- `customer_id` string, uuid
- `payout_id` string, uuid

## Headers

- `X-BUSINESS-API-KEY` string, required

## Response `200`

Successful payment

- object
  - `data` object[], required
    - `id` string, required
    - `currency` string, required
    - `home_currency` string, required
    - `exchange_rate` string, nullable, required
    - `amount` number, required
    - `fixed_fee` number, required
    - `discount_fee` number, required
    - `discount_fee_rate` number, required
    - `remark` unknown, required
    - `status` string, required
    - `payment_method` object, required
      - `name` string, required
      - `display_logo` object, required
        - `sm` string, required
        - `md` string, required
        - `lg` string, required
        - `svg` string, required
        - `svg_square` string, required
        - `png_square` string, required
        - `method` string, required
        - `iconName` string, required
        - `displayName` string, required
      - `method_logo` object, required
        - `sm` string, required
        - `md` string, required
        - `lg` string, required
        - `svg` string, required
        - `svg_square` string, required
        - `png_square` string, required
        - `method` string, required
        - `iconName` string, required
        - `displayName` string, required
      - `data` object, required
        - `brand` string, required
        - `last4` string, required
        - `country_code` string, required
        - `country` string, required
    - `customer_id` string, nullable, required
    - `customer` object, nullable, required
      - `name` string, required
      - `email` string, required
      - `phone_number` unknown, required
    - `payment_request_id` unknown, required
    - `webhook_status` boolean, required
    - `order_reference_number` string, required
    - `executor` object, nullable, required
      - `id` string, required
      - `display_name` string, required
      - `email` string, required
    - `location` object, nullable, required
      - `id` string, required
      - `name` string, required
      - `address` string, required
    - `channel` string, required
    - `admin_fee` boolean, required
    - `closed_at` string, required
    - `created_at` string, required
    - `updated_at` string, required
  - `links` object, required
    - `first` unknown, required
    - `last` unknown, required
    - `prev` unknown, required
    - `next` string, required
  - `meta` object, required
    - `path` string, required
    - `per_page` number, required
    - `next_cursor` string, required
    - `prev_cursor` unknown, required

---

[API](https://skmtc.net/hitpayapp/apis/hitpay-api.md) · [All operations](https://skmtc.net/hitpayapp/apis/hitpay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hitpayapp/hitpay-api/revisions/6aae1a736990/schema)