Dohtur at 13:40, 26 July 2016

2016-07-26T13:40:35Z

Dohtur at 10:24, 20 July 2016

2016-07-20T10:24:12Z

Dohtur: Created page with "Returns a list of payment configurations that are configured, enabled, and assigned to this online store/shopping cart. ===Request specification=== {| cellspacing="0" cellpa..."

2016-07-20T08:17:39Z

Created page with "Returns a list of payment configurations that are configured, enabled, and assigned to this online store/shopping cart. ===Request specification=== {| cellspacing="0" cellpa..."

New page

Returns a list of payment configurations that are configured, enabled, and assigned to this online store/shopping cart.

===Request specification===

{| cellspacing="0" cellpadding="2" border="1"
| colspan="1" | '''Field'''
| colspan="1" | '''Required'''
| colspan="1" | '''Type'''
| colspan="1" | '''Description'''
|-
| colspan="1" | target
| colspan="1" | Y
| colspan="1" | string, 128
| colspan="1" | Must equal payment_confs
|-
| colspan="1" | action
| colspan="1" | Y
| colspan="1" | string, 128
| colspan="1" | Must equal get
|-
| colspan="1" | api_version
| colspan="1" | Y
| colspan="1" | string
| colspan="1" | Must equal one of the following: 1.2, 1.3, 1.4, 1.5 etc.
|}
<br />

===Request example===

<pre>
<api_version>1.5</api_version>
<target>payment_confs</target>
<action>get</action>
</pre>
<br />

===Response specification===

