List chargebacks

Request

This endpoint retrieves a list of chargebacks associated with your account. A Chargeback is a mandatory transaction reversal initiated by the consumer's card issuer or bank, usually due to a dispute over a transaction. When a chargeback occurs, the costumer effectively reverses the transaction, resulting in a debit of the disputed amount from the merchant's account. This endpoint allows you to view details of chargebacks, including the reason for the dispute, transaction amount, and status, providing insights into consumer disputes and their impact on your financials.

Required scope: chargeback:read

Security

accountId and apiKey

Query

cursorstring

The cursor parameter is used for pagination. It specifies the pointer to the start of the next set of results in a sequence of paginated data. Typically, this is a unique identifier of the last item from the previous response. If not provided, the API fetches the first page of results.

limitnumber

The limit parameter is used for pagination. It specifies the maximum number of entries to return in a single page of results. Max 100.

created_atstring

Filter records by creation datetime interval in UTC. Maximum allowed range is 30 days. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM).

Example:created_at=interval(2006-01-02 15:04,2006-01-02 15:04)

capture.idstring, (uuid)

Filter chargebacks by capture UUID. Returns only chargebacks associated with the specified capture.

Example:capture.id=c6056234-a3f9-42de-b944-3ed793fcb6bb

curl -i -X GET \
  'https://api.test.easypay.pt/2.0/chargeback?cursor=string&limit=0&created_at=interval(2006-01-02%2015%3A04%2C2006-01-02%2015%3A04)&capture.id=c6056234-a3f9-42de-b944-3ed793fcb6bb' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Responses

OK

Bodyapplication/json

dataArray of objects

metadataobject(Metadata)

An object containing additional information about the response. It includes details that help manage and navigate the retrieved data.

Response

{
  "data": [
    { … }
  ],
  "metadata": {
    "next_cursor": "lL_j7ilk7rc",
    "count": 10
  }
}