Refunds a payment.
Name | Type | Description | Notes |
---|---|---|---|
idempotency_key | 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. | |
amount_money | Money | The amount of money to refund. Cannot be more than the `total_money` value of the payment minus the total amount of all previously completed refunds for this payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See Working with monetary amounts for details. The currency code must match the currency associated with the business that is charging the card. | |
app_fee_money | Money | Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see Collect Fees | [optional] |
payment_id | String | Unique ID of the payment being refunded. | |
reason | String | A description of the reason for the refund. | [optional] |