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.

tax-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 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.

cancel-subscriptions

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.

vendors-refund-info

container

Optional

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

Refer to vendors-refund-info.

transactionMetaData

container

Optional

Container of transaction-meta-data properties.

Response

Property Name

Type

Description

amount

decimal

Refund amount, positive value

tax-amount

decimal

The tax amount that was refunded

currency

string

Currency of refund amount

date

string

Refund date

refund-transaction-id

integer

BlueSnap identifier for the refund.

vendor-amount

decimal

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

vendors-refund-info

container

Container of vendors-refund-info properties.

transaction-meta-data

container

Container of transaction-meta-data properties.

reason

string

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

cancel-subscriptions

boolean

Whether to cancel the subscription associated with the transaction ID.