SquareConnect::V1Refund

March 13, 2019 ยท View on GitHub

Description

V1Refund

Properties

NameTypeDescriptionNotes
typeStringThe type of refund See V1RefundType for possible values[optional]
reasonStringThe merchant-specified reason for the refund.[optional]
refunded_moneyV1MoneyThe amount of money refunded. This amount is always negative.[optional]
refunded_processing_fee_moneyV1MoneyThe amount of processing fee money refunded. This amount is always positive.[optional]
refunded_tax_moneyV1MoneyThe total amount of tax money refunded. This amount is always negative.[optional]
refunded_additive_tax_moneyV1MoneyThe amount of additive tax money refunded. This amount is always negative.[optional]
refunded_additive_taxArray<V1PaymentTax>All of the additive taxes associated with the refund.[optional]
refunded_inclusive_tax_moneyV1MoneyThe amount of inclusive tax money refunded. This amount is always negative.[optional]
refunded_inclusive_taxArray<V1PaymentTax>All of the inclusive taxes associated with the refund.[optional]
refunded_tip_moneyV1MoneyThe amount of tip money refunded. This amount is always negative.[optional]
refunded_discount_moneyV1MoneyThe amount of discount money refunded. This amount is always positive.[optional]
refunded_surcharge_moneyV1MoneyThe amount of surcharge money refunded. This amount is always negative.[optional]
refunded_surchargesArray<V1PaymentSurcharge>A list of all surcharges associated with the refund.[optional]
created_atStringThe time when the merchant initiated the refund for Square to process, in ISO 8601 format.[optional]
processed_atStringThe time when Square processed the refund on behalf of the merchant, in ISO 8601 format.[optional]
payment_idStringA Square-issued ID associated with the refund. For single-tender refunds, payment_id is the ID of the original payment ID. For split-tender refunds, payment_id is the ID of the original tender. For exchange-based refunds (is_exchange == true), payment_id is the ID of the original payment ID even if the payment includes other tenders.[optional]
merchant_idString[optional]
is_exchangeBOOLEANIndicates whether or not the refund is associated with an exchange. If is_exchange is true, the refund reflects the value of goods returned in the exchange not the total money refunded.[optional]