Section
Defines a section in the plug-in configuration page. It is an associative array that contains the following parameters:
| Param name | Description | Type |
|---|---|---|
type
|
This must assume the |
string |
friendlyName
|
The section name. |
string |
items
|
An associative array, the keys of which are the name of the parameter and the values are the |
Param |
Param
Defines a configuration parameter in the plug-in configuration page. It is an associative array that contains the following parameters:
| Param name | Description | Type |
|---|---|---|
type
|
The parameter type. Valid values are:
|
string |
friendlyName
|
The name that will be displayed in the configuration page in the control panel. |
string |
options
|
(Optional) An array of values to be displayed in the combobox. This must be used when |
array |
size
|
(Optional) The data size limitation. | integer |
default
|
(Optional) The parameter default value. | string |
required
|
(Optional) This defines that the parameter is required and will be marked with a red star '*' in the plug-in configuration page. | boolean |
min
|
(Optional) The minimum parameter value. | integer |
max
|
(Optional) The maximum parameter value. | integer |
Environment
Contains the Billing environment information.
| Param name | Description | Type |
|---|---|---|
lang
|
The language (ISO_3166-1_alpha-2 code) configured in Billing (that is, the provider's location). | string |
system_host
|
The Billing hostname. | string |
|
|
The Billing URL that is used for returning back from the payment gateway site to the CloudBlue Commerce site. This URL is meant to be used in a redirect scenario when the customer's browser must be redirected back to the CloudBlue Commerce site. When the |
string |
return_url_ok
|
The Billing URL that is used for returning back from the payment gateway site to the CloudBlue Commerce site with the success status. This URL works similarly to the After a request is received though this URL, Billing assigns the |
string |
return_url_failed
|
The Billing URL that is used for returning back from the payment gateway site to the CloudBlue Commerce site with the failed status. This URL works similarly to the |
string |
|
|
The Billing URL that is used for receiving notifications from the payment gateway. It is designed to handle the server-to-server communication. This URL is meant to be used in the scenario where the payment gateway servers call Billing to notify an update in the Billing payment transaction status. When Billing receives a request through this URL, it calls the plug-in Callback method, which processes the data received in the request and sends back a response to Billing. Billing processes the response data accordingly and returns This URL is also used in the scenario where there is an interaction between a UI page in UX1 and the plugin. For details, see Modal Form Workflow. |
string |
return_url_3dsecure
|
The Billing URL that can be used for returning back from the 3D Secure gateway. This URL is meant to be used in the 3D Secure scenario. |
string |
AccountDetails
Accounts details.
| Param name | Description | Type | Notes |
|---|---|---|---|
id
|
The customer account identifier in Billing. | integer |
|
type
|
The account type:
|
integer |
|
is_corporate
|
A company or a personal account.
|
boolean |
|
name
|
The full account name. |
string |
|
billing_fname
|
The Billing contact's first name
|
string |
|
billing_mname
|
The Billing contact's middle name. |
string |
|
billing_lname
|
The Billing contact's last name. | string |
|
billing_email
|
The Billing contact's email address. | string |
|
billing_phone
|
The Billing contact's phone number. | PhoneInfo |
|
billing_fax
|
The Billing contact's fax number. | PhoneInfo |
|
tax_ex_number
|
The taxation number. |
string |
|
address_address1
|
The customer's first address. | string |
|
address_address2
|
The customer's second address. | string |
|
address_city
|
The customer's city. | string |
|
address_state
|
The customer's state in the short format. | string |
|
address_country
|
The customer's country in the short format. | string |
|
admin_fname
|
The administrative contact's first name. |
string | Filled when the account type is provider or reseller. |
admin_mname
|
The administrative contact's middle name. | string | |
admin_lname
|
The administrative contact's last name. | string | |
admin_email
|
The administrative contact's email address. | string | |
admin_phone
|
The administrative contact's phone number. |
PhoneInfo | |
admin_fax
|
The administrative contact's fax number. | PhoneInfo | |
technical_fname
|
The technical contact's first name. |
string | |
technical_mname
|
The technical contact's middle name. | string | |
technical_lname
|
The technical contact's last name. | string | |
technical_email
|
The technical contact's email address. | string | |
technical_phone
|
The technical contact's phone number. | PhoneInfo | |
technical_fax
|
The technical contact's fax number. | PhoneInfo |
DocumentInfo
The payment document description.
| Param name | Description | Type |
|---|---|---|
id
|
The document ID in Billing. | integer |
total
|
The total amount in the document (can be different from transaction_amount).
|
double |
currency
|
The document currency. | string |
description
|
The document description. | string |
PhoneInfo
| Param name | Description | Type |
|---|---|---|
country_code
|
The country code. |
string |
area_code
|
The area code. |
string |
number
|
The phone number. |
string |
extention
|
The phone extension. |
string |