Processing Methods


Hosted Payment Page


https://uiservices.gr8pay.com/hosted/

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”.

  • Supports all transaction types
  • Multi-language – speak to your customers in their own language
  • 3D Secure capability
  • Cost savings – does not require an SSL certificate
  • Ensures merchants are compliant with scheme regulations (PCI DSS compliant solution)

Request Fields

FieldDescriptionMax LengthRequired 1
merchantIDYour 7 digits merchant number - #######7Yes
signatureSignature for verifying the authenticity of the request parameters.30Yes
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_amountAmount to be charge20Yes
(example: 199.95)
trans_currencyILS = Israel New Shekel3Yes
USD = US Dollar
EUR = Euro
GBP = UK Pound Sterling
AUD = Australian Dollar
CAD = Canadian Dollar
JPY = Japanese Yen
NOK = Norwegian Krone
PLN = Polski zloty
MXN = Mexican Peso
ZAR = South African Rand
RUB = Russian Ruble
TRY = Turkish lira
CHF = Swiss franc
INR = Indian rupee
DKK = Danish krone
SEK = Swedish krona
CNY = Chinese yuan
HUF = Hungarian forint
NZD = New Zealand dollar
HKD = Hong Kong dollar
KRW = South Korean won
SGD = Singapore dollar
THB = Thai baht
BSD = Bahamian Dollar
trans_type0 = Debit Transaction (Default when field is empty)1Yes
1 = Authorization only
trans_installmentsNumber of installments, 1 for regular transaction2Yes
trans_refNumUnique text used to defer one transaction from another100Optional
trans_commentOptional text used mainly to describe the transaction255Optional
trans_storePmSend value of 1 to save the payment method for future use if the transaction success1Optional
disp_payForText shown to buyer in payment window, Usually description of purchase (Cart description, Product name)40Optional
disp_paymentTypeList of payment types that are available to the client.80Optional
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_lngThe default language for the UI text in the window.5Optional
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_lngListSpecifies the language(s) available to user in the Language Selector in the window.5Optional
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_recurringSpecifies the deviations from the standard display of the recurring charges.3Optional
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_mobileSpecifies that the ui should be sized to small screen.3Optional
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_idavailable soon10Optional
client_AutoRegistrationSend value of 1 to create wallet for the customer if not already exist (match by email) and return the id of the wallet1Optional
notification_urlThe URL for notifying your system with the transaction result.255Optional
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_redirectThe URL to which the buyer’s browser is redirected to after completing the payment255Optional
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_noThe skin number to apply to the window opened by the request.2Optional
PLIDPlatform user ID - A unique identifier for the user on the platform100Optional

Automatic filling of form data:

client_fullNameCardholder full name50Optional
client_emailCardholder Email address50Optional
client_phoneNumCardholder phone number15Optional
client_idNumGovernment issued ID number9Optional
client_billAddress1Client billing address line 150Optional
client_billAddress2Client billing address line 250Optional
client_billCityClient billing city20Optional
client_billZipcodeClient billing zip code20Optional
client_billStateClient billing state in 2 char ISO code2Optional
client_billCountryClient billing country in 2 char ISO code2Optional

Recurring:

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:

  • Overall duration: 3 years
  • Number of stages: 4
  • Overall number of charges: 400

trans_recurringTypeSpecifies 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.
1Optional
trans_recurring1Parameter for first stage in the recurring series12Optional
trans_recurring2Parameter for second stage in the recurring series12Optional
trans_recurring3Parameter for third stage in the recurring series12Optional
trans_recurring4Parameter for fourth stage in the recurring series12Optional
trans_recurring5Parameter for fifth stage in the recurring series12Optional
trans_recurring6Parameter for sixth stage in the recurring series12Optional

User defined parameters:

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.

Response Fields

FieldDescription
replyCodeTransaction authorization (see list below)
replyDescReply description
trans_idTransaction number
trans_dateTransaction time and date
trans_amountA returned field from the request
trans_currencyA returned field from the request
trans_installmentsA returned field from the request
trans_refNumA returned field from the request
client_idA returned field from the request
client_wallet_idThe id of customer's wallet if request includes client_AutoRegistration=1
storage_idA returned storage_id if request includes trans_storePm=1
paymentDisplayDescription 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.
signatureSignature for verifying the authenticity of the Response parameters.
Field value used: replyCode + trans_id + PersonalHashKey

Refer to for detailed explanation.
client_fullNameCardholder full name 3
client_phoneNumCardholder phone number 3
client_emailCardholder Email address
recurringSeries_idRecurring series ID number (if recurring series has been created)

Reply Codes

000 = Authorized transaction
001 = Transaction accepted, waiting authorization
xxx = Transaction was not Authorized, see unauthorized comment explanation

