Interac® Online Transaction Initiation

URI Summary

Action	URI Template	URI Example	Non-URI Request	Response
POST	/v[M.m]/stores/{StoreID}/payments/interaconline/request/{TenderType}.{format}	/v1.0/stores/stores123/payments/interaconline/request/IO.xml	XML	200 + XML response

Request Example

Copy

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<InteracOnlineTransactionRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <OrderId>111111111</OrderId>
  <Amount currencyCode="CAD">123.45</Amount>
  <FundedUrl>http://lvsdevwsv02-01.us.gspt.net:1201/gsi-payment-service/interac-online/funded.html</FundedUrl>
  <NonFundedUrl>http://lvsdevwsv02-01.us.gspt.net:1201/gsi-payment-service/interac-online/non-funded.html</NonFundedUrl>
  <BillingFirstName>FName</BillingFirstName>
  <BillingLastName>LName</BillingLastName>
  <BillingAddress>
    <Line1>279 Yonge Street</Line1>
    <City>Toronto</City>
    <MainDivision>ON</MainDivision>
    <CountryCode>CA</CountryCode>
    <PostalCode>M5B 1N8</PostalCode>
  </BillingAddress>
  <BillingPhoneNo>1231231234</BillingPhoneNo>
  <CustomerEmail>customer@email.com</CustomerEmail>
  <Language>ENG</Language>
</InteracOnlineTransactionRequest>

Request Elements

Element	Optional/Required	Description	Type	Restriction
/InteracOnlineTransactionRequest/OrderId	Required	Unique identifier for the order. The client is responsible for ensuring uniqueness across all transactions the client initiates with this service.	String	Min 1 character Max 20 characters
/InteracOnlineTransactionRequest/Amount	Required	Total dollar value of the purchase. Format as 0.00 and max 9 digits total. This should represent the total of all taxes, shipping charges and other product/service costs as applicable. Includes currencyCode attribute that contains the 3-letter currency code of the money amount.	Decimal	Min 0.00 Max 9 digits Fraction 2 digits
/InteracOnlineTransactionRequest/FundedUrl	Required	Specify the funded url based on the webstore referrer set. This is where customer will receive redirection after successful auth stransaction call. This is the url configured on Interac online gateway by the merchant/webstore for whom transaction is being processed.	String
/InteracOnlineTransactionRequest/NonFundedUrl	Required	Specify the funded url based on the webstore referrer set. This is where customer will receive redirection after unsuccessful auth transaction call. This is the url configured on Interac online gateway by the merchant/webstore for whom transaction is being processed.	String
/InteracOnlineTransactionRequest/BillingFirstName	Required	Represents first name of the customer placing the order.	String	Max 32 characters
/InteracOnlineTransactionRequest/BillingLastName	Required	Represents last name of the customer placing the order.	String	Max 32 characters
/InteracOnlineTransactionRequest/BillingAddress	Required	Represents billing address of the customer placing the order. The street, city, state and country of a location. Line1, City, MainDivisionCode, PostalCode and CountryCode are required. Line2 is optional.	ComplexType	Line1 - max 70 characters Line2 - min 1, max 70 characters City - max 35 characters Main Division Code - max 2 characters Postal Code - max 15 characters Country Code - max 2 characters
/InteracOnlineTransactionRequest/BillingAddress/Line1	Required	The "Line1" components contain the street address and, if necessary, suite and building identifiers for the physical address.	String	Min 1 character Max 70 characters
/InteracOnlineTransactionRequest/BillingAddress/Line2	Optional	Address Line 2 of the Billing Address	String	Min 1 character Max 70 characters
/InteracOnlineTransactionRequest/BillingAddress/City	Required	City of the Billing Address	String	Max 35 characters
/InteracOnlineTransactionRequest/BillingAddress/MainDivision	Optional	Typically, a two- or three-digit postal abbreviation for the state or province. This does not necessarily conform to the ISO 3166-2 code.	String	Max 2 characters
/InteracOnlineTransactionRequest/BillingAddress/CountryCode	Required	Two-digit ISO country code conforming to ISO 3166 alpha 2. See:http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2	String	Max 2 characters
/InteracOnlineTransactionRequest/BillingAddress/PostalCode	Optional	Postal code of the Billing Address	String	Max 15 characters
/InteracOnlineTransactionRequest/BillingPhoneNo	Required	Customer phone number used for order follow-up.	String	Numbers 0-9 Max 20 Digits
/InteracOnlineTransactionRequest/CustomerEmail	Required	Email address used for sending automated email receipts.	String	Max 32 characters
/InteracOnlineTransactionRequest/Language	Optional	Display language for interac currently supports ENG (for English language) and FRE (for French language) which are in international standard ISO 639-2/3 format.	String	Max 3 characters

Response Example

Copy

