GET
Retrieve payment methods by conditions

_cnd[name]
string 
Retrieve payment method by its name
_cnd[country]
string 
Retrieve payment method by country
_cnd[exCountry]
string 
Retrieve payment method by excluded country name
_cnd[moduleEnabled]
boolean 
Retrieve payment method by module enabled state
_cnd[added]
boolean 
Retrieve payment method by its added\not added state
_cnd[onlyPureOffline]
boolean 
Get only offline methods
_cnd[onlyModuleOffline]
boolean 
Get only offline methods (added by module)
_cnd[limit]
array 
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array 
Sets sorting order field
default Success <XLite\Model\Payment\Method>[] array
Sample response
[{"method_id":76,"service_name":"example","class":"example","moduleName":"example","orderby":84,"adminOrderby":59,"enabled":false,"moduleEnabled":false,"added":false,"type":"example","settings":[{"setting_id":"integer","name":"string","value":"string","payment_method":"<XLite\\Model\\Payment\\Method>"}],"fromMarketplace":false,"iconURL":"example","countries":["undefined"],"exCountries":["undefined"]}]

GET
Retrieve payment method by id

id
integer Required
Id value of the Method object
default Success <XLite\Model\Payment\Method>
Sample response
{"method_id":76,"service_name":"example","class":"example","moduleName":"example","orderby":84,"adminOrderby":59,"enabled":false,"moduleEnabled":false,"added":false,"type":"example","settings":[{"setting_id":"integer","name":"string","value":"string","payment_method":"<XLite\\Model\\Payment\\Method>"}],"fromMarketplace":false,"iconURL":"example","countries":["undefined"],"exCountries":["undefined"]}
method_id
integer
Payment method unique id
service_name
string
Method service name (gateway or API name)
class
string
Process class name
moduleName
string
Specific module family name
orderby
integer
Position
adminOrderby
integer
Position in popup
enabled
boolean
Enabled status
moduleEnabled
boolean
Module enabled status
added
boolean
Added status
type
string
Type
settings
[] array
Settings
fromMarketplace
boolean
Flag: 1 - method has been got from marketplace, 0 - method has been added after distr or module installation
iconURL
string
Payment method icon URL (used for methods from marketplace)
countries
anything[] array
Countries of merchant (merchants from these countries can sign up and use this method)
exCountries
anything[] array
Excluded countries (merchants from these countries cannot sign up for payment account)

PUT
Update payment method by id

id
integer Required
Id value of the Method object
<XLite\Model\Payment\Method>
method_id
integer
Payment method unique id
service_name
string
Method service name (gateway or API name)
class
string
Process class name
moduleName
string
Specific module family name
orderby
integer
Position
adminOrderby
integer
Position in popup
enabled
boolean
Enabled status
moduleEnabled
boolean
Module enabled status
added
boolean
Added status
type
string
Type
settings
[] array
Settings
fromMarketplace
boolean
Flag: 1 - method has been got from marketplace, 0 - method has been added after distr or module installation
iconURL
string
Payment method icon URL (used for methods from marketplace)
countries
anything[] array
Countries of merchant (merchants from these countries can sign up and use this method)
exCountries
anything[] array
Excluded countries (merchants from these countries cannot sign up for payment account)
default Success <XLite\Model\Payment\Method>
Sample response
{"method_id":76,"service_name":"example","class":"example","moduleName":"example","orderby":84,"adminOrderby":59,"enabled":false,"moduleEnabled":false,"added":false,"type":"example","settings":[{"setting_id":"integer","name":"string","value":"string","payment_method":"<XLite\\Model\\Payment\\Method>"}],"fromMarketplace":false,"iconURL":"example","countries":["undefined"],"exCountries":["undefined"]}
method_id
integer
Payment method unique id
service_name
string
Method service name (gateway or API name)
class
string
Process class name
moduleName
string
Specific module family name
orderby
integer
Position
adminOrderby
integer
Position in popup
enabled
boolean
Enabled status
moduleEnabled
boolean
Module enabled status
added
boolean
Added status
type
string
Type
settings
[] array
Settings
fromMarketplace
boolean
Flag: 1 - method has been got from marketplace, 0 - method has been added after distr or module installation
iconURL
string
Payment method icon URL (used for methods from marketplace)
countries
anything[] array
Countries of merchant (merchants from these countries can sign up and use this method)
exCountries
anything[] array
Excluded countries (merchants from these countries cannot sign up for payment account)