MOmollie
Refunds API

Get payment refund

Changed on

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

get/v2/payments/{paymentId}/refunds/{refundId}

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/payments/{paymentId}/refunds/{refundId}
  • 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: refunds.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 payment object.

resourcestring

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

idstring
mode'live' | 'test'

Whether this entity was created in live mode or in test mode.

descriptionstring nullable

The description of the refund that may be shown to your customer, depending on the payment method used.

paymentIdstring
settlementIdstring
status'queued' | 'pending' | 'processing' | 'refunded' | 'failed' | 'canceled'
createdAtstring

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

reverseRoutingboolean nullable

This feature is only available to marketplace operators.

With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie merchants, by providing the routing object during payment creation.

When creating refunds for these routed payments, by default the full amount is deducted from your balance.

If you want to pull back the funds that were routed to the connected merchant(s), you can set this parameter to true when issuing a full refund.

For more fine-grained control and for partial refunds, use the routingReversals parameter instead.

testmodeboolean nullable

Whether to create the entity in test mode or live mode.

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

Example response

{
  "resource": "refund",
  "id": "re_5B8cwPMGnU",
  "mode": "live",
  "description": "Refunding a Chess Board",
  "amount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "paymentId": "tr_5B8cwPMGnU",
  "settlementId": "stl_5B8cwPMGnU",
  "status": "queued",
  "createdAt": "2024-03-20T09:13:37+00:00",
  "externalReference": {
    "type": "acquirer-reference"
  },
  "routingReversals": [
    {
      "amount": {
        "currency": "EUR",
        "value": "10.00"
      },
      "source": {
        "type": "organization",
        "organizationId": "org_1234567"
      }
    }
  ],
  "_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

  • e60bead23469Revision changes
    • info

      the response optional property //// became read-only for the status

  • 26176035db58Revision changes
    • breaking

      the response property //// became nullable for the status