Refund - Payment Module Data Models Reference

This documentation provides a reference to the Refund data model. It belongs to the Payment Module.

idPrimaryKeyModifier<IdProperty>
The ID of the refund.
amountBigNumberProperty
The refunded amount.
paymentBelongsTo<Payment>
The associated payment.
refund_reasonBelongsTo<RefundReason>Optional
The associated refund reason.
noteTextPropertyOptional
A note with more explanation about the refund
created_byTextPropertyOptional
The ID of the user that created the refund.
metadataJSONPropertyOptional
Holds custom data in key-value pairs.
Was this page helpful?