== transaction.init == ==== Description ==== Initialize transaction ==== Input Parameters ==== <table> <tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr> <tr><td>pp_type</td><td>(string)</td><td>yes</td><td>Payment processor type</td></tr> <tr><td>tracking_order</td><td>(int)</td><td>no</td><td>Order ID to be tracked on client app.</td></tr> <tr><td>tracking_user</td><td>(int)</td><td>yes</td><td>User ID to be tracked on client app.</td></tr> <tr><td>tracking_tag</td><td>(int)</td><td>yes</td><td>Tag ID to be tracked on client app.</td></tr> <tr><td>first_name</td><td>(string)</td><td>yes</td><td>First Name</td></tr> <tr><td>last_name</td><td>(string)</td><td>yes</td><td>Last Name</td></tr> <tr><td>zipcode</td><td>(string)</td><td>yes</td><td>User ZIP code</td></tr> <tr><td>country</td><td>(string)</td><td>yes</td><td>Country abbr.</td></tr> <tr><td>email</td><td>(string)</td><td>yes</td><td>User email address</td></tr> <tr><td>ip</td><td>(string)</td><td>yes</td><td>IP address from which user is making the transaction</td></tr> <tr><td>host</td><td>(string)</td><td>yes</td><td>Host form which user is making the transaction</td></tr> <tr><td>currency</td><td>(string)</td><td>yes</td><td>Currency abbr.</td></tr> <tr><td>order_type</td><td>(string)</td><td>no</td><td>Allowed values '' (empty string) and `xsale`. Determine if order is Cross Sale or not.</td></tr> <tr><td>return_url</td><td>(string)</td><td>no</td><td>Return URL (used for PayPal like PP's)</td></tr> <tr><td>cancel_url</td><td>(string)</td><td>no</td><td>Cancel URL (used for PayPal like PP's)</td></tr> <tr><td>items</td><td>(array)</td><td>yes</td><td>Array of items</td></tr> <tr><td>override</td><td>(int)</td><td>no</td><td>Used for [[ public/payment/overrides/ | Payment Processor Account Override]]</td></tr> <tr><td>override_tag</td><td>(int)</td><td>no</td><td>Used for [[ public/payment/overrides/ | Payment Processor Account Override]]</td></tr> <tr><td>override_type</td><td>(string)</td><td>no</td><td>Allowed values: '' (empty string) and `x-sales`. See [[ public/payment/overrides/ | Payment Processor Account Override]]</td></tr> </table> items <table> <tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr> <tr><td>trial_amount</td><td>float</td><td>no</td><td>Trial Amount</td></tr> <tr><td>trial_unit</td><td>string (day|week|month|year)</td><td>no</td><td>Trial unit</td></tr> <tr><td>trial_period</td><td>int</td><td>no</td><td>Trial period</td></tr> <tr><td>amount</td><td>float</td><td>yes</td><td>rebill amount</td></tr> <tr><td>rebill_unit</td><td>string (day|week|month|year)</td><td>yes</td><td>rebill unit</td></tr> <tr><td>rebill_period</td><td>int</td><td>yes</td><td>rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>yes</td><td>max rebill count (-1 unlimited)</td></tr> <tr><td>description</td><td>string</td><td>yes</td><td>Item description</td></tr> </table> ==== Return ==== <table> <tr><th>Name</th><th>Type</th><th>Description</th></tr> <tr><td>result</td><td>array</td><td>Result array with data</td></tr> </table> ==== Usage Example ==== See Quick Start Guide for usage examples

