Disputes

Returns a list of disputes (chargebacks) opened against the game's payments.

get/v1/disputes

Request

  • Base URL
    https://api.aghanim.com/s2s
  • Auth
    HTTP bearer

Query parameters

limitinteger

A limit on the number of objects to be returned.

offsetinteger

The number of objects to skip.

start_atinteger

The earliest value of the order_by field of the disputes to return, as a Unix timestamp in seconds.

end_atinteger

The latest value of the order_by field of the disputes to return, as a Unix timestamp in seconds. The range includes this whole second.

order_by'created_at' | 'updated_at'

The dispute timestamp that the start_at/end_at range and the sort order apply to.

payment_idstring

Optional comma separated list of payment ids

statusstring

Optional comma separated list of dispute statuses

reason_categorystring

Optional comma separated list of dispute reason categories (e.g. fraudulent,duplicate)

Response

Successful Response

idstring required

The ID of the dispute.

status'pending' | 'accepted' | 'resolved' | 'won' | 'lost' | 'expired' | 'canceled' required

The status of the dispute at the payment processor.

reasonstring required

The reason as reported by the payment processor, for example, 10.4.

reason_category'general' | 'canceled_recurring' | 'credit_not_issued' | 'duplicate' | 'fraudulent' | 'incorrect_amount' | 'not_as_described' | 'product_service_not_received'

The category of the dispute reason; null when it's unknown.

amountinteger required

The disputed amount in minor units of currency.

currency'USD' | 'EUR' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XCG' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' | 'ZWL' | 'RP' | 'VC' required

The currency of the disputed amount.

amount_usdnumber required

The disputed amount booked in USD, in minor units (cents), as of when it was recorded.

amount_eurnumber required

The disputed amount booked in EUR, in minor units (cents), as of when it was recorded.

descriptionstring required

The description reported by the payment processor.

created_atinteger required

The time when the dispute was opened, as a Unix timestamp in seconds.

updated_atinteger required

The time when the dispute last changed, as a Unix timestamp in seconds.

payment_idstring required

The ID of the payment that the dispute was opened against.

order_idstring required

The ID of the order that the dispute was raised against.

user_idstring required

The ID that Aghanim gives to the player who made the payment.

player_idstring

The ID that your game gives to the player who made the payment.

amount_decimalnumber required

Disputed amount in major units of currency

Changes