{| cellspacing="0" cellpadding="2" border="1"
| colspan="1" | '''Field'''
| colspan="1" | '''Type'''
| colspan="1" | '''Description'''
|-
| colspan="1" | payment_module
| colspan="1" | container
| colspan="1" |
|-
| colspan="1" | payment_module/name
| colspan="1" | string
| colspan="1" | Name of the payment configuration, as set by the X-Payments admin
|-
| colspan="1" | payment_module/id
| colspan="1" | integer
| colspan="1" | Identifier of the payment configuration (autoincrement)
|-
| colspan="1" | payment_module/transactionTypes
| colspan="1" | container
| colspan="1" |
|-
| colspan="1" | payment_module/transactionTypes/sale
| colspan="1" | string
| colspan="1" | Whether the payment configuration allows "Sale" operation ("1" - allows, "" empty - doesn't allow)
|-
| colspan="1" | payment_module/transactionTypes/auth
| colspan="1" | string
| colspan="1" | Whether the payment configuration allows "Authorize only" operation ("1" - allows, "" empty - doesn't allow)
|-
| colspan="1" | payment_module/transactionTypes/capture
| colspan="1" | string
| colspan="1" | Whether the payment configuration allows "Capture" operation ("1" - allows, "" empty - doesn't allow)
|-
| colspan="1" | payment_module/transactionTypes/capturePart
| colspan="1" | string
| colspan="1" | Whether the payment configuration allows partial "Capture" operation ("1" - allows, "" empty - doesn't allow)
|-
| colspan="1" | payment_module/transactionTypes/captureMulti
| colspan="1" | string
| colspan="1" | Whether the payment configuration allows multiple "Capture" operations ("1" - allows, "" empty - doesn't allow)
|-
| colspan="1" | payment_module/transactionTypes/void
| colspan="1" | string
| colspan="1" | Whether the payment configuration allows "Void" operation ("1" - allows, "" empty - doesn't allow)
|-
| colspan="1" | payment_module/transactionTypes/voidPart
| colspan="1" | string
| colspan="1" | Whether the payment configuration allows partial "Void" operation ("1" - allows, "" empty - doesn't allow)
|-
| colspan="1" | payment_module/transactionTypes/voidMulti
| colspan="1" | string
| colspan="1" | Whether the payment configuration allows multiple "Void" operations ("1" - allows, "" empty - doesn't allow)
|-
| colspan="1" | payment_module/transactionTypes/refund
| colspan="1" | string
| colspan="1" | Whether the payment configuration allows "Refund" operation ("1" - allows, "" empty - doesn't allow)
|-
| colspan="1" | payment_module/transactionTypes/refundPart
| colspan="1" | string
| colspan="1" | Whether the payment configuration allows partial "Refund" operation ("1" - allows, "" empty - doesn't allow)
|-
| colspan="1" | payment_module/transactionTypes/refundMulti
| colspan="1" | string
| colspan="1" | Whether the payment configuration allows multiple "Refund" operations ("1" - allows, "" empty - doesn't allow)
|-
| colspan="1" | payment_module/transactionTypes/getInfo
| colspan="1" | string
| colspan="1" | Whether the payment configuration allows to receive information from the payment gateway ("1" - allows, "" empty - doesn't allow)
|-
| colspan="1" | payment_module/transactionTypes/accept
| colspan="1" | string
| colspan="1" | Whether the payment configuration allows "Accept" operation ("1" - allows, "" empty - doesn't allow)
|-
| colspan="1" | payment_module/transactionTypes/decline
| colspan="1" | string
| colspan="1" | Whether the payment configuration allows "Decline" operation ("1" - allows, "" empty - doesn't allow)
|-
| colspan="1" | payment_module/transactionTypes/test
| colspan="1" | string
| colspan="1" | Whether the payment configuration allows "Test" operation ("1" - allows, "" empty - doesn't allow)
|-
| colspan="1" | payment_module/authCaptureInfo
| colspan="1" | container
| colspan="1" |
|-
| colspan="1" | payment_module/authCaptureInfo/authExp
| colspan="1" | integer
| colspan="1" | How many days the transaction can stay in the Authorized status before being declined automatically
|-
| colspan="1" | payment_module/authCaptureInfo/captMinLimit
| colspan="1" | float
| colspan="1" | Minimum capture limit allowed by the payment gateway. Presented as a part of 1 (0 - no minimum limit, 0.2 - minimum 20% of authorized total, 0.5 - 50% of authorized total, etc.)
|-
| colspan="1" | payment_module/authCaptureInfo/captMaxLimit
| colspan="1" |
| colspan="1" | Maximum capture limit allowed by the payment gateway. Presented as a part of 1 (0 - no maximum limit, 0.5 - 50% of authorized total, 1 - 100% of authorized total, etc.)
|-
| colspan="1" | payment_module/moduleName
| colspan="1" | string
| colspan="1" | Default X-Payments name of the payment configuration
|-
| colspan="1" | payment_module/settingsHash
| colspan="1" | string
| colspan="1" | MD5 hash of the payment configuration settings
|-
| colspan="1" | payment_module/currency
| colspan="1" | string
| colspan="1" | 3-characters code of currency (ISO 4217). API v1.3 and later.
|-
| colspan="1" | payment_module/canSaveCards
| colspan="1" | string
| colspan="1" | Whether the payment configuration supports tokenization, i.e. customers' credit card can be saved on the payment gateway ("Y" - supports, "N" - doesn't support). API v1.3 and later.
|-
| colspan="1" | payment_module/class
| colspan="1" | string
| colspan="1" | Service field of the class name. It is unique for a payment module so it can be used to detect a certain payment gateway. E.g. XPay_Module_SagePayDirect for SagePay, XPay_Module_AuthorizeNet for Authorize.Net AIM, etc. API v1.4 and later.
|-
| colspan="1" | payment_module/isTestMode
| colspan="1" | string
| colspan="1" | Indicates if the payment configuration is configured in test mode ("Y" - test mode, "N" - live mode). API v1.4 and later.
|}
<br />

===Response example===

<pre>
<data>
<payment_module type="cell">
<name>First Data Global Gateway e4(SM) Web Service API</name>
<id>1</id>
<transactionTypes>
<sale>1</sale>
<auth>1</auth>
<capture>1</capture>
<capturePart>1</capturePart>
<captureMulti></captureMulti>
<void>1</void>
<voidPart></voidPart>
<voidMulti></voidMulti>
<refund>1</refund>
<refundPart>1</refundPart>
<refundMulti>1</refundMulti>
<getInfo></getInfo>
<accept></accept>
<decline></decline>
<test></test>
</transactionTypes>
<authCaptureInfo>
<authExp>30</authExp>
<captMinLimit>0</captMinLimit>
<captMaxLimit>1</captMaxLimit>
</authCaptureInfo>
<moduleName>First Data Payeezy Gateway (ex- Global Gateway e4)</moduleName>
<settingsHash>d41d8cd98f00b204e9800998ecf8427e</settingsHash>
<currency>USD</currency>
<canSaveCards>Y</canSaveCards>
<class>XPay_Module_FirstDataE4</class>
<isTestMode>Y</isTestMode>
</payment_module>
<payment_module type="cell">
<name>Chase Paymentech</name>
<id>2</id>
<transactionTypes>
<sale>1</sale>
<auth>1</auth>
<capture>1</capture>
<capturePart>1</capturePart>
<captureMulti></captureMulti>
<void>1</void>
<voidPart></voidPart>
<voidMulti></voidMulti>
<refund>1</refund>
<refundPart>1</refundPart>
<refundMulti></refundMulti>
<getInfo></getInfo>
<accept></accept>
<decline></decline>
<test></test>
</transactionTypes>
<authCaptureInfo>
<authExp>30</authExp>
<captMinLimit>0</captMinLimit>
<captMaxLimit>1</captMaxLimit>
</authCaptureInfo>
<moduleName>Chase Paymentech</moduleName>
<settingsHash>d41d8cd98f00b204e9800998ecf8427e</settingsHash>
<currency>USD</currency>
<canSaveCards>Y</canSaveCards>
<class>XPay_Module_Chase</class>
<isTestMode>Y</isTestMode>
</payment_module>
</data>
</pre>
<br />

← Older revision		Revision as of 13:40, 26 July 2016
Line 1:		Line 1:
		+	<noinclude>{{XP_API_TOC}}</noinclude>
	Returns a list of payment configurations that are configured, enabled, and assigned to this online store/shopping cart.		Returns a list of payment configurations that are configured, enabled, and assigned to this online store/shopping cart.

@@ Line 29: / Line 29: @@
 <pre>
-<api_version>1.5</api_version>
+<api_version>1.6</api_version>
 <target>payment_confs</target>
 <action>get</action>
@@ Line 117: / Line 117: @@
 | colspan="1" | string
 | colspan="1" | Whether the payment configuration allows "Test" operation ("1" - allows, "" empty - doesn't allow)
 |-
 | colspan="1" | payment_module/authCaptureInfo
@@ Line 165: / Line 169: @@
 <data>
    <payment_module type="cell">
-     <name>First Data Global Gateway e4(SM) Web Service API</name>
+     <name>X-Payments DEMO</name>
      <id>1</id>
      <transactionTypes>
        <sale>1</sale>
@@ Line 215: / Line 187: @@
        <decline></decline>
        <test></test>
      </transactionTypes>
      <authCaptureInfo>
@@ Line 221: / Line 194: @@
        <captMaxLimit>1</captMaxLimit>
      </authCaptureInfo>
-     <moduleName>Chase Paymentech</moduleName>
+     <moduleName>X-Payments DEMO</moduleName>
      <settingsHash>d41d8cd98f00b204e9800998ecf8427e</settingsHash>
      <currency>USD</currency>
      <canSaveCards>Y</canSaveCards>
-     <class>XPay_Module_Chase</class>
+     <class>XPay_Module_ADMINDEMO</class>
      <isTestMode>Y</isTestMode>
    </payment_module>
 </data>
 </pre>
 <br />

X-Payments:Payment configurations list request - Revision history

Dohtur at 13:40, 26 July 2016

Dohtur at 10:24, 20 July 2016

Dohtur: Created page with "Returns a list of payment configurations that are configured, enabled, and assigned to this online store/shopping cart. ===Request specification=== {| cellspacing="0" cellpa..."