== transaction.init == ==== Description ==== Initialize transaction ==== Input Parameters ==== <table> <tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr> <tr><td>pp_type</td><td>(string)</td><td>yes</td><td>Payment processor type</td></tr> <tr><td>tracking_order</td><td>(int)</td><td>no</td><td>Order ID to be tracked on client app.</td></tr> <tr><td>tracking_user</td><td>(int)</td><td>yes</td><td>User ID to be tracked on client app.</td></tr> <tr><td>tracking_tag</td><td>(int)</td><td>yes</td><td>Tag ID to be tracked on client app.</td></tr> <tr><td>first_name</td><td>(string)</td><td>no</td><td>First Name</td></tr> <tr><td>last_name</td><td>(string)</td><td>no</td><td>Last Name</td></tr> <tr><td>zipcode</td><td>(string)</td><td>no</td><td>User ZIP code</td></tr> <tr><td>country</td><td>(string)</td><td>no</td><td>Country abbr.</td></tr> <tr><td>email</td><td>(string)</td><td>yes</td><td>User email address</td></tr> <tr><td>ip</td><td>(string)</td><td>yes</td><td>IP address from which user is making the transaction</td></tr> <tr><td>currency</td><td>(string)</td><td>yes</td><td>Currency abbr.</td></tr> <tr><td>order_type</td><td>(string)</td><td>no</td><td>Allowed values '' (empty string) and `xsale`. Determine if order is Cross Sale or not.</td></tr> <tr><td>initial_order_hash</td><td>(string)</td><td>no</td><td>Use only in case of order_type = 'xsale'. Put hash from transation.init response of initial/basic order</td></tr> <tr><td>return_url</td><td>(string)</td><td>no</td><td>Return URL (used for PayPal like PP's)</td></tr> <tr><td>cancel_url</td><td>(string)</td><td>no</td><td>Cancel URL (used for PayPal like PP's)</td></tr> <tr><td>items</td><td>(array)</td><td>yes</td><td>Array of items</td></tr> <tr><td>override</td><td>(int)</td><td>no</td><td>Used for [[ public/payment/overrides/ | Payment Processor Account Override]] DEPRECATED</td></tr> <tr><td>override_tag</td><td>(int)</td><td>no</td><td>Used for [[ public/payment/overrides/ | Payment Processor Account Override]] DEPRECATED</td></tr> <tr><td>pp_config</td><td>(array)</td><td>no</td><td>Merchand data params to override</td></tr> </table> items <table> <tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr> <tr><td>trial_amount</td><td>float</td><td>no</td><td>Trial Amount</td></tr> <tr><td>trial_unit</td><td>string (day|week|month|year)</td><td>no</td><td>Trial unit</td></tr> <tr><td>trial_period</td><td>int</td><td>no</td><td>Trial period</td></tr> <tr><td>amount</td><td>float</td><td>yes</td><td>rebill amount</td></tr> <tr><td>rebill_unit</td><td>string (day|week|month|year)</td><td>yes</td><td>rebill unit</td></tr> <tr><td>rebill_period</td><td>int</td><td>yes</td><td>rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>yes</td><td>max rebill count (-1 unlimited)</td></tr> <tr><td>description</td><td>string</td><td>yes</td><td>Item description</td></tr> </table> pp_config <table> <tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr> <tr><td>ppac_id</td><td>int</td><td>no</td><td>Merchant account id (defined for partner in payment app)</td></tr> <tr><td>force_acc</td><td>int</td><td>no</td><td>**Rocket Gate** specific, if set it will set appropriate merchantAccount parameter for API call to Rocket Gate</td></tr> <tr><td>force_mid</td><td>int</td><td>no</td><td>**Rocket Gate** specific, if set it will set appropriate merchantSiteID parameter for API call to Rocket Gate</td></tr> </table> ==== Return ==== <table> <tr><th>Name</th><th>Type</th><th>Description</th></tr> <tr><td>result</td><td>array</td><td>Result array with data</td></tr> </table> ==== Usage Example ==== See Quick Start Guide for usage examples 2019-05-20: Support for one-time subscriptions has been added (items with max_rebill_count = 0 and rebill_period > 0)

