Use this API to refund a payment. Call this API in the following form:

curl -v https://<instance> \
     -H 'Authorization: Bearer <access token>' \
     -H 'Content-Type: application/json' \
     -X POST \
     -d '{<arguments>}'

To get an access token, read here: Authentication


curl -v \
     -H 'Authorization: Bearer 00Dx0000000exxV!AXXXXXfcKqHB0czbxxxxxHkyo9gt41BxxxhWPxxZzaXxXxbAJxx9Ov4Hno..mu1Xi5XXXX8MWHVD81JVr6ShxxxxxorGv6Uy' \ 
     -H 'Content-Type: application/json' \ 
     -X POST \ 
     -d '{"trans_type":"Refund",


 "message":"Amount to refund must be greater than zero.",

is_successful (true/false) indicates if the payment was successfully refunded or not. Any error message will be listed in message.


  • trans_type – required, valid value is Refund
  • payment_id – required, the ID  of the payment record in Salesforce
  • refund_type – optional, valid values are Full or Partial
  • amount_to_refund – optional, if this is not provided the open amount will be refunded
  • refund_note – optional, any note that you want to go with the transaction


Was this article helpful?

Related Articles

Comments are closed.

  • About Us

    Founded in 2012, builds enterprise apps on the platform. We have created some of the most popular apps on the AppExchange in the payments and billing space.

  • Our Culture

    As a company, we believe in simple. So we build simple applications out of complex processes. We also provide unparalleled customer support because we truly believe that our customers' success is our success. Read more on what our customers say about us.
  • Check Our Customer Reviews

Copyright © 2020, Inc.
21151 S. Western Ave., Suite 215, Torrance, CA 90501, USA
All trademarks, trade names and logos appearing on the site are the property of their respective owners.
^ Back to Top