Difference between revisions of "X-Payments:Void authorized transaction request"

From X-Payments Help
Jump to: navigation, search
(Created page with "===Request specification=== {| cellspacing="0" cellpadding="2" border="1" | colspan="1" | '''Field''' | colspan="1" | '''Required''' | colspan="1" | '''Type''' | colspan="1"...")
 
m
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 +
<noinclude>{{XP_API_TOC}}</noinclude>
 
===Request specification===
 
===Request specification===
  
Line 56: Line 57:
 
| colspan="1" | string, 65536
 
| colspan="1" | string, 65536
 
| colspan="1" | Gateway transaction message
 
| colspan="1" | Gateway transaction message
 +
|-
 +
| colspan="1" | payment
 +
| colspan="1" | container
 +
| colspan="1" | (Only API 1.9) Container with [[X-Payments:Payment_information_request#PaymentInfoSpecification | Payment information]]
 
|}
 
|}
  

Latest revision as of 16:03, 24 April 2018

X-Payments API
  1. API versions supported
  2. Samples
  3. API requests
  4. API Requests from the store to X-Payments
    1. Admin area/X-Payments configuration
    2. Payment creation (Regular payment and tokenization)
    3. Payment information
    4. Actions on payments (secondary actions)
  5. Callback requests (web-hooks) from X-Payments to the store
  6. Browser-related
  7. Appendix A. Status codes.
  8. See also

Request specification

Field Required Type Description
target Y string, 128 Must equal payment
action Y string, 128 Must equal void
txnId Y string, 32 Unique payment ID
amount N currency Amount to void of the authorized transaction. By default equals to the amount of the authorized transaction
api_version Y string Must equal one of the following: 1.2, 1.3, 1.4, 1.5 etc.

Request example

<txnId>e7f398cee98ec062abac0d2c937da181</txnId>
<amount>50.00</amount>
<target>payment</target>
<action>void</action>

Response specification

Field Type Description
status integer, 1 Operation status code
message string, 65536 Gateway transaction message
payment container (Only API 1.9) Container with Payment information

Response example

<data>
<status>1</status>
<message>Success</message>
<error></error>
<error_message></error_message>
</data>
Retrieved from "https://www.x-payments.com/help/?title=X-Payments:Void_authorized_transaction_request&oldid=1509"