Refund
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| amount | float | ❌ | Amount of the refund, in units defined by currency in the original payment. Decimal, including the correct number of decimal places for the currency exponent, as defined in ISO 2417:2015. |
| created_at | float | ❌ | Time of creation of this refund, in Unix time. Response only. |
| currency | str | ❌ | |
| ewallets | List[RefundEwallets] | ❌ | An array of one object, which contains the following fields: _ ewalletid - The ID of the wallet that the money is transferred from, a string starting with ewallet. _ amount - Amount of the transaction in currency units defined in currency. * percent - A decimal number representing a percentage of the total payout. Response only. |
| failure_reason | str | ❌ | Indicates the reason that the refund failed. |
| fixed_side | str | ❌ | Indicates whether the FX rate is fixed for the buy side or for the sell side. Relevant for refunds with foreign exchange. Response only. |
| fx_rate | str | ❌ | Exchange rate for the transaction. When fixed_side is buy, fx_rate is the buy rate. When fixed_side is sell, fx_rate is the sell rate. Decimal number as string. Relevant to refunds with foreign exchange. Response only. |
| id_ | str | ❌ | ID of the Refund object. String starting with refund_. |
| merchant_debited_amount | str | ❌ | Amount debited from the merchant. Relevant to refunds with foreign exchange. Response only. |
| merchant_debited_currency | str | ❌ | Indicates the currency that is debited from the merchant. Three-letter ISO 4217 code. Relevant to refunds with foreign exchange. Response only. |
| merchant_reference_id | str | ❌ | Merchant-defined ID. Limited to 255 characters. |
| metadata | dict | ❌ | A JSON object defined by the client. |
| payment | str | ❌ | D of the Payment object that the refund is credited against. String starting with payment_. |
| payment_created_at | float | ❌ | Time that the original payment was created, in Unix time. Response only. |
| payment_method_type | str | ❌ | The original payment payment method type. Use List Payment Methods by Country for a list of supported types for a country |
| proportional_refund | bool | ❌ | Indicates whether the refund was returned in proportion to the amounts received by the wallets in the payment. Relevant to a refund for a payment split among multiple wallets. |
| reason | str | ❌ | Description of the reason for the refund, provided by the merchant. |
| receipt_number | float | ❌ | Number of the receipt for the refund, provided by the merchant. Response only. |
| status | str | ❌ | Indicates the status of the refund operation |
| updated_at | float | ❌ | Time that this refund was last updated, in Unix time. Response only. |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs