RefundInvoicePayment
From API Documentation
Refunds are only available in version 18.0 and higher of the Z-Commerce API.
Supported Calls
This object is used in the query call only. This is auto-generated object by Zuora when you create a Refund
Fields
In addition to the following fields, zObject contributes additional fields. For information on the field types, see Field Types.
| Name | Required? | Type | Allowed Operations: ● Yes ○ No | Allowable Values | Description |
|---|---|---|---|---|---|
| CreatedById | System generated, always exists | ZNS:Id | ○ Create
● Query | This field is not editable. | The Zuora system automatically generates this Id of the user who created the object. |
| CreatedDate | System generated, always exists | dateTime | ○ Create
● Query | 32 characters maximum. This field is not editable. | The Zuora system automatically generates this, and denotes when the object was first created. |
| InvoicePaymentId | System generated, always exists | ZNS:Id | ○ Create
● Query | This field is not editable, valid ID of an InvoicePayment | ID of the InvoicePayment that is associated with the refund. |
| RefundAmount | Yes, Read-only | decimal | ○ Create
● Query | The amount of the refund that was applied to this InvoicePayment referenced by this object. Please note that the Z-Payment allows a single refund to be issued which can be applied to multitple payments (and hence invoice payments). For refunds created with the Z-Commerce API, a refund can only be applied a single payment, and as such, RefundAmount will always equal Refund.Amount. | |
| RefundId | Yes, read-only | ZNS:Id | ○ Create
● Query | A valid Id of a Refund object. | The Id of the Refund object. |
| UpdatedById | System generated, always exists | ZNS:Id | ○ Create
● Query | 32 characters maximum. This field is not editable. | The Zuora system automatically generates this ID of the user who last updated the object. |
| UpdatedDate | System generated, always exists | dateTime | ○ Create
● Query | This field is not editable. | The Zuora system automatically generates this, and identifies when the object was last updated. |
Example
The following is an example of a valid electronic refund create() call:
<ns2:create> <ns2:zObjects xsi:type="ns1:Refund"> <ns1:Amount>5</ns1:Amount> <ns1:Comment>Refund for not applying discount.</ns1:Comment> <ns1:PaymentId>4028e69926c4da560126e8b1785c3b2a</ns1:PaymentId> <ns1:Type>Electronic</ns1:Type> </ns2:zObjects> </ns2:create>
Example of a valid electronic refund create() response:
<ns1:createResponse xmlns:ns1="http://api.zuora.com/"> <ns1:result> <ns1:Id>4028e6992745e8af012759c3deaf5459</ns1:Id> <ns1:Success>true</ns1:Success> </ns1:result> </ns1:createResponse>
Upon successful creation of an electronic refund, money is refunded back to the customer via the payment gateway where the charge generated. Zuora will create a RefundInvoicePayment automatically with this API transaction.
