| Name | Type | Description | Notes |
|---|---|---|---|
| account_id | String | The ID of the account associated with this refund. This field is only required if you create a non-referenced refund. Don't specify a value for any other type of refund; Zuora associates the refund automatically with the account from the associated payment. Character limit: 32 Values: a valid account ID | [optional] |
| amount | Float | The amount of the refund. The amount can't exceed the amount of the associated payment. If the original payment was applied to a single invoice, then you can create a partial refund. However, if the payment was applies to multiple invoices, then you can only make a partial refund through the web-based UI, not through the API. Character limit: 16 Values: a valid currency amount | |
| comment | String | Use this field to record comments about the refund. Character limit: 255 Values: a string of 255 characters or fewer | [optional] |
| gateway_option_data | ProxyCreatePaymentGatewayOptionData | [optional] | |
| gateway_state | String | The status of the payment in the gateway. Character limit: 19 Values: automatically generated | [optional] |
| method_type | String | Indicates how an external refund was issued to a customer. This field is only required if the `Type` field is set to ` External`. You can issue an external refund on an electronic payment. Character limit: 30 Values: - `ACH` - `Cash` - `Check` - `CreditCard` - `Other` - `PayPal` - `WireTransfer` - `DebitCard` - `CreditCardReferenceTransaction` | [optional] |
| payment_method_id | String | The unique ID of the payment method that the customer used to make the payment. This field is only required if you create a non-referenced refund. Character limit: 32 V****alues: a valid payment method ID | [optional] |
| reason_code | String | A code identifying the reason for the transaction. Must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code. Character limit: 32 V****alues: a valid reason code | [optional] |
| refund_date | Date | The date of the refund, in `yyyy-mm-dd` format. The date of the refund cannot be before the payment date. This field is only required if the `Type` field is set to ` External`. Zuora automatically generates this field for electronic refunds. Character limit: 29 | [optional] |
| refund_invoice_payment_data | ProxyCreateRefundRefundInvoicePaymentData | [optional] | |
| soft_descriptor | String | A payment gateway-specific field that maps Zuora to other gateways . Character limit: 35 Values: - 3-byte company identifier "" 18-byte descriptor - 7-byte company identifier "" 14-byte descriptor - 12-byte company identifier "*" 9-byte descriptor | [optional] |
| soft_descriptor_phone | String | A payment gateway-specific field that maps Zuora to other gateways . Character limit: 20 Values: - Customer service phone number formatted as: `NNN-NNN-NNNN` or `NNN-AAAAAAA` - URL (non-e-Commerce): Transactions sent with a URL do not qualify for the best interchange rate - Email address | [optional] |
| source_type | String | Specifies whether the refund is a refund payment or a credit balance. This field is only required if you create a non-referenced refund. If you creating an non-referenced refund, then set this value to `CreditBalance`. Character limit: 13 Values: - `Payment` - `CreditBalance` | [optional] |
| type | String | Specifies if the refund is electronic or external. Character limit: 10 Values: - `Electronic` - External |