MOmollie
Chargebacks API

Get payment chargeback

Changed on

Retrieve a single payment chargeback by its ID and the ID of its parent payment.

get/v2/payments/{paymentId}/chargebacks/{chargebackId}

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/payments/{paymentId}/chargebacks/{chargebackId}
  • 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

embedstring nullable

This endpoint allows embedding related API items by appending the following values via the embed query string 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.

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

The chargeback object.

resourcestring required

Indicates the response contains a chargeback object. Will always contain the string chargeback for this endpoint.

idstring required
paymentIdstring required
settlementIdstring
createdAtstring required

The entity's date and time of creation, in ISO 8601 format.

reversedAtstring nullable

The date and time the chargeback was reversed if applicable, in ISO 8601 format.

Example response

{
  "resource": "chargeback",
  "id": "chb_xFzwUN4ci8HAmSGUACS4J",
  "amount": {
    "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"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

  • 7cab62b21830Revision changes
    • info

      added the non-success response with the status

  • ef4b5a97b56aRevision changes
    • info

      the endpoint scheme security advancedAccessToken was added to the API

    • info

      the endpoint scheme security organizationAccessToken was removed from the API