Chargebacks API

List all chargebacks

Retrieve all chargebacks initiated for all your payments.

The results are paginated.

🔑 Access with

API key

Advanced access token with payments.read

OAuth access with payments.read

get/chargebacks

Request

Base URL
https://api.mollie.com/v2
URL
https://api.mollie.com/v2/chargebacks
Auth
- HTTP bearer
- or HTTP bearer
- or OAuth 2
  Authorization code: https://my.mollie.com/oauth2/authorize
  Token URL: https://api.mollie.com/oauth2/tokens scopes: payments.read

Query parameters

fromstring

Example:chb_xFzwUN4ci8HAmSGUACS4J

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

limitinteger nullable

Example:50

The maximum number of items to return. Defaults to 50 items.

embed'payment'

Example:payment

This endpoint allows you to embed additional information via the embed query string parameter.

sortstring

Example:desc

Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.

Possible values: asc desc

profileIdstring nullable

The identifier referring to the profile this entity belongs to.

Most API credentials are linked to a single profile. In these cases the profileId can be omitted in the creation request. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.

Example:pfl_5B8cwPMGnU

The identifier referring to the profile you wish to retrieve chargebacks for.

Most API credentials are linked to a single profile. In these cases the profileId is already implied.

To retrieve all chargebacks across the organization, use an organization-level API credential and omit the profileId parameter.

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Response

A list of chargeback objects.

countinteger required

The number of items in this result set. If more items are available, a _links.next URL will be present in the result as well.

The maximum number of items per result set is controlled by the limit property provided in the request. The default limit is 50 items.

Example response

{
  "count": 5,
  "_embedded": {
    "chargebacks": [
      {
        "resource": "chargeback",
        "id": "chb_xFzwUN4ci8HAmSGUACS4J",
        "amount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "settlementAmount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "reason": {
          "code": "AC01",
          "description": "Account identifier incorrect (i.e. invalid IBAN)"
        },
        "paymentId": "tr_5B8cwPMGnU",
        "settlementId": "stl_5B8cwPMGnU",
        "createdAt": "2024-03-20T09:13:37+00:00",
        "reversedAt": "2024-03-21T09:13:37+00:00",
        "_links": {
          "self": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "payment": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "settlement": {
            "href": "https://...",
            "type": "application/hal+json"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "previous": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "next": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.