Realex/Global Iris Gateway

This page details the inputs, secure inputs and outputs available for the Realex/Global Iris Logic Item, how to complete each field, and an external link to the Realex/Global Iris integration documentation.

PCI Pal must check any payment gateway integrations prior to going live. The documentation disclaimer (which applies throughout this guide) should be read before commencing any configuration of payment gateways.

Inputs

Input Fields	Required	Character Limits/ Required Input	Description
requestType	Yes	auth or refund	The request type, we support auth and refund
merchantId	Yes	Unique per client	The Client ID assigned by Realex Payments
account	Yes	30 chars	The sub-account for this request
orderid	Yes	40 chars	A unique ID to identify this request
amount	Yes	11 numericals	The amount should be in the smallest unit of the required currency For example: 2000 = £20
currency	Yes	32 chars	Standard currency codes are permitted, for example GBP or EUR
customerName	Yes	100 chars	The name on the card
authcode	No	10 chars	The authcode received from the voice authorisation centre or a similar alternative source
cardType	Yes	15 chars	Card type, full list can be found on the API documentation
presind	Yes	1 char	This is the presence indicator. It can take 4 values: 1: cvn present 2: cvn illegible 3: cvn not on card 4: cvn not requested
autosettleFlag	Yes	5 chars	The AutoSettle Flag allow merchants to specify whether they wish for the transaction to be added to the next settlement file ('1') or whether to just authorise the transaction and wait to actually deduct the funds from the customer ('0') until such a time that the transaction is settled. The 'MULTI' flag allows merchants to send settlement requests numerous times up to 115% of the original order value
secret	Yes	100 chars	Individual client secret, given by Realex
comment1	No	100 chars	Comment 1 (Optional)
comment2	No	80 chars	Comment 2 (Optional)
refundCode	No	50 chars	Should you wish to make a refund, client specific refund code will be given to you in order to take refunds

Secure Inputs

Input Fields	Required	Character Limits/ Required Input	Description
pan	Yes	19 Chars	Secure Input of the Card Number
expiryDate	Yes	4 Chars	Secure Input of the Card Expiry - in the format MMYY
csc	Yes	3 or 4 Chars	Secure Input of the Card CVN, either three or four digits long depending on the card.

Outputs

Output Fields	Description
merchantid	the merchantid which has been used to process the transaction.
account	The name of the account which is linked to the transaction by Realex.
orderid	Unique orderid which has been passed in on the original transaction request.
authcode	Relative to the authcode sent in the original transaction request.
result	Result code of the transaction, a successful transaction will respond with the code: 00.
cvnresult	The avs cvn result of the transaction, on the card cvn, the following results are expected: M: Matched N: Not Matched I: Not checked due to circumstances U: Not checked - issuer not certified P: Not Processed
avspostcoderesponse	The avs postcode result of the transaction, should it be checked, the following results are expected M: Matched N: Not Matched I: Problem with check U: Unable to check - Issuer not certified, for example P: Partial Match Available for US, CA and GB cardholders only.
avsaddressresponse	The avs address result of the transaction, should it be checked, the following results are expected M: Matched N: Not Matched I: Problem with check U: Unable to check - Issuer not certified, for example P: Partial Match Available for US, CA and GB cardholders only.
batchid	The batch ID of the transaction if it's set to Autosettle. Returned in the case of Authorisation and Refund requests. This can be used to assist with the reconciliation of your batches.
message	The text of the response from the Acquirer / Issuing Bank.
pasref	The payments reference for the transaction.
timetaken	Time taken to get a response back off the original transaction request.
bank	Returns the name of the bank which the card on the transaction links to.
country	Returns the country of the bank, relates to the bank which the card is linked to.
countrycode	Returns the country code of the bank, relates to the bank which the card is linked to.
region	The region the card was issued (e.g. US) Can be MEA (Middle East/Asia),LAT (Latin America), US (United States), EUR (Europe), CAN (Canada),A/P (Asia/Pacific).
sha1hash	Returns the sha1hash of the response from the payment.
errorMessage	PCI Pal Specific Error Message. If anything goes wrong in the sending of a request, our internal error handling will respond with a message on the output of the flow.

Realex Logic Item

The PayOn Logic Item contains the following properties:

Merchant ID

Your Client ID assigned by Realex Payments.

Top

Account

The sub-account for this request.

Top

Secret

The shared secret provided by Realex Payments.

Top

Success Code

Each gateway has its own unique selection of status codes on a request back from the gateway - for SagePay, these are:

00 - Successful – the transaction has been authorised successfully; the sale can proceed.

1xx - A failed transaction. Any 1xx code is treated as a failed transaction, the customer should either try again or try another payment method. Alternative flows based on specific codes could be created if required (for example, codes: 101 Declined by Bank – generally insufficient funds or incorrect card details (e.g. expiry date, card security code), 102 Referral to Bank (usually treated as a standard decline for ecommerce systems), 103 Card reported lost or stolen; may be indicative of attempted fraud 107 The transaction has been blocked as potentially fraudulent by fraud management configuration; 1xx Other reason, treat as a decline like 101).

2xx - Error with bank systems – generally advise the customer to try again later. The resolution time will depend on the issue.

3xx - Error with Realex Payments systems – generally advise the customer to try again later. The resolution time will depend on the issue.

5xx - Incorrect XML message formation or content. These are either development errors, configuration errors or customer errors. There is a large list, the most common issues are;

508 Issue with integration, e.g. incorrect account data provided. Check the message and correct;

509 Issue with customer supplied data, e.g. invalid characters. Check the message and correct; 5xx Issue with account configuration – contact Realex Payments support team to have this issue resolved. It is important to implement sufficient validation rules and test extensively so that the above errors can be avoided when processing live transactions so as not to impact sales.

666 - Account deactivated – your Realex Payments account has been suspended. Please contact Realex Payments.

This must be set in order for our internal logging processes to notice that the payment has returned with the expected response.

Top

Select Endpoint

For added security the Realex endpoints have been hardcoded into the integration. Test or Live needs to be selected from the Select Endpoint drop down list, depending on the transaction being conducted.

Top

Further information can be found by viewing the integration documentation:

Realex API Documentation