Sign in

v1

latestOpenAPI 3.0.22026-07-2667277423.4 KB
Chargebacks

Chargeback: List

Retrieves a paginated list of chargeback requests for the authenticated merchant.

Results are ordered with pending chargebacks first, followed by non-pending chargebacks. There is no request sort parameter.

This endpoint is only available to merchants with the chargeback feature enabled; otherwise it returns 404 Not Found.

get/chargeback_requests

Query parameters

start_timestring date-time

Query for records created after this time.

end_timestring date-time

Query for records created before this time.

per_pageinteger

How many objects per page.

pageinteger

Page number to query for.

status'pending' | 'accepted' | 'cancelled' | 'expired' | 'defended' | 'lost'

Current status of a chargeback request.

Filter by chargeback status.

payment_idstring

Filter by the associated payment ID.

due_date_startstring date-time

Lower bound (inclusive) on the chargeback's due date.

due_date_endstring date-time

Upper bound (inclusive) on the chargeback's due date.

Response

200 response

resourcestring required

Resource type name, always "list".

start_timestring date-time required

Start of the time range for records in this response.

end_timestring date-time required

End of the time range for records in this response.

totalinteger required

Total number of records matching the query.

pageinteger required

Current page number.

per_pageinteger required

Number of results per page.

last_pageinteger required

Last available page number.

Example response

{
  "data": [
    {
      "currency": "JPY",
      "reason_code": "CB_Fraud"
    }
  ]
}