24/7 Support: 800.608.6482

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.
Passphrase Type:
String
Title:
Encryption Passphrase
optional. This is only needed if the client pas payment encryption enabled in the store.

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

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