24/7 Support: 800.608.6482

Get Started

Navigation


OrderPayment_Capture

This function allows you to capture funds against an existing authorization.

Request Body Parameters

OrderPayment_ID Type:
Number
Title:
Order Payment Id
Payment Record to Capture aginst. It must be an open authorization (type 3). The OrderPayment_ID is returned in the OrderList_Load_Query Function.
Amount Type:
Number
Title:
Amount
Amount to capture. This can be any amount up to the totoal authorized amount.

Response Parameters

order_id Type:
Number
Title:
Order Id
Order Number
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 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 – 2019 Miva©, Miva Merchant©, MivaPay©, MivaCon© Miva, Inc. All Rights Reserved.