| Name | Type | Description | Notes |
|---|---|---|---|
| created | DateTime | { "description" : "The UTC DateTime when the object was created.", "verbs":[] } | [optional] |
| changed_by | String | { "description" : "ID of the user who last updated the entity.", "verbs":[] } | [optional] |
| updated | DateTime | { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] } | [optional] |
| id | String | { "description" : "", "verbs":["GET", "PUT"] } | [optional] |
| organization_id | String | { "description" : "", "verbs":[] } | [optional] |
| account_id | String | { "description" : "Identifier of account to refund.", "verbs":["GET"] } | [optional] |
| reason | String | { "description" : "The reason for the refund.", "verbs":["GET"] } | [optional] |
| nominal_value | Float | { "description" : "", "verbs":[] } | |
| value | Float | { "description" : "Positive decimal representing the total value to refund. This is at most the amount un-refunded on the payment. If amount is the total payment amount is refunded.", "verbs":["POST","GET"] } | [optional] |
| refunded | Float | { "description" : "Value refunded", "verbs":["GET"] } | [optional] |
| actual_value | Float | { "description" : "", "verbs":[] } | |
| nominal_refunded_value | Float | { "description" : "Nominal value refunded.", "verbs":[] } | |
| actual_refunded_value | Float | { "description" : "Refunded amount", "verbs":[] } | |
| refund_state | String | { "default" : "AwaitingRefund", "PUT_description" : "<span class=\"label label-default\">Pending</span> refunds can be set to <span class=\"label label-default\">AwaitingRefund</span> to initiate the refund or <span class=\"label label-default\">Cancelled</span> to stop the refund.", "description" : "Initially a refund is in the <span class=\"label label-default\">AwaitingRefund</span> state. Once the funds are successfully returned the state is <span class=\"label label-default\">Refunded</span>. If the refund fails or is rejected is it set as <span class=\"label label-default\">Failed</span>. Refunds can be set to a <span class=\"label label-default\">Pending</span> state to support authorization flows, and will leave the refund pending until updated to <span class=\"label label-default\">AwaitingRefund</span>. <span class=\"label label-default\">Cancelled</span> is when a refund will not be executed.", "verbs":["GET", "POST", "PUT"] } | |
| refund_type | String | { "description" : "This is the type of refund. Refunds are associated with either an invoice and payment, a payment or unreferenced.", "verbs":[] } | |
| refund_nature | String | {"default":"<span class=\"label label-default\">SingleAttempt</span>","description":The mechanism by which credit is returned to the customer:<br><span class=\"label label-default\">Void</span> — The original authorized payment is voided before capture.<br><span class=\"label label-default\">Refund</span> — A refund is issued against an already-captured payment.","verbs":["GET"]} | |
| refund_completed | DateTime | { "description" : "When the refund was completed", "verbs":["GET"] } | [optional] |
| currency | String | { "description" : "Currency of the refund specified by a three character ISO 4217 currency code.", "verbs":["GET"] } | |
| payment_method_id | String | { "description" : "Payment method to refund from", "verbs":["GET"] } | [optional] |
| invoice_payment_id | String | { "description" : "Invoice payment to refund", "verbs":["POST", "GET"] } | [optional] |
| refund_invoice_payment_id | String | { "description" : "", "verbs":[] } | [optional] |
| original_payment_id | String | { "description" : "Original payment being refunded.", "verbs":["GET"] } | [optional] |
| original_gateway_payment_reference | String | { "description" : "Reference in the gateway to the payment being refunded.", "verbs":["GET"] } | [optional] |
| refund_payment_id | String | { "description" : "Identifier for the payment used to refund", "verbs":["GET"] } | [optional] |
| invoice_id | String | { "description" : "Invoice to refund.", "verbs":["POST","GET"] } | [optional] |
| receipt_id | String | { "description" : "ID of the receipt for this refund.", "verbs":["POST","GET"] } | [optional] |
| original_receipt_id | String | { "description" : "ID of the receipt for the successful payment that this entity refunds.", "verbs":["POST","GET"] } | [optional] |
| created_by | String | { "description" : "Refund requested by this account", "verbs":["GET"] } | [optional] |
This repository was archived by the owner on Oct 17, 2023. It is now read-only.