24/7 Support: 800.608.6482

Navigation


Order_Authorize

This function allows you to authorize (or authorize+capture depending on gateway settings) a new transaction for an order.

Each Payment Gateway is going to have its own payment fields required to be passed.

Request Body Parameters

Order_ID Type:
Number
Title:
Order ID
ID of the Order to do the authorization against
Module_ID Type:
Number
Title:
Module ID
Module Id of the Payment Module to use for the transaction. The module_id is returned using: PaymentMethodList_Load
Amount Type:
Number
Title:
Amount
Amount to authorize. No currency sign.
Module_Data Type:
String
Title:
Module Data
Typically the Payment Method Code, but varies from Gateway to Gateway. The method code is returned using: PaymentMethodList_Load. For MivaPay customer level saved cards the Module_Data parameter is always "paymentcard:card_id". For MivaPay Order level saved cards the Module_Data parameter is always "orderpaymentcard:card_id"

Response Parameters

valid Type:
Boolean
Title:
Valid
true/false response whether the transaction was valid
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_capt 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 Requests

Miva Pay Example

Authorize.net (non-MivaPay) Example. Note: Each gateway will have their own specific required fields which need to be passed in this request.

Note: The response will contain information about all order transactions. If there were previous transactions against the order they will be reflected in the response as well.

Example Response

Copyright © 1997 – 2026 Miva®, Miva Merchant®, MivaPay Vault®, Camp Miva®, Miva Connect®, Vexture℠, Miva, Inc. All Rights Reserved.