refund-payment-request.md

Refund Payment Request

Describes a request to refund a payment using RefundPayment.

Structure

Refund Payment Request

Fields

Name	Type	Tags	Description
idempotency_key	string	Required	A unique string that identifies this RefundPayment request. The key can be any valid string but must be unique for every RefundPayment request. For more information, see Idempotency. Constraints: Minimum Length: 1
amount_money	Money	Required	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.
app_fee_money	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.
payment_id	string	Required	The unique ID of the payment being refunded. Constraints: Minimum Length: 1
reason	string	Optional	A description of the reason for the refund. Constraints: Maximum Length: 192

Example (as JSON)

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