External Payment

Released in 10.05.00

The External Payment Module provides a single JSON endpoint which allows for external systems such ERP/Accounting (ex: Netsuite) to push back up refund data to Miva for reporting purposes.

For customers using an ERP system, it's common for the authorization/capture on the order to happen in Miva but any refunds to happen outside of Miva in the ERP. In these use cases, Miva never knows about the refund transaction so our revenue reporting data is inaccurate. With the External Refund payment module, any refund data can be pushed back to Miva, so our revenue data is as accurate as possible.

Some important things to note with this payment module:

• No actual money is being refunded. This module is used purely for ensuring accurate reporting.
• There are no settings for this module. It only enables a single JSON endpoint outlined below.
• If using this module/API you should not issues refunds directly in Miva. Doing so could cause the net captured amount to be negative.

Module Installation

The External Payment Module is installed under Payment Settings -> Add/Remove Modules . Search for the module and click Install .

External Refund Insert

ExternalRefund_Insert is the JSON function used to create a new payment record in a Miva order for a refund that occured outside of Miva.

{
    "Store_Code": "beta",
    "Function": "Module",
    "Module_Code": "externalrefund",
    "Module_Function": "ExternalRefund_Insert",
    "Order_ID" : "1003",
    "Amount" : "100.00"
 
}

Full API Docs for this function can be found here .

Payment Record

With each call of the funciton, a new payment record is created for the order. The IP Address of the remote system is saved with the record.