RefundDetails

Version 2024-04-01

Overview

Details about a refund.

Fields

FieldDescription
aliases ([Alias])

A list of aliases associated with Buy With Prime Refund. This can include unique identifiers for refunds in merchant's store.

createdAt (String)

The Date Time in ISO 8601 format when a refund was created.

id (ID required)

Unique identifier for a refund.

paymentDetails ([PaymentDetails])

Provides details about payments that are disbursed for a refund. Note that there could be multiple payments amongst different payment methods for a refund.

refundFor (RefundFor)

Captures the reason for which this refund is entitled to e.g. refunds against a lineItem, a return etc. E.g. Refund issued for Two OrderLineItems "refundFor": { "orderLineItems": [ { "lineItem": { // lineItem-1 object }, "amount": {"amount": 1} }, { "lineItem": { // lineItem-2 object }, "amount": {"amount": 2} }, ] }

refundTotal (RefundTotal)

Represents the total amount that has been refunded or is in progress. Note that refundable charges can get added while paymentDetails are not in terminal state. Once all the paymentDetails reach terminal state, refundTotal reflects the total amount that was refunded.

state (String)

Indicates the state of the refund.

The value is constrained to one of the following

valuedescription
PENDINGRefund is created and pending
FAILURERefund has failed.
PARTIALRefund is Partially successful.
SUCCESSRefund is completed successfully
updatedAt (String)

The Date Time in ISO 8601 format when a refund was last updated.