<InteracOnlineTransactionReply xmlns:payment="http://schema.gsicommerce.com/payments/types/1.0/"
             xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <OrderId>111111111</OrderId>
  <ResponseCode>Success</ResponseCode>
  <InteracOnlineOrderId>220020</InteracOnlineOrderId>
  <RedirectHTML>%3CHTML%3E%3CHEAD%3E%3C%2FHEAD%3E%3CBODY%3E%3CFORM%20action%3D%22https%3A%2F%2Fweb%2Ena%2Ebambora%
            2Ecom%2FiOnlineEmulator%2Fgateway%2Easp%22%20method%3D%22POST%22%20id%3D%22frmIOnline%22%20name%3D%22frmIOnl
            ine%22%3E%3Cinput%20type%3D%22hidden%22%20name%3D%22IDEBIT%5FMERCHNUM%22%20%20value%3D%2212345678911%22%3E%3
            Cinput%20type%3D%22hidden%22%20name%3D%22IDEBIT%5FAMOUNT%22%20%20value%3D%2212345%22%3E%3Cinput%20type%3D%22
            hidden%22%20name%3D%22IDEBIT%5FTERMID%22%20value%3D%2212345678%22%3E%3Cinput%20type%3D%22hidden%22%20name%3D
            %22IDEBIT%5FCURRENCY%22%20value%3D%22CAD%22%3E%3Cinput%20type%3D%22hidden%22%20name%3D%22IDEBIT%5FINVOICE%22
            %20value%3D%22220020%22%3E%3Cinput%20type%3D%22hidden%22%20name%3D%22IDEBIT%5FMERCHDATA%22%20value%3D%226556
            D391%2D9063%2D4B7A%2DAC929708A7A9421D%22%3E%3Cinput%20type%3D%22hidden%22%20name%3D%22IDEBIT%5FFUNDEDURL%22%
            20value%3D%22http%3A%2F%2Flvsdevwsv02%2D01%2Eus%2Egspt%2Enet%3A1201%2Fgsi%2Dpayment%2Dservice%2Finterac%2Don
            line%2Ffunded%2Ehtml%3Ffunded%3D1%22%3E%3Cinput%20type%3D%22hidden%22%20name%3D%22IDEBIT%5FNOTFUNDEDURL%22%2
            0value%3D%22http%3A%2F%2Flvsdevwsv02%2D01%2Eus%2Egspt%2Enet%3A1201%2Fgsi%2Dpayment%2Dservice%2Finterac%2Donl
            ine%2Fnon%2Dfunded%2Ehtml%3Ffunded%3D0%22%3E%3Cinput%20type%3D%22hidden%22%20name%3D%22merchant%5Fname%22%20
            value%3D%22RadialInc%22%3E%3Cinput%20type%3D%22hidden%22%20name%3D%22referHost%22%20value%3D%22https%3A%2F%2
            Fweb%2Ena%2Ebambora%2Ecom%2Fscripts%2Fprocess%5Ftransaction%2Easp%22%3E%3Cinput%20type%3D%22hidden%22%20name
            %3D%22referHost2%22%20value%3D%22http%3A%2F%2FCHE%2D6S4TRC2%22%3E%3Cinput%20type%3D%22hidden%22%20name%3D%22
            referHost3%22%20value%3D%22%22%3E%3Cinput%20type%3D%22hidden%22%20name%3D%22IDEBIT%5FMERCHLANG%22%20value%3D
            %22en%22%3E%3Cinput%20type%3D%22hidden%22%20name%3D%22IDEBIT%5FVERSION%22%20value%3D%221%22%3E%3C%2FFORM%3E%
            3CSCRIPT%20language%3D%22JavaScript%22%3Edocument%2EfrmIOnline%2Esubmit%28%29%3B%3C%2FSCRIPT%3E%3C%2FBODY%3E
            %3C%2FHTML%3E</RedirectHTML>
 </InteracOnlineTransactionReply>

Response Elements

Element	Optional/Required	Description	Type	Restriction
/InteracOnlineTransactionReply/OrderId	Required	Unique identifier for the order. The client is responsible for ensuring uniqueness across all transactions the client initiates with this service.	String	Min 1 character Max 20 characters
/InteracOnlineTransactionReply/ResponseCode	Required	The result of the request transaction.	Enum	Fail/Success/Timeout
/InteracOnlineTransactionReply/InteracOnlineOrderId	Optional	Payment service generated unique order id submitted as 'trnOrderNumber' on Interac online 1^st transaction call. This is done as webstore might have dummy order id during the first call. During 1st transaction call, this id will be returned. Webstore has to return this id as part of 2nd auth call input. Payment service will use the same to link both the transactions.	String	Max 32 characters
/InteracOnlineTransactionReply/RedirectHTML	Optional	Encoded redirection response message returned from Interac online. Web store will redirect customer to mentioned page, so that customer can finish the bank authorization.	String
/InteracOnlineTransactionReply/ErrorDetail	Optional	Contains optional error information as returned from Interac online. If error field type is not mapped, then error text element might be used.	Complex Type
/InteracOnlineTransactionReply/ErrorDetail/ErrorMessage	Required	This field will return a relevant error message in case of failure.	String	Max 30 characters
/InteracOnlineTransactionReply/ErrorDetail/ErrorFields	Optional	Interac online can mention about specific field value having the problem. This is not supposed to accurate, as it might or might not specify for multiple values.	Enum	Can be any of the below OrderNumber/OrderAmount/ BillingName/BillingLine1/BillingCity/ BillingMainDivisionCode/BillingPostalCode /BillingCountryCode/BillingPhoneNo /CustomerEmail