Sign in

fd2c63d975cd

OpenAPI 3.1.02026-08-12171439930.3 KB
Payments

Get Payments

Returns a list of payments.

get/v1/payments

Query parameters

limitinteger

A limit on the number of objects to be returned

A limit on the number of objects to be returned

offsetinteger

The number of objects to skip

The number of objects to skip

start_atinteger

Optional start of the time range to filter, in Unix timestamp format (seconds)

Optional start of the time range to filter, in Unix timestamp format (seconds)

end_atinteger

Optional end of the time range to filter. Mandatory if start_at is specified.

Optional end of the time range to filter. Mandatory if start_at is specified.

field'created_at' | 'modified_at' | 'status_updated_at'

An enumeration.

Field by which the start_at/end_at range is filtered

search_stringstring

Search across order_id, email, receipt_number, payment_id, status, country, user_id.

Search across order_id, email, receipt_number, payment_id, status, country, user_id.

user_idstring
order_idstring
statusstring

Optional comma separated list of status

Optional comma separated list of status

countriesstring

Optional comma separated list of ISO 3166-1 alpha-2 country codes (e.g. US,DE).

Optional comma separated list of ISO 3166-1 alpha-2 country codes (e.g. US,DE).

Response

Successful Response

user_idstring required

The user ID of the payment

player_idstring

The player ID of the payment

modified_atinteger

The time of the last modification

player_namestring

The name of the player

item_idstring

The ID of the purchased item. Deprecated: use items instead.

item_namestring

The name of the purchased item. Deprecated: use items instead.

payment_method_namestring required

The name of the payment method

sales_channel'game_hub' | 'checkout' | 'android_sdk' | 'checkout_link'

An enumeration.

currencystring required

The currency of the payment

countrystring

The ISO code country of the payment

payment_idstring

The ID of the payment

payment_numberstring required

The number of the payment in receipt

receipt_numberstring required

The number of the payment in receipt

checkout_profile_idstring

The ID of the user checkout profile

order_idstring

The ID of the order

card_last_4_digitsstring

The last 4 digits of the card

card_schemestring

The scheme of the card

totalinteger required

The total amount of the payment

total_usdnumber

The payment amount converted at the exchange rate into dollars (Sales or GMV)

total_usd_revenuenumber

The profit in dollars, that is total_usd excluding all fees and taxes

user_local_priceinteger

The total amount in local currency of the payment before all discounts

currency_minor_unitinteger required

The minor unit of the currency

feesobject[]

This includes all charges related to a payment, including the payment system fee, Aghanim fee, conversion, etc

taxesobject[]

These are the taxes that arise from sales (the Withholding Tax is not included)

refund_customer_idstring

The ID of the refunded customer

refund_reasonstring

The reason of the refund

{"stackTrail":"components:schemas:PaymentRead:properties:ip","oasType":"schema","type":"unknown","title":"Ip","description":"The IP address of the payment"}
created_atinteger required

The time of the payment creation

fail_reasonstring

The reason of the payment failure

fail_reason_codestring

The code of the payment failure reason

status_updated_atinteger

The timestamp of the status update

order_fieldinteger

The transaction's serial number in the status list. Can be used to sort the transaction by the status list

metadataobject

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_pointsinteger

The applied reward points for the order that allowed you to receive a discount.