24/7 Support: 800.608.6482

Get Started

Navigation


OrderPayment_Refund

This function allows you to issue a refund against an existing captured payment record.

Note: Refunds can only apply to payments which have been captured (type 4 or type 5). Use OrderPayment_VOID to void a payment authorization. (type 3)

Request Body Parameters

OrderPayment_ID Type:
Number
Title:
Order Payment Id
Payment record to Refund. This is returned in the OrderList_Load_Query or OrderPaymentList_Load.
Amount Type:
Number
Title:
Amount
Amount to refund. Not currency fomratted. Note: The refund amount can only be up to the total amount captured.

Response Parameters

total_auth Type:
Number
Title:
Total Amount Authorized
Total Amount Authorized
formatted_total_auth Type:
String
Title:
Formatted Total Amount Authorized
Currency Formatted Total Amount Authorized
total_cap Type:
Number
Title:
Total Amount Captured
Total Amount Captured
formatted_total_cap Type:
String
Title:
Formatted Total Amount Captured
Currency Formatted Total Amount Captured
total_rfnd Type:
Number
Title:
Total Amount Refunded
Total Amount Refunded
formatted_total_rfnd Type:
String
Title:
Formatted Total Amount Refunded
Currency Formatted Total Amount Refunded
net_capt Type:
Number
Title:
Net Amount Captured
Total amount captured minus total amount refunded
formatted_net_capt Type:
String
Title:
Formatted Net Captured
Formatted total amount captured minus total amount refunded

Example Request

Example Response

Error Responses

error code
MER-JSN-PAY-00018
error message
Invalid transaction type
  A refund can only be applied to a payment type of 4 or 5.

This website uses cookies to identify visitors, track visitors to our website, store login session information and to remember your user preferences. By continuing to use this site you agree to our use of cookies. Learn More.

This website uses cookies. By continuing to use this site you agree to our use of cookies. Learn More.

Accept

Miva believes that all online businesses should have access to a scalable ecommerce platform that can meet their unique business requirements. Miva offers PCI compliant ecommerce, hosting, and custom website design and development solutions. Miva customers have processed over $100 billion in online sales since 1997.

Copyright © 2016 Miva, Inc - All Rights Reserved   Privacy Policy | Store Policy

Links
Contact Us
Receive Tips & Updates

Copyright © 2017 Miva, Inc - All Rights Reserved

Back To The Top