Skip to navigation

Quote Refund

Quotes the refund totals for a payment — subtotal, processing fee and total — without queuing the refund, so the dashboard can show the fee before the merchant confirms.

Authentication

OR
Authorizationstring
API Key authentication via header

Path parameters

paymentIdstringRequired
  • ID of the payment to quote a refund for

Query parameters

partialAmountdoubleOptional
  • Amount in cents to refund; omit to quote the full remaining amount

Response

Ok
subtotalobject
processorFeesobject
totalobject
ratedouble
resolutionobject
adjustmentobjectOptional