refund

Contains refund details

Request

Property Name

Type

Required

Description

amount

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.

taxAmount

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 amount parameter. See the Taxes guide for more details.

reason

string

Optional

Reason the shopper cancelled or requested a refund for the order.

Default value is "Per your instructions".

Maximum 4000 characters.

cancelSubscriptions

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.

vendorsRefundInfo

object

Optional

Only applicable to partial refunds (if amount was passed). Contains the details about the Marketplace vendors' portion of the refund.

See vendorsRefundInfo.

transactionMetaData

object

Optional

See transactionMetaData.

Response

Property Name

Type

Description

amount

decimal

Refund amount, positive value.

taxAmount

decimal

The tax amount that was refunded.

currency

string

Currency of refund amount.

date

string

Refund date.

refundTransactionId

integer

BlueSnap identifier for the refund.

vendorAmount

decimal

The total vendor portion of the refund amount. Only available if one or more vendor IDs were included in original transaction.

vendorsRefundInfo

object

See vendorsRefundInfo.

transactionMetaData

object

See transactionMetaData.

reason

string

Reason the shopper cancelled or requested a refund for the order.

cancelSubscriptions

boolean

Whether to cancel the subscription associated with the transaction ID.