refund-payment-request.md

Refund Payment Request

Refunds a payment.

Structure

RefundPaymentRequest

Fields

Name	Type	Tags	Description	Getter
IdempotencyKey	String		A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see Idempotency keys.	String getIdempotencyKey()
AmountMoney	Money		Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.	Money getAmountMoney()
AppFeeMoney	Money	Optional	Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See Working with Monetary Amounts for more information.	Money getAppFeeMoney()
PaymentId	String		Unique ID of the payment being refunded.	String getPaymentId()
Reason	String	Optional	A description of the reason for the refund.	String getReason()

Example (as JSON)

{
  "idempotency_key": "a7e36d40-d24b-11e8-b568-0800200c9a66",
  "payment_id": "UNOE3kv2BZwqHlJ830RCt5YCuaB",
  "amount_money": {
    "amount": 100,
    "currency": "USD"
  }
}