Refund an Amount

Refund an amount to a payment method. Note that this functionality is disabled by default due to the increased risk of fraud. You should always use the regular Refund Payment endpoint. If you have a legitimate business need for open refunds, please discuss your requirements with our support team.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
required
0 to 999999999

Amount in smallest currency unit, eg: cents, including all surcharges, taxes etc.

int32
0 to 999999999

This is assumed to already be included in the amount.

int32
0 to 999999999

This is assumed to already be included in the amount. (Available for Elavon processing only)

uint32
0 to 999999999

Tax value included in total amount. Sales tax in the US, or PST for Canadian merchants. In smallest currency units, eg: cents in USD. This is assumed to already be included in the amount.

string
required

The authorization value for the payment you are operating on.

terminal
object
required

Which terminal to process the transaction through. Terminal determines currency and language.

payment_method
required
customer
object
reference
object

Merchant defined values which can be used to internally identify the transaction.

soft_descriptor
object

Override business information which would normally appear on a customer's statement, making it easier for customers to identify transactions.

options
object
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json