X-Payments:Payment configurations list request

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

Request specification

Field	Required	Type	Description
target	Y	string, 128	Must equal payment_confs
action	Y	string, 128	Must equal get
api_version	Y	string	Must equal one of the following: 1.2, 1.3, 1.4, 1.5 etc.

Request example

<api_version>1.6</api_version>
<target>payment_confs</target>
<action>get</action>

Response specification

Field	Type	Description
payment_module	container
payment_module/name	string	Name of the payment configuration, as set by the X-Payments admin
payment_module/id	integer	Identifier of the payment configuration (autoincrement)
payment_module/transactionTypes	container
payment_module/transactionTypes/sale	string	Whether the payment configuration allows "Sale" operation ("1" - allows, "" empty - doesn't allow)
payment_module/transactionTypes/auth	string	Whether the payment configuration allows "Authorize only" operation ("1" - allows, "" empty - doesn't allow)
payment_module/transactionTypes/capture	string	Whether the payment configuration allows "Capture" operation ("1" - allows, "" empty - doesn't allow)
payment_module/transactionTypes/capturePart	string	Whether the payment configuration allows partial "Capture" operation ("1" - allows, "" empty - doesn't allow)
payment_module/transactionTypes/captureMulti	string	Whether the payment configuration allows multiple "Capture" operations ("1" - allows, "" empty - doesn't allow)
payment_module/transactionTypes/void	string	Whether the payment configuration allows "Void" operation ("1" - allows, "" empty - doesn't allow)
payment_module/transactionTypes/voidPart	string	Whether the payment configuration allows partial "Void" operation ("1" - allows, "" empty - doesn't allow)
payment_module/transactionTypes/voidMulti	string	Whether the payment configuration allows multiple "Void" operations ("1" - allows, "" empty - doesn't allow)
payment_module/transactionTypes/refund	string	Whether the payment configuration allows "Refund" operation ("1" - allows, "" empty - doesn't allow)
payment_module/transactionTypes/refundPart	string	Whether the payment configuration allows partial "Refund" operation ("1" - allows, "" empty - doesn't allow)
payment_module/transactionTypes/refundMulti	string	Whether the payment configuration allows multiple "Refund" operations ("1" - allows, "" empty - doesn't allow)
payment_module/transactionTypes/getInfo	string	Whether the payment configuration allows to receive information from the payment gateway ("1" - allows, "" empty - doesn't allow)
payment_module/transactionTypes/accept	string	Whether the payment configuration allows "Accept" operation ("1" - allows, "" empty - doesn't allow)
payment_module/transactionTypes/decline	string	Whether the payment configuration allows "Decline" operation ("1" - allows, "" empty - doesn't allow)
payment_module/transactionTypes/test	string	Whether the payment configuration allows "Test" operation ("1" - allows, "" empty - doesn't allow)
payment_module/transactionTypes/getCard	string	Whether the payment configuration allows getting the updated information of a tokenized card from the gateway ("1" - allows, "" empty - doesn't allow)
payment_module/authCaptureInfo	container
payment_module/authCaptureInfo/authExp	integer	How many days the transaction can stay in the Authorized status before being declined automatically
payment_module/authCaptureInfo/captMinLimit	float	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.)
payment_module/authCaptureInfo/captMaxLimit		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.)
payment_module/moduleName	string	Default X-Payments name of the payment configuration
payment_module/settingsHash	string	MD5 hash of the payment configuration settings
payment_module/currency	string	3-characters code of currency (ISO 4217). API v1.3 and later.
payment_module/canSaveCards	string	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.
payment_module/class	string	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.
payment_module/isTestMode	string	Indicates if the payment configuration is configured in test mode ("Y" - test mode, "N" - live mode). API v1.4 and later.

Response example

<data>
  <payment_module type="cell">
    <name>X-Payments DEMO</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></refundMulti>
      <getInfo></getInfo>
      <accept></accept>
      <decline></decline>
      <test></test>
      <getCard>0</getCard>
    </transactionTypes>
    <authCaptureInfo>
      <authExp>30</authExp>
      <captMinLimit>0</captMinLimit>
      <captMaxLimit>1</captMaxLimit>
    </authCaptureInfo>
    <moduleName>X-Payments DEMO</moduleName>
    <settingsHash>d41d8cd98f00b204e9800998ecf8427e</settingsHash>
    <currency>USD</currency>
    <canSaveCards>Y</canSaveCards>
    <class>XPay_Module_ADMINDEMO</class>
    <isTestMode>Y</isTestMode>
  </payment_module>
  <error></error>
  <error_message></error_message>
  <is_error_message></is_error_message>
  <version>3.0.1</version>
</data>