Silent Post (Server to Server)

https://process.gr8pay.com/member/remote_charge.asp


Request Fields

FieldNameMandatory?Field TypeDescriptionSample
CompanyNumYesIntCompany number1234567
TransTypeYesStringTransaction type0
CcStorageIDNoIntWhen charging stored credit card, the ID of the stored card.876543210
CardNumYesIntCredit card number to be charged9 741 000 000 001 000
ExpMonthYesIntExpiration month (MM)9
ExpYearYesIntExpiration year (YYYY)2019
Track2NoIntTrack 2 of credit card number
MemberYesStringCardholder name as it appears on the cardJacob Smith
TypeCreditYesIntDebit, Instalment or Refund1
PaymentsYesIntNumber of Instalments1
AmountYesDecimalAmount to be Charged35.5
CurrencyYesIntCurrency Type10
CVV2N/AInt3-5 Digits from back of Card123
EmailN/AStringCardholder Email addressjacob@gmail.com
PersonalNumN/AStringCardholder Driver ID or Social Security Number8.70925E+12
DateOfBirthNoDateDate of birth of card holder19870925
format should be yyyyMMdd
PhoneNumberN/AStringCardholder phone number118881650
ClientIPN/AStringIP address of the client making the purchase192.168.0.25
BillingAddress1N/AString1st Address line178 Beyers Naude
BillingAddress2NoString2nd Address lineRisidale
BillingCityNoStringCity nameJhb
BillingZipCodeNoStringZip Code number2195
BillingStateNostringState - 2 character iso format
Required only when BillingCountry is US/CA.
BillingCountryNoStringCountry - 2 character iso formatZA
ConfirmationNumNoStringConfirmation number10810
OrderNoStringUnique Text used to defer one transaction from anotherZA10810
CommentNoStringOptional text used mainly to describe the transactionSpares
TransApprovalIDNoIntAuthorized transaction ID. Used to specify the initial pre-auth transaction ID2
when capturing pre-auth transaction (TransType = 2).
RefTransIDNoIntReference transaction ID. Used to specify the original transaction id1
when TypeCredit = 0 or when needed to complete missing transaction data.
TrmCodeNoIntWhen activated and applied in merchant config, this parameter selects the exact terminal to use8
CPMNoIntCustom 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
AutoCaptureHoursNoIntAuthorization 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.
RetURLNoString3D 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_urlNoStringThe 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.
StoreCcNoIntSpecifies, if the credit card should be stored in case of success:0
0 = Do not store the card (default)
1 = Store the card
AutoWalletRegistrationNoIntSend 1 to create new wallet for the customer using customer data and CC details. Wallet is created only in case of success.0
SignatureNostringSignature for verifying the authenticity of the request parameters.
Field values to use: CompanyNum + TransType + TypeCredit + Amount + Currency + CardNum + RefTransID + PersonalHashKey

3D Secure:

The 3D secure flow requires a redirect to the bank’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 3Dredirect field, before redirecting to the URL.

Custom Payment Methods

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 3Dredirect field,before redirecting to the URL.

CPMPayment methodType
143SkrillWallet/ Credit Card
144EcoPayzWallet
146UnionPayCredit Card
147NinjaWalletWallet
148CC RedirectCredit Card
114SofortOnline transfer
126NextPayWayWallet
113PaydentityCredit Card
140NeoSurfVoucher

Recurring:

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_recurringTypeSpecifies 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.
1Optional
trans_recurring1Parameter for first stage in the recurring series12Optional
trans_recurring2Parameter for second stage in the recurring series12Optional
trans_recurring3Parameter for third stage in the recurring series12Optional
trans_recurring4Parameter for fourth stage in the recurring series12Optional
trans_recurring5Parameter for fifth stage in the recurring series12Optional
trans_recurring6Parameter for sixth stage in the recurring series12Optional

Response Fields

FieldDescription
TransTypeTransaction type
ReplyReply code (see list below)
TransIDTransaction number
DateTransaction time and date
OrderTransaction id or order number that was supplied by merchant
AmountTransaction amount
PaymentsNumber of payments
CurrencyTransaction currency
ConfirmationNumConfirmation number
CommentComment as it was sent by the merchant
ReplyDescReply description
CCTypeCredit card brand name
DescriptorBank statement descriptor for this transaction
RecurringSeriesRecurring series number (only if recurring series has been created)
Last4Last four digits of the credit card number
CcStorageID 4The ID of the credit card in the Credit Card Storage
WalletIDThe ID of the newly created wallet for the customer
D3Redirectin case Reply=553 the client must be redirected to this address to complete the transaction.
signTypeat the moment, this value always equal to SHA256
Signaturea 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.

Reply Codes

000 = Authorized transaction
001 = Transaction accepted, waiting authorization
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