|
|
|
|
get_saved_paymethod_list
The method provides a list of payment methods saved in Parallels Business Automation - Standard database the owner (customer) could choose from.
Parameters:
plugin_id |
A payment plug-in alphabetical ID internally used in Parallels Business Automation - Standard. |
account_id |
Numerical identifier (ID) of account owning a payment method. |
Returns:
PAYMETHOD_LIST =
{
paymethod_id => NUMBER,
name => STRING,
paytype => STRING,
paytype_id => STRING,
expire_date => STRING,
}
Note: The expire_date is returned for credit cards only.
SOAP Faults codes:
No specific codes.
get_plugin_list
The method provides a list of plug-ins available for payment.
No parameters.
Returns:
PLUGIN =
{
plugin_id => STRING,
title => STRING,
is_redirect => BOOLEAN,
has_form => BOOLEAN,
paymethod_category_titles => [STRING, ...],
description => STRING,
}
SOAP Faults codes:
No specific codes.
get_layout_hash
The method provides the form to be filled by customer in Store.
Parameters.
plugin_id |
A payment plug-in alphabetical ID internally used in Parallels Business Automation - Standard. |
account_id |
Numerical identifier (ID) of account owning a payment method. |
Returns:
LAYOUT =
{
form => STRING,
check_javascript => STRING,
param_list => [STRING, STRING, ... ],
}
SOAP Faults codes:
No specific codes.
get_redirect_hash
The method registers an attempt to pay by redirect or INIpay plug-in and returns back the redirect information.
Parameters:
plugin_id |
A payment plug-in alphabetical ID internally used in Parallels Business Automation - Standard. |
order_id |
Numerical identifier (ID) of an order. |
url_back |
Store URL a customer is to be redirected from an external payment gateway. |
Returns:
REDIRECT =
{
url => STRING,
method => STRING,
params => {param1 => STRING, param2 => STRING, ...}
onload_js_func => STRING,
content => STRING,
}
SOAP Faults codes:
No specific codes.
pay
The method registers an attempt to pay by direct plug-in and does nothing in case of redirect payment.
Parameters:
plugin_id |
A payment plug-in alphabetical ID internally used in Parallels Business Automation - Standard. |
order_id |
Numerical identifier (ID) of order. |
$paymethod_id |
For saved payment methods: a payment method numerical identifier (ID) assigned in Parallels Business Automation - Standard. |
$form_args |
Arguments for the form to be filled by a customer obtained from get_layout_hash. |
$fraud_query |
|
In case a new payment method has been submitted, the PHP Store picks up the form_args for pay() method from the param_list returned by the get_layout_hash method. In case a customer wants to use that payment method already saved in Parallels Business Automation - Standard database, the additional argument is paymethod_id. So, either paymethod_id or $form_args->{paytype_id} must be specified . The fraud_query are arguments gathered from client (if any) regarding anti-fraud check. The required fields are obtained via HSPC::API::Fraud->get_warning_newpaymethod.
get_status
The method returns the current status of a document in Parallels Business Automation - Standard Payment Processing.
Parameters:
order_id |
Numerical identifier (ID) of an order. |
Returns:
STATUS =
{
code => NUMBER,
string => STRING,
}
SOAP Faults codes:
No specific codes.