== transaction.init == ==== Description ==== Initialize transaction ==== Input Parameters ==== <table> <tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr> <tr><td>pp_type</td><td>(string)</td><td>yes</td><td>Payment processor type</td></tr> <tr><td>tracking_order</td><td>(int)</td><td>no</td><td>Order ID to be tracked on client app.</td></tr> <tr><td>tracking_user</td><td>(int)</td><td>yes</td><td>User ID to be tracked on client app.</td></tr> <tr><td>tracking_tag</td><td>(int)</td><td>yes</td><td>Tag ID to be tracked on client app.</td></tr> <tr><td>first_name</td><td>(string)</td><td>yesno</td><td>First Name</td></tr> <tr><td>last_name</td><td>(string)</td><td>yesno</td><td>Last Name</td></tr> <tr><td>zipcode</td><td>(string)</td><td>yesno</td><td>User ZIP code</td></tr> <tr><td>country</td><td>(string)</td><td>yesno</td><td>Country abbr.</td></tr> <tr><td>email</td><td>(string)</td><td>yes</td><td>User email address</td></tr> <tr><td>ip</td><td>(string)</td><td>yes</td><td>IP address from which user is making the transaction</td></tr> <tr><td>host</td><td>(string)</td><td>yes</td><td>Host form which user is making the transaction</td></tr> <tr><td>currency</td><td>(string)</td><td>yes</td><td>Currency abbr.</td></tr> <tr><td>order_type</td><td>(string)</td><td>no</td><td>Allowed values '' (empty string) and `xsale`. Determine if order is Cross Sale or not.</td></tr> <tr><td>initial_order_hash</td><td>(string)</td><td>no</td><td>Use only in case of order_type = 'xsale'. Put hash from transation.init response of initial/basic order</td></tr> <tr><td>return_url</td><td>(string)</td><td>no</td><td>Return URL (used for PayPal like PP's)</td></tr> <tr><td>cancel_url</td><td>(string)</td><td>no</td><td>Cancel URL (used for PayPal like PP's)</td></tr> <tr><td>items</td><td>(array)</td><td>yes</td><td>Array of items</td></tr> <tr><td>override</td><td>(int)</td><td>no</td><td>Used for [[ public/payment/overrides/ | Payment Processor Account Override]] DEPRECATED</td></tr> <tr><td>override_tag</td><td>(int)</td><td>no</td><td>Used for [[ public/payment/overrides/ | Payment Processor Account Override]] DEPRECATED</td></tr> <tr><td>override_type</td><td>(string)</td><td>no</td><td>Allowed values: '' (empty string) and `x-sales`. See [[ public/payment/overrides/ | Payment Processor Account Override]]pp_config</td><td>(array)</td><td>no</td><td>Merchand data params to override</td></tr> </table> items <table> <tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr> <tr><td>trial_amount</td><td>float</td><td>no</td><td>Trial Amount</td></tr> <tr><td>trial_unit</td><td>string (day|week|month|year)</td><td>no</td><td>Trial unit</td></tr> <tr><td>trial_period</td><td>int</td><td>no</td><td>Trial period</td></tr> <tr><td>amount</td><td>float</td><td>yes</td><td>rebill amount</td></tr> <tr><td>rebill_unit</td><td>string (day|week|month|year)</td><td>yes</td><td>rebill unit</td></tr> <tr><td>rebill_period</td><td>int</td><td>yes</td><td>rebill period</td></tr> <tr><td>max_rebill_count</td><td>int</td><td>yes</td><td>max rebill count (-1 unlimited)</td></tr> <tr><td>description</td><td>string</td><td>yes</td><td>Item description</td></tr> </table> pp_config <table> <tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th></tr> <tr><td>ppac_id</td><td>int</td><td>no</td><td>Merchant account id (defined for partner in payment app)</td></tr> <tr><td>force_acc</td><td>int</td><td>no</td><td>**Rocket Gate** specific, if set it will set appropriate merchantAccount parameter for API call to Rocket Gate</td></tr> <tr><td>force_mid</td><td>int</td><td>no</td><td>**Rocket Gate** specific, if set it will set appropriate merchantSiteID parameter for API call to Rocket Gate</td></tr> </table> ==== Return ==== <table> <tr><th>Name</th><th>Type</th><th>Description</th></tr> <tr><td>result</td><td>array</td><td>Result array with data</td></tr> </table> ==== Usage Example ==== See Quick Start Guide for usage examples 2019-05-20: Support for one-time subscriptions has been added (items with max_rebill_count = 0 and rebill_period > 0)