24/7 Support: 800.608.6482

Navigation


ExternalRefund_Insert

This function allows you to create a refund payment record for an order in Miva. This is purely for reporting purposes and does not refund any acutual money.

This function allows your ERP system to push back refund data to Miva for accurate revenue reporting in Miva

Request Body Parameters

Store_Code Type:
String
Title:
Store Code
Required - Store Code
Function Type:
String
Title:
Function
Because this is a module defined funciton this value will always be "Module"
Module_Code Type:
String
Title:
Module Code
Code of the module which defines the function. Will always be "externalrefund" for this function
Module_Function Type:
Stringr
Title:
Module Function
Function Name you wish to execute. ExternalRefund_Insert for this function
Order_ID Type:
Number
Title:
Order ID
Miva Order ID
Amount Type:
Number
Title:
Amount to Refund
Amount of Money to refund.

Response Parameters

order_id Type:
Number
Title:
Order ID
Order ID
total_auth Type:
Number
Title:
Total Authorized
Total amount authorized on the order
formatted_total_auth Type:
String
Title:
Formatted Total Authorized
Currency Formatted Total Authorized
total_capt Type:
Number
Title:
Total Captured
Total Captured on Order
formatted_total_capt Type:
String
Title:
Formatted Total Captured
Currency Formatted Total Captured
total_rfnd Type:
Number
Title:
Total Refunded
Total amount refunded for the order
formatted_total_rfnd Type:
String
Title:
Formatted Total Refunded
Total amount refunded for the order
net_capt Type:
Number
Title:
Net Captured
Net Captured for Order
formatted_net_capt Type:
String
Title:
Formatted Net Captured
Currency Formatted Net Captured for Order

Example Request

Example Response

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

Copyright © 1997 – 2022 Miva©, Miva Merchant©, MivaPay©, MivaCon©, Camp Miva ℠, Miva, Inc. All Rights Reserved.