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