Input Parameters Format

Name

Type

Structure

Description

environment

array

lang: provider's locale ("en", "de", "ru" etc)

notify_url: URL of Billing that can be used for notifications from the payment gateway

return_url: URL of Billing that can be used for returning back from the payment gateway site

return_url_ok: the same as above but contains the successful status of the redirect action

return_url_failed: the same as above but contains the failure status of the redirect action

return_url_3dsecure: URL of Billing that can be used for returning back from the 3D Secure gateway

This section contains system parameters: provider's locale and the set of predefined URLs used for redirects.

config

array

Name-values

Plug-in configuration parameters defined in %Plug-inName%_GetConfig() function.

ref_no

integer

 

Billing transaction identifier

transaction_amount

double

 

The amount of transaction

currency_iso

string

 

The currency of transaction amount in ISO format ("USD", "EUR" etc)

account_info

array

id: identifier of customer's account in Billing, integer

type: customer's account type ( 0 - provider, 2 - reseller, 3 - customer ), integer

is_corporate: company or personal account, boolean

name: full account name, string

billing_fname: billing first name, string

billing_mname: billing middle name, string

billing_lname: billing last name, string

billing_email: billing email, string

billing_phone: billing phone. Array of country_code, area_code, number, extention

billing_fax: billing phone. Array of country_code, area_code, number, extention

tax_ex_number: taxation number, string

address_address1: customer's address, string

address_address2: customer's address 2, string

address_city: customer's city, string

address_state: customer's state in short form, string

address_country: customer's country in short form, string

 

Additionally, the following fields are available for a company:

admin_fname: administrative contact first name, string

admin_mname: administrative contact middle name, string

admin_lname: administrative contact last name, string

admin_email: administrative contact email, string

admin_phone: administrative contact phone. Array of country_code, area_code, number, extention

admin_fax: administrative contact phone. Array of country_code, area_code, number, extention

technical_fname: technical contact first name, string

technical_mname: technical contact middle name, string

technical_lname: technical contact last name, string

technical_email: technical contact email, string

technical_phone: technical contact phone. Array of country_code, area_code, number, extention

technical_fax: technical contact phone. Array of country_code, area_code, number, extention

Account details

vendor_info

array

Structure is the same as for account_info

Provider's details

document_info

array

id: document ID in Billing

total: total amount in the document (can be different from transaction_amount), double

currency: currency of the document

description: description of the document, string

Payment document description

payment_method

array

Name-value pairs together with the following parameters:

transaction_initiator: the transaction initiator. Possible values:

transaction_category: the transaction category for merchant-initiated payments (relevant and available only for transaction_initiator = MIT). Possible values:

  • C: for Unscheduled Credential on File payments
  • R: for recurring payments (payments at regular intervals).

transaction_moto: the parameter that defines whether it is the MOTO transaction. Possible values:

  • true: for MIT payments on behalf of a customer
  • transaction_moto is not sent: for CIT payments and recurring or renewing MIT payments

 

Attributes of the previously saved payment method.

Contains name-value pairs returned by the ADD_NEW_METHOD parameter.

previous_transaction_data

array

Name-values

Data saved from the previous transaction.

Contains name-value pairs returned previously in the TRANSACTION_DETAILS array.

callback_params

array

Name-values

Data received from the payment gateway on returning back from the payment gateway site or in the notification from the payment gateway server.

Contains name-value pairs.