Payments / Refund
Name | Payments Refund |
|---|---|
Description | Create a refund of an existing payment. |
Type | POST |
URL | /v9/payments/:id/refund |
Long Description
This action can be called on an existing payment to create a new reverse (refunded) payment of the same type. In the case of credit_card payments, it may void the existing transaction if it has not yet settled.
Parameters
Name | Description | Value Type | Required |
|---|---|---|---|
amount | Amount of the refund (only necessary if different from amount of original payment) | decimal | Optional |
Examples
Request | Response |
|---|---|
/v9/payments/332/refund |
|
{"amount":"20.00"} |
See Payments / Show Returns refunded transaction. |