Skip to content

Latest commit

 

History

History
41 lines (38 loc) · 4.46 KB

GETRefundType.md

File metadata and controls

41 lines (38 loc) · 4.46 KB
Raw

Zuora::GETRefundType

Properties

Name Type Description Notes
account_id String The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment or credit memo. [optional]
amount Float The total amount of the refund. [optional]
cancelled_on DateTime The date and time when the refund was cancelled, in `yyyy-mm-dd hh:mm:ss` format. [optional]
comment String Comments about the refund. [optional]
created_by_id String The ID of the Zuora user who created the refund. [optional]
created_date DateTime The date and time when the refund was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. [optional]
credit_memo_id String The ID of the credit memo that is refunded. [optional]
custom_field__c String Any custom fields defined for this object. The custom field name is case-sensitive. [optional]
finance_information GETRefundCreditMemoTypeFinanceInformation [optional]
gateway_id String The ID of the gateway instance that processes the refund. [optional]
gateway_response String The message returned from the payment gateway for the refund. This message is gateway-dependent. [optional]
gateway_response_code String The code returned from the payment gateway for the refund. This code is gateway-dependent. [optional]
gateway_state String The status of the refund in the gateway. [optional]
id String The ID of the refund. [optional]
marked_for_submission_on DateTime The date and time when a refund was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format. [optional]
method_type String How an external refund was issued to a customer. [optional]
number String The unique identification number of the refund. [optional]
payment_id String The ID of the payment that is refunded. [optional]
payment_method_id String The unique ID of the payment method that the customer used to make the refund. [optional]
payment_method_snapshot_id String The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction. [optional]
reason_code String A code identifying the reason for the transaction. [optional]
reference_id String The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments. [optional]
refund_date Date The date when the refund takes effect, in `yyyy-mm-dd` format. For example, 2017-03-01. [optional]
refund_transaction_time DateTime The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format. [optional]
second_refund_reference_id String The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments. [optional]
settled_on DateTime The date and time when the refund was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways. [optional]
soft_descriptor String A payment gateway-specific field that maps Zuora to other gateways. [optional]
soft_descriptor_phone String A payment gateway-specific field that maps Zuora to other gateways. [optional]
status String The status of the refund. [optional]
submitted_on DateTime The date and time when the refund was submitted, in `yyyy-mm-dd hh:mm:ss` format. [optional]
success BOOLEAN Returns `true` if the request was processed successfully. [optional]
type String The type of the refund. [optional]
updated_by_id String The ID of the Zuora user who last updated the refund. [optional]
updated_date DateTime The date and time when the refund was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. [optional]