On this page
No Headings
The invoicing refund details. Includes the refund type, date, amount, and method.
objectrefund_amountobjectThe aggregated refund amounts.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.transactionsarrayAn array of refund details for the invoice. Includes the refund type, date, amount, and method.
itemsobjectThe refund details of the invoice. Includes the refund type, date, amount, and method.
typestring"PAYPAL", "EXTERNAL"^[\S\s]*$The PayPal refund type. Indicates whether the refund was paid through PayPal or externally in the invoicing flow. The record refund method supports the EXTERNAL refund type. The PAYPAL refund type is supported for backward compatibility.
refund_idstring^[\S\s]*$The ID for a PayPal payment transaction. Required for the PAYPAL payment type.
refund_datestringppaas_date_notime_v2^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The date when the invoice was refunded, in Internet date format. For example, 2014-02-27.
amountobjectThe amount to record as refunded. If you omit the amount, the total invoice paid amount is recorded as refunded.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.methodrequiredstring"BANK_TRANSFER", "CASH", "CHECK", "CREDIT_CARD", "DEBIT_CARD", "PAYPAL", "WIRE_TRANSFER", "OTHER"^[\S\s]*$The payment mode or method through which the invoicer can accept the payments.