refund

Contains refund details

Request

Property NameTypeRequiredDescription
amountdecimalOptionalAmount to be refunded, if this is a partial refund.

Value must be greater than 0 and must not exceed the total transaction amount.
tax-amountdecimalOptionalTax amount to be refunded, if this is a partial refund. Remember to also specify the total refund amount (including tax) in the amount parameter. See the Taxes guide for more details.
reasonstringOptionalReason the shopper cancelled or requested a refund for the order.

Default value is "Per your instructions".

Maximum 4000 characters.
cancel-subscriptionsbooleanOptionalWhether 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.
vendors-refund-infocontainerOptionalOnly applicable to partial refunds (if amount was passed). Contains the details about the Marketplace vendors' portion of the refund.

Refer to vendors-refund-info.
transactionMetaDatacontainerOptionalContainer of transaction-meta-data properties.

Response

Property NameTypeDescription
amountdecimalRefund amount, positive value
tax-amountdecimalThe tax amount that was refunded
currencystringCurrency of refund amount
datestringRefund date
refund-transaction-idintegerBlueSnap identifier for the refund.
vendor-amountdecimalThe total vendor portion of the refund amount. Only available if one or more vendor IDs were included in original transaction.
vendors-refund-infocontainerContainer of vendors-refund-info properties.
transaction-meta-datacontainerContainer of transaction-meta-data properties.
reasonstringReason the shopper cancelled or requested a refund for the order.
cancel-subscriptionsbooleanWhether to cancel the subscription associated with the transaction ID.
refundStatusstringThe status of the refund, either SUCCESS or PENDING. Learn more about pending refunds here.