| Field | Type | Required | Description | Example |
|---|---|---|---|---|
resource |
String | ✔️ | Indicates the response contains a refund object. Will always contain the string refund for this endpoint. |
refund |
id |
String | ✔️ | The identifier uniquely referring to this refund. Mollie assigns this identifier at refund creation time. Mollie will always refer to the refund by this ID. Example: re_4qqhO89gsT. |
re_5B8cwPMGnU |
mode |
Mode | ✔️ | Whether this entity was created in live mode or in test mode. | live |
description |
String | ✔️ | The description of the refund that may be shown to your customer, depending on the payment method used. | Refunding a Chess Board |
amount |
Amount | ✔️ | In v2 endpoints, monetary amounts are represented as objects with a currency and value field. |
|
settlementAmount |
JsonNullable<EntityRefundResponseSettlementAmount> | ➖ | This optional field will contain the approximate amount that will be deducted from your account balance, converted to the currency your account is settled in. The amount is a negative amount. If the refund is not directly processed by Mollie, for example for PayPal refunds, the settlement amount will be zero. Since the field contains an estimated amount during refund processing, it may change over time. For example, while the refund is queued the settlement amount is likely not yet available. To retrieve accurate settlement amounts we recommend using the List balance transactions endpoint instead. |
|
metadata |
Optional<Metadata> | ✔️ | Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB. |
|
paymentId |
Optional<String> | ➖ | The unique identifier of the payment this refund was created for. The full payment object can be retrieved via the payment URL in the _links object. |
tr_5B8cwPMGnU |
settlementId |
JsonNullable<String> | ➖ | The identifier referring to the settlement this refund was settled with. This field is omitted if the refund is not settled (yet). | stl_5B8cwPMGnU |
status |
EntityRefundResponseStatus | ✔️ | N/A | queued |
createdAt |
String | ✔️ | The entity's date and time of creation, in ISO 8601 format. | 2024-03-20T09:13:37+00:00 |
externalReference |
Optional<EntityRefundResponseExternalReference> | ➖ | N/A | |
routingReversals |
List<EntityRefundResponseRoutingReversals> | ➖ | This feature is only available to marketplace operators. When creating refunds for routed payments, by default the full amount is deducted from your balance. If you want to pull back funds from the connected merchant(s), you can use this parameter to specify what amount needs to be reversed from which merchant(s). If you simply want to fully reverse the routed funds, you can also use the reverseRouting parameter instead. |
|
links |
EntityRefundResponseLinks | ✔️ | An object with several relevant URLs. Every URL object will contain an href and a type field. |