Payments / Refund

NamePayments Refund
DescriptionCreate a refund of an existing payment.
TypePOST
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
amountAmount of the refund (only necessary if different from amount of original payment)decimalOptional

 

Examples

RequestResponse
/v9/payments/332/refund 
{"amount":"20.00"}

 

See Payments / Show

Returns refunded transaction.