A Refund represents a refund created for an Ansa transaction - either for a payment from a customer balance or a balance load transaction.
Refund Attributes
| Field | Type | Description | Example value |
|---|---|---|---|
id | string | Unique identifier for the refund. | 2aa3d415-8256-4d0e-97a1-7cd0a09e0230 |
transactionId | string | The refunded transaction id. | |
customerId | string | The customer id that is associated with the transaction. | |
type | string | The type of the refund. Possible values are: - balance- payment_method | |
amount | integer | The refunded amount must be a positive integer, in the smallest currency unit used in the original transaction. It should be greater than 0 and less than or equal to the original transaction amount. | |
currency | string | The three-letter ISO currency code in lowercase. Currently, the only supported currency is usd. | |
reason | string | Merchant supplied a reason for why the refund is being issued. | |
paymentMethod | object | If a payment method refund, describes details about the underlying payment method. An object representing an associated payment method. Attributes are: - id string | |
status | string | The refund status. Possible values are: - succeeded- pending- failed | |
metadata | object | A set of key-value pairs that you can attach to a refund object. | |
created | string | The time the refund was created, in RFC 3339 format | 2022-09-16T19:28:23.120Z |