Menu
Hosted Payments Page is suitable for all web sites that need to process credit card payments in real-time.
We host and manage the payment page, which is secured by its own SSL certificate and customizable via an online wizard.
Suited to all sizes of merchants, it is highly cost effective and operates on an extremely robust infrastructure.
Supports 3D verification with authentication of “Verified by Visa” and “MasterCard SecureCode”.
| Field | Description | Max Length | Required 1 |
|---|---|---|---|
| merchantID | Your 7 digits merchant number – ####### | 7 | Yes |
| signature | Signature for verifying the authenticity of the request parameters. | 30 | Yes |
| 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 | |||
| trans_amount | Amount to be charge | 20 | Yes |
| (example: 199.95) | |||
| trans_currency | ILS = Israel New Shekel (0) | 3 | Yes |
| USD = US Dollar (1) | |||
| EUR = Euro (2) | |||
| GBP = UK Pound Sterling (3) | |||
| AUD = Australian Dollar (4) | |||
| CAD = Canadian Dollar (5) | |||
| JPY = Japanese Yen (6) | |||
| NOK = Norwegian Krone (7) | |||
| PLN = Polski zloty (8) | |||
| MXN = Mexican Peso (9) | |||
| ZAR = South African Rand (10) | |||
| RUB = Russian Ruble (11) | |||
| TRY = Turkish lira (12) | |||
| CHF = Swiss franc (13) | |||
| INR = Indian rupee (14) | |||
| DKK = Danish krone (15) | |||
| SEK = Swedish krona (16) | |||
| CNY = Chinese yuan (17) | |||
| HUF = Hungarian forint (18) | |||
| NZD = New Zealand dollar (19) | |||
| HKD = Hong Kong dollar (20) | |||
| KRW = South Korean won (21) | |||
| SGD = Singapore dollar (22) | |||
| THB = Thai baht (23) | |||
| BSD = Bahamian Dollar (24) | |||
| trans_type | 0 = Debit Transaction (Default when field is empty) | 1 | Yes |
| 1 = Authorization only | |||
| 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. | 80 | Optional |
| Available values are can be found here: Payment Methods. | |||
| This list is using the abbreviation field from the payment method list. Multiple values can be specified by using comma as a separator. | |||
| (example: CC,EC) | |||
| disp_lng | The default language for the UI text in the window. | 5 | Optional |
| 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 = 中文 | |||
| disp_lngList | Specifies the language(s) available to user in the Language Selector in the window. | 5 | Optional |
| 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. | |||
| disp_recurring | Specifies the deviations from the standard display of the recurring charges. | 3 | Optional |
| 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 | |||
| disp_mobile | Specifies that the ui should be sized to small screen. | 3 | Optional |
| Available values are: | |||
| auto = auto detect if the client device has small screen | |||
| true = show small size UI for small screens | |||
| false = shows normal UI | |||
| client_id | available soon | 10 | Optional |
| client_AutoRegistration | Send value of 1 to create wallet for the customer if not already exist (match by email) and return the id of the wallet | 1 | Optional |
| notification_url | The URL for notifying your system with the transaction result. | 255 | Optional |
| Must include http:// or https://. | |||
| This parameter can be configured in Hosted Page V.2 under the Management section. If specified in the request, overrides the configured value. | |||
| url_redirect | The URL to which the buyer’s browser is redirected to after completing the payment | 255 | Optional |
| Must include http:// or https://. | |||
| This parameter can be configured in under the Management section. If specified in the request, overrides the configured value. | |||
| skin_no | The skin number to apply to the window opened by the request. | 2 | Optional |
| PLID | Platform user ID – A unique identifier for the user on the platform | 100 | Optional |
See Recurring information for detailed description and for some useful examples.
Notice: The customer can see the recurring series description containing the charge amount and the number of charges for each stage. If the number of charges in the last stage is 99, that number will not appear in the description.
The recurring series is subject to the following configurable limitations:
| trans_recurringType | Specifies transaction type for subsequent transactions. Does not affect the initial transaction. Accepts the same values as trans_type. If omitted, all the subsequent transactions will be of the same type as the initial transaction. | 1 | Optional |
| trans_recurring1 | Parameter for first stage in the recurring series | 12 | Optional |
| trans_recurring2 | Parameter for second stage in the recurring series | 12 | Optional |
| trans_recurring3 | Parameter for third stage in the recurring series | 12 | Optional |
| trans_recurring4 | Parameter for fourth stage in the recurring series | 12 | Optional |
| trans_recurring5 | Parameter for fifth stage in the recurring series | 12 | Optional |
| trans_recurring6 | Parameter for sixth stage in the recurring series | 12 | Optional |
You can append your own fields to the request.
These fields will be stored during the request processing and returned with the reply.
Use this to transfer more information to your url_redirect and url_notify pages.
| Field | Description |
|---|---|
| replyCode | Transaction authorization (see list below) |
| replyDesc | Reply description |
| trans_id | Transaction number |
| trans_date | Transaction time and date |
| trans_amount | A returned field from the request |
| trans_currency | A returned field from the request |
| trans_installments | A returned field from the request |
| trans_refNum | A returned field from the request |
| client_id | A returned field from the request |
| client_wallet_id | The id of customer’s wallet if request includes client_AutoRegistration=1 |
| storage_id | A returned storage_id if request includes trans_storePm=1 |
| paymentDisplay | Description of the payment method used in the transaction. For credit cards, the description consists of the card type and the last four digits of the card number. For bank transfers, the description consists of the platform name and the last four digits of the account. |
| signature | Signature for verifying the authenticity of the Response parameters. Field value used: replyCode + trans_id + PersonalHashKey Refer to for detailed explanation. |
| client_fullName | Cardholder full name 3 |
| client_phoneNum | Cardholder phone number 3 |
| client_email | Cardholder Email address |
| recurringSeries_id | Recurring series ID number (if recurring series has been created) |
000 = Authorized transaction
001 = Transaction accepted, pending authorization
553 = Transaction is pending 3Ds response
xxx = Transaction was not Authorized, see unauthorized comment explanation
| FieldName | Mandatory? | Field Type | Description | Sample | |
|---|---|---|---|---|---|
| CompanyNum | Yes | Int | Company number | 1234567 | |
| TransType | Yes | String | Transaction type | 0 | |
| CcStorageID | No | Int | When charging stored credit card, the ID of the stored card. | 876543210 | |
| CardNum | Yes | Int | Credit card number to be charged | 9 741 000 000 001 000 | |
| ExpMonth | Yes | Int | Expiration month (MM) | 9 | |
| ExpYear | Yes | Int | Expiration year (YYYY) | 2019 | |
| Track2 | No | Int | Track 2 of credit card number | ||
| Member | Yes | String | Cardholder name as it appears on the card | Jacob Smith | |
| TypeCredit | Yes | Int | Debit, Instalment or Refund | 1 | |
| Payments | Yes | Int | Number of Instalments | 1 | |
| Amount | Yes | Decimal | Amount to be Charged | 35.5 | |
| Currency | Yes | Int | Currency Type | 10 | |
| CVV2 | Yes | Int | 3-5 Digits from back of Card | 123 | |
| N/A | String | Cardholder Email address | jacob@gmail.com | ||
| PersonalNum | N/A | String | Cardholder Driver ID or Social Security Number | 8.70925E+12 | |
| DateOfBirth | No | Date | Date of birth of card holder | 19870925 | |
| format should be yyyyMMdd | |||||
| PhoneNumber | N/A | String | Cardholder phone number | 118881650 | |
| ClientIP | N/A | String | IP address of the client making the purchase | 192.168.0.25 | |
| BillingAddress1 | N/A | String | 1st Address line | 178 Beyers Naude | |
| BillingAddress2 | No | String | 2nd Address line | Risidale | |
| BillingCity | No | String | City name | Jhb | |
| BillingZipCode | No | String | Zip Code number | 2195 | |
| BillingState | No | string | State – 2 character iso format | ||
| Required only when BillingCountry is US/CA. | |||||
| BillingCountry | No | String | Country – 2 character iso format | GB | |
| ConfirmationNum | No | String | Confirmation number | 10810 | |
| Order | No | String | Unique Text used to defer one transaction from another | ZA10810 | |
| Comment | No | String | Optional text used mainly to describe the transaction | Spares | |
| TransApprovalID | No | Int | Authorized transaction ID. Used to specify the initial pre-auth transaction ID | 2 | |
| when capturing pre-auth transaction (TransType = 2). | |||||
| RefTransID | No | Int | Reference transaction ID. Used to specify the original transaction id | 1 | |
| when TypeCredit = 0 or when needed to complete missing transaction data. | |||||
| TrmCode | No | Int | When activated and applied in merchant config, this parameter selects the exact terminal to use | 8 | |
| CPM | No | Int | Custom Payment Method – in case you wish to use one of the custom payment methods, such as Skrill(143) / EcoPayz(144) / Union Pay(146) / NinjaWallet (147)/ CC Redirect (148) / Sofort (114) / NextPayWay (126) this field must be sent – in order to complete the initial integration you must first implement the 3D redirect workflow – the Custom payment method will return a Redirect URL to which you will be requested to redirect the user. | 4 | |
| AutoCaptureHours | No | Int | Authorization only (TransType=1), the number of hours to wait before automatic capture is carried out. | 1 | |
| If omitted, the authorized transaction will not be captured automatically. | |||||
| RetURL | No | String | 3D secure only, In cases where 553 is returned. the client should be redirected to bank’s site. when the interaction with bank is done, the client is redirected to this URL. | 553 | |
| notification_url | No | String | The callback URL you wish our servers to update at the end of each transaction, this can passed either via the MCP or via this field. | ||
| StoreCc | No | Int | Specifies, if the credit card should be stored in case of success: | 0 | |
| 0 = Do not store the card (default) | |||||
| 1 = Store the card | |||||
| AutoWalletRegistration | No | Int | Send 1 to create new wallet for the customer using customer data and CC details. Wallet is created only in case of success. | 0 | |
| Signature | No | string | Signature for verifying the authenticity of the request parameters. | ||
| Field values to use: CompanyNum + TransType + TypeCredit + Amount + Currency + CardNum + RefTransID + PersonalHashKey | |||||
The 3D secure flow requires a redirect to the bank’s window, to simulate that, send the amount of 55.30 in any currency, the response that will be given will be ReplyCode=553 which means Pending transaction. The response will include a Pending transaction ID along with the URL to redirect the window to.
Remember you will need to URLdecode the URL, in the D3redirect field, before redirecting to the URL.
The CPM secure flow requires a redirect to the provider’s window, to simulate that, send the amount of 55.3 in any currency, the response that will be given will be ReplyCode=553 which means Pending transaction, the response will include the Pending transaction ID along with the URL to redirect the window to.
Remember you will need to URLdecode the URL, in the D3redirect field, before redirecting to the URL.
| CPM | Payment method | Type |
|---|---|---|
| 143 | Skrill | Wallet/ Credit Card |
| 144 | EcoPayz | Wallet |
| 146 | UnionPay | Credit Card |
| 147 | NinjaWallet | Wallet |
| 148 | CC Redirect | Credit Card |
| 114 | Sofort | Online transfer |
| 126 | NextPayWay | Wallet |
| 113 | Paydentity | Credit Card |
| 140 | NeoSurf | Voucher |
See Recurring information for detailed description and for some useful examples. Pay attention: recurring series is limited in time. The maximum duration is 10 years.
| trans_recurringType | Specifies transaction type for subsequent transactions. Does not affect the initial transaction. Accepts the same values as trans_type. If omitted, all the subsequent transactions will be of the same type as the initial transaction. | 1 | Optional |
| trans_recurring1 | Parameter for first stage in the recurring series | 12 | Optional |
| trans_recurring2 | Parameter for second stage in the recurring series | 12 | Optional |
| trans_recurring3 | Parameter for third stage in the recurring series | 12 | Optional |
| trans_recurring4 | Parameter for fourth stage in the recurring series | 12 | Optional |
| trans_recurring5 | Parameter for fifth stage in the recurring series | 12 | Optional |
| trans_recurring6 | Parameter for sixth stage in the recurring series | 12 | Optional |
| Field | Description |
|---|---|
| TransType | Transaction type |
| Reply | Reply code (see list below) |
| TransID | Transaction number |
| Date | Transaction time and date |
| Order | Transaction id or order number that was supplied by merchant |
| Amount | Transaction amount |
| Payments | Number of payments |
| Currency | Transaction currency |
| ConfirmationNum | Confirmation number |
| Comment | Comment as it was sent by the merchant |
| ReplyDesc | Reply description |
| CCType | Credit card brand name |
| Descriptor | Bank statement descriptor for this transaction |
| RecurringSeries | Recurring series number (only if recurring series has been created) |
| Last4 | Last four digits of the credit card number |
| CcStorageID 4 | The ID of the credit card in the Credit Card Storage |
| WalletID | The ID of the newly created wallet for the customer |
| D3Redirect | in case Reply=553 the client must be redirected to this address to complete the transaction. |
| signType | at the moment, this value always equal to SHA256 |
| Signature | a base64, urlEncoded, SHA256 of response values: to regenerate the value: 1. long_values_string = Reply + TransID + Order + Amount + Currency 2. urlEncode(base64(sha256( (long_values_string) + (merchant HashKey) ))) |
TransType=0&Reply=000&TransID=12345&Date=01/01/2000 00:00:01 &Order=A1234&Amount=10.99&Payments=1&Currency=0&ConfirmationNum=0123456 &Comment=White box&ReplyDesc=SUCCESS&CCType=VISA&Descriptor=abc ltd.
000 = Authorized transaction
001 = Transaction accepted, waiting authorization
553 = Transaction is pending 3Ds response
xxx = Transaction was not Authorized, see unauthorized comment explanation
(1) Some field requirements are dependent on merchant configuration and can be change on your request
(2) First option is default when field is empty
(3) This field must be omitted when charging stored credit card (TransType=3)
(4) This field is relevant only when Credit Card Storage service is enabled in the merchant account