24/7 Support: 800.608.6482

Navigation


OrderPayment_VOID

This function allows you to void an order payment once an authorization has been made.

Voids must be for the entire payment record captured amount.

Request Body Parameters

OrderPayment_ID Type:
Number
Title:
Payment Id
Payment Record Id to void. Note: Only non-captured payments can be voided. (type 3). Once a payment has been captured it must be refunded using OrderPaymnet_Refund
Amount Type:
Number
Title:
Amount
Amount to Void. Number, not currency fomratted.

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_cap 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

Error Responses

error code
#Error#
error message
Order payment not found
  Order number not found.

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 – 2023 Miva©, Miva Merchant©, MivaPay©, MivaCon©, Camp Miva ℠, Miva, Inc. All Rights Reserved.