---
title: "Get Payments"
method: GET
path: "/v1/payments"
tags: ["Payments"]
---

# Get Payments

`GET /v1/payments`

Returns a list of payments.

## Query parameters

- `limit` integer — A limit on the number of objects to be returned
- `offset` integer — The number of objects to skip
- `start_at` integer — Optional start of the time range to filter, in Unix timestamp format (seconds)
- `end_at` integer — Optional end of the time range to filter. Mandatory if start_at is specified.
- `field` 'created_at' | 'modified_at' | 'status_updated_at' — An enumeration.
- `search_string` string — Search across order_id, email, receipt_number, payment_id, status, country, user_id.
- `user_id` string
- `order_id` string
- `status` string — Optional comma separated list of status
- `countries` string — Optional comma separated list of countries

## Response `200`

Successful Response

- PaymentRead[]
  - `user_id` string, required — The user ID of the payment
  - `player_id` string — The player ID of the payment
  - `modified_at` integer — The time of the last modification
  - `player_name` string — The name of the player
  - `item_id` string — The ID of the purchased item. Deprecated: use `items` instead.
  - `item_name` string — The name of the purchased item. Deprecated: use `items` instead.
  - `items` Item[] — List of items included in the payment
    - `id` string, required — The unique ID of the item.
    - `sku` string, required — Stock Keeping Unit (SKU) identifier.
    - `name` string, required — The name of the item.
    - `source` 'order' | 'bonus' | 'bundle' | 'coupon' | 'lootbox' | 'free_item' | 'liveops' | 'daily_reward' | 'loyalty_reward' | 'progression_program' | 'rolling_offer' | 'pick_one_offer', required
    - `description` string, nullable — The description of the item
    - `image_url` string — The URL of the image for the item
    - `quantity` integer, required — The quantity of the item.
    - `nested_items` Item[] — Nested items of the bundle.
  - `payment_method_name` string, required — The name of the payment method
  - `status` union, required — The status of the payment
    - 'created' | 'failed' | 'expired' | 'voided' | 'rejected' | 'done' | 'refund_requested' | 'refunded' | 'dispute' | 'chargeback' | 'abandoned' | 'canceled' — An enumeration.
    - string
  - `sales_channel` 'game_hub' | 'checkout' | 'android_sdk' | 'checkout_link' — An enumeration.
  - `currency` string, required — The currency of the payment
  - `country` string — The ISO code country of the payment
  - `payment_id` string — The ID of the payment
  - `payment_number` string, required — The number of the payment in receipt
  - `receipt_number` string, required — The number of the payment in receipt
  - `checkout_profile_id` string — The ID of the user checkout profile
  - `order_id` string — The ID of the order
  - `card_last_4_digits` string — The last 4 digits of the card
  - `card_scheme` string — The scheme of the card
  - `total` integer, required — The total amount of the payment
  - `total_usd` number — The payment amount converted at the exchange rate into dollars (Sales or GMV)
  - `total_usd_revenue` number — The profit in dollars, that is total_usd excluding all fees and taxes
  - `user_local_price` integer — The total amount in local currency of the payment before all discounts
  - `currency_minor_unit` integer, required — The minor unit of the currency
  - `fees` object[] — This includes all charges related to a payment, including the payment system fee, Aghanim fee, conversion, etc
  - `taxes` object[] — These are the taxes that arise from sales (the Withholding Tax is not included)
  - `refund_customer_id` string — The ID of the refunded customer
  - `refund_reason` string — The reason of the refund
  - `ip` unknown
  - `created_at` integer, required — The time of the payment creation
  - `fail_reason` string — The reason of the payment failure
  - `fail_reason_code` string — The code of the payment failure reason
  - `status_updated_at` integer — The timestamp of the status update
  - `order_field` integer — The transaction's serial number in the status list. Can be used to sort the transaction by the status list
  - `metadata` object — The metadata object of the order
  - `platform` 'any' | 'ios' | 'android' | 'other'
  - `three_d_secure_flow` 'none' | 'challenge' | 'frictionless' — An enumeration.
  - `three_d_secure_result` 'not_attempted' | 'authenticated' | 'failed' — An enumeration.
  - `applied_reward_points` integer — The applied reward points for the order that allowed you to receive a discount.
  - `coupons` Coupon[] — The list of coupons applied to the order.
    - `id` string, required — The unique ID of the coupon.
    - `code` string, required — The coupon code.
    - `name` string, required — The name of the coupon.
    - `type` 'bonus' | 'discount' | 'free_item' | 'vc' | 'non_benefit' | 'discount_fixed' | 'discount_reward_point', required — An enumeration.
    - `discount_percent` integer — Discount percent for `discount` coupons.
    - `bonus_percent` integer — Bonus percent for `bonus` coupons.
    - `bonus_fixed` integer — Fixed bonus quantity for `bonus` coupons.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/aghanim/apis/aghanim-server-to-server-api.md) · [All operations](https://skmtc.net/aghanim/apis/aghanim-server-to-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aghanim/aghanim-server-to-server-api/versions/6402c25762c8/schema)