Contains refund details
Request
Property Name | Type | Required | Description |
---|---|---|---|
| decimal | Optional | Amount to be refunded, if this is a partial refund. Value must be greater than 0 and must not exceed the total transaction amount. |
| decimal | Optional | Tax amount to be refunded, if this is a partial refund. Remember to also specify the total refund amount (including tax) in the |
| string | Optional | Reason the shopper cancelled or requested a refund for the order. Default value is "Per your instructions". Maximum 4000 characters. |
| boolean | Optional | Whether to cancel the subscription associated with the transaction ID. Values: true (default) - Cancel the subscription and refund the charge false - Do not cancel the subscription. Just refund the charge. |
| container | Optional | Only applicable to partial refunds (if Refer to vendors-refund-info. |
| container | Optional | Container of transaction-meta-data properties. |
Response
Property Name | Type | Description |
---|---|---|
| decimal | Refund amount, positive value |
| decimal | The tax amount that was refunded |
| string | Currency of refund amount |
| string | Refund date |
| integer | BlueSnap identifier for the refund. |
| decimal | The total vendor portion of the refund amount. Only available if one or more vendor IDs were included in original transaction. |
| container | Container of vendors-refund-info properties. |
| container | Container of transaction-meta-data properties. |
| string | Reason the shopper cancelled or requested a refund for the order. |
| boolean | Whether to cancel the subscription associated with the transaction ID. |