| merchantID |
Your 7 digits merchant number - ####### |
7 |
Yes |
trans_amount
|
Amount to be charge
(example: 199.95)
|
20 |
Yes |
trans_currency
|
Supported Currencies can be found Here, in Server to Server mode you must send the Currency ID.
|
3 |
Yes |
| trans_type |
0 = Debit Transaction (Default when field is empty)
|
1 |
Yes |
| trans_installments |
Number of installments, 1 for regular transaction
|
2 |
Yes |
| trans_refNum |
Unique text used to defer one transaction from another |
100 |
Optional |
| trans_comment |
Optional text used mainly to describe the transaction |
255 |
Optional |
| trans_storePm |
Send value of 1 to save the payment method for future use if the transaction success |
1 |
Optional |
| disp_payFor |
Text shown to buyer in payment window, Usually description of purchase (Cart description, Product name) |
40 |
Optional |
| disp_paymentType |
List of payment types that are available to the client.
Available values are can be found Here.
Please use the abbreviation field from the list.
If more than one, use comma to separate the values.
(example: CC,ED)
|
80 |
Optional |
| disp_lng |
The default language for the UI text in the window.
If omitted, language is taken from user's browser settings.
Available values are:
he-IL = עברית (ישראל)
en-US = English (United States)
fr-FR = français (France)
es-ES = español (España, alfabetización internacional)
lt-LT= lietuvių (Lietuva)
ru-RU = русский (Россия)
de-DE = Deutsch (Deutschland)
zh = 中文
|
5 |
Optional |
| disp_lngList |
Specifies the language(s) available to user in the Language Selector in the window.
Available values are:
all = all languages are available (default if the field is empty or omitted)
hide = the language selector is hidden
comma-separated list of codes for enabling specific language(s).
For example, disp_lngList=en-us,it-it
will allow user to switch between English and Italian, and disp_lngList=en-us will show English only.
The available languages are listed in the disp_lng field description.
|
5 |
Optional |
| disp_recurring |
Specifies the deviations from the standard display of the recurring charges.
Available values are:
0 = standard display (default if the field is empty or omitted)
1 = hide the number of charges in the last stage of the recurring series
|
3 |
Optional |
| Layout |
Selects how the Flow payment page (ui_version=11) arranges its content.
Every other template ignores this field.
Available values are:
1 = single column (default if the field is empty or omitted)
2 = two columns on a wide screen. The order details, cart, amount options and payment method list sit on one side, and the payment form on the other. On a narrow screen it falls back to the single column layout automatically, so it is safe to send on mobile traffic.
3 = full width. The page fills whatever space it is given instead of being capped and centred, for merchants who frame it in their own iframe and set the width there. The border around the form is not drawn in this mode.
4 = the Iframe design's look, applied to this template: a 600 pixel sheet with a soft shadow, and underlined input fields with the label above them, rather than the boxed fields of layout 1. Useful for merchants moving over from the Iframe template who want the form to keep looking familiar.
|
1 |
Optional |
| background |
Background colour for the payment page, as a hex value (for example #eef2f7 or eef2f7).
The form itself stays white and is given a thin border and rounded corners, so it reads as a sheet on top of the colour.
Only the Flow design (ui_version=11) uses this field. If the value is not a hex colour it is ignored and the default background is used.
|
9 |
Optional |
| show_chrome |
true/false - controls whether the payment page shows its surrounding furniture.
true = normal page (default if the field is empty or omitted).
false = the header (merchant logo and language selector), the footer (security marks and brand line) and the order details are all hidden, leaving the payment form and the pay button.
Amount, shipping and installment selectors are NOT hidden, because the customer still has to answer them.
Only the Flow design (ui_version=11) uses this field.
|
5 |
Optional |
notification_url
|
The URL for notifying your system with the transaction result.
Must include http:// or https://.
|
255 |
Optional |
url_redirect
|
The URL to which the buyer’s browser is redirected to after completing the payment
Must include http:// or https://.
|
255 |
Optional |
| PLID |
Platform user ID - A unique identifier for the user on the platform |
100 |
Optional |
| client_fullName
|
Cardholder full name |
50 |
Optional |
| client_email
|
Cardholder Email address |
50 |
Optional |
| client_phoneNum
|
Cardholder phone number |
15 |
Optional |
| client_idNum
|
Government issued ID number |
9 |
Optional |
|
| client_billAddress1
|
Client billing address line 1 |
50 |
Optional |
| client_billAddress2
|
Client billing address line 2 |
50 |
Optional |
| client_billCity
|
Client billing city |
20 |
Optional |
| client_billZipcode
|
Client billing zip code |
20 |
Optional |
| client_billState |
Client billing state in 2 char ISO code |
2 |
Optional |
| client_billCountry |
Client billing country in 2 char ISO code |
2 |
Optional |
| terms_url |
Send the link to your terms and conditions and it will be presented to the payer during the transaction |
100 |
Optional |
| show_edit |
Sending "false" will hide the Edit button and the payer wont be able to able the personal details that were sent as part of the transaction |
10 |
Optional |
| show_marketing |
Sending "false" will hide the Marketing concent button and the payer wont see the marketing concent text |
10 |
Optional |
| ExpiredOn |
Set the time, in EPOCH format, you wish for the hosted page session to expire at. Please note: the system timezone is GMT so your calculation should be in GMT. to learn more visit ExpiredOn |
10 |
Optional |
| CustomRoute |
This param allows you to send the custom route id as provided to you by support - this will give you control to which routing configuration to send the transaction - please note that if no such route is configured you will get a 503 - Decline indicating your have no configuration matching this transaction |
10 |
Optional |
| signature |
Signature for verifying the authenticity of the request parameters.
Field values to use: All parameters in the order they appear in the request, first GET then POST + PersonalHashKey.
more information can be found at the Signature section in this page
|
30 |
Yes |