ASastra
Chargebacks

Get a User's Chargebacks

Changed on

📘

You can place your application's client_id into the username field, and your client_secret into the password form field of the Authentication section of this documentation 👉.

Retrieve a User's open chargebacks filed within a date window, once they reach any of the thresholds you provide.

  • At least one of min_count, min_volume or min_case_amount is required. A threshold is reached when the User's chargebacks meet or exceed it, and reaching any one is enough.
  • Only open chargebacks count. Chargebacks that have been won or lost are left out of the totals and the results.
  • The totals are always returned, so you can see how close a User is to a threshold. The chargebacks themselves are listed in results only once a threshold is reached.
  • Amounts are in dollars (e.g. 25.00 is $25.00).
get/v1/chargebacks/user

Request

  • Base URL
    https://api-sandbox.astra.finance
  • URL
    https://api-sandbox.astra.finance/v1/chargebacks/user
  • Auth
    HTTP basic

Query parameters

user_idstring required

The ID of the User

start_datestring date required

The first filing date of the window, inclusive (YYYY-MM-DD)

end_datestring date required

The last filing date of the window, inclusive (YYYY-MM-DD). Must not be before start_date.

min_countinteger

Reached when the User has at least this many open chargebacks in the window

min_volumenumber float

Reached when the User's open chargebacks in the window add up to at least this amount, in dollars (e.g. 250.00)

min_case_amountnumber float

Reached when any one of the User's open chargebacks in the window is for at least this amount, in dollars (e.g. 100.00)

Response

Successful response

client_idstring

Your application's client_id

user_idstring

The User ID from the request

start_datestring date

The start_date from the request

end_datestring date

The end_date from the request

total_countinteger

The number of the User's open chargebacks filed in the window

total_volumenumber float

The summed amount of the User's open chargebacks filed in the window, in dollars. 0 when there are none.

largest_case_amountnumber float

The amount of the User's largest open chargeback filed in the window, in dollars. 0 when there are none.

currencystring nullable

The ISO 4217 currency code of the amounts. null when the User has no open chargebacks in the window.

metstring[]

The thresholds the User reached. Empty when none were reached.

truncatedboolean

true when results holds only the 100 most recently filed of more matching chargebacks. The totals always cover every matching chargeback.

Changes