Custom Parameters
You can send up to 10 additional parameters as individual key-value pairs.
The values will be stored so that they can be returned in Inquiry Actions and be visible in the Virtual Terminal’s Order Details view.
Please refer to the element AdditionalRequestParamaters in the XSD file.
Additional parameters for Fraud Detect
In case you use the Fraud Detect product and want to pass mobile device details for the scoring, you need to pass these with the following parameter naming:
• deviceRiskId
• deviceRiskAPIKey
• deviceRiskHost
The following represents an example of a Sale transaction with Fraud Detect special custom parameters:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ipg="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:v1="http://ipgonline.com/ipgapi/schemas/v1">
<soapenv:Header/>
<soapenv:Body>
<ipg:IPGApiOrderRequest>
<!--You have a CHOICE of the next 2 items at this level-->
<v1:Transaction>
<!--You have a CHOICE of the next 9 items at this level-->
<v1:CreditCardTxType>
<!--Optional:-->
<v1:StoreId>120995000</v1:StoreId>
<v1:Type>sale</v1:Type>
</v1:CreditCardTxType>
<!--You have a CHOICE of the next 2 items at this level-->
<!--Optional:-->
<v1:CreditCardData>
<v1:CardNumber>4257********0111</v1:CardNumber>
<v1:ExpMonth>12</v1:ExpMonth>
<v1:ExpYear>27</v1:ExpYear>
<v1:CardCodeValue>XXX</v1:CardCodeValue>
</v1:CreditCardData>
<!--Optional:-->
<v1:Payment>
<v1:ChargeTotal>10.00</v1:ChargeTotal>
<v1:Currency>GBP</v1:Currency>
</v1:Payment>
<v1:TransactionDetails>
<v1:AdditionalRequestParameters>
<v1:keyValuePair>
<v1:key>deviceRiskId</v1:key>
<v1:value>********</v1:value>
</v1:keyValuePair>
<v1:keyValuePair>
<v1:key>deviceRiskHost</v1:key>
<v1:value>*********</v1:value>
</v1:keyValuePair>
<v1:keyValuePair>
<v1:key>deviceRiskAPIKey</v1:key>
<v1:value>************</v1:value>
</v1:keyValuePair>
<v1:keyValuePair>
<v1:key>deviceIntelligenceVendor</v1:key>
<v1:value>**********************</v1:value>
</v1:keyValuePair>
<v1:keyValuePair>
<v1:key>deviceIntelligenceSessionID</v1:key>
<v1:value>**********************</v1:value>
</v1:keyValuePair>
</v1:AdditionalRequestParameters>
<v1:TransactionOrigin>ECI</v1:TransactionOrigin>
</v1:TransactionDetails>
<v1:Billing>
<v1:CustomerID>C001</v1:CustomerID>
<v1:Name>Max Mustermann</v1:Name>
<v1:Company>BCompany</v1:Company>
<v1:Address1>Hellersbergstraße</v1:Address1>
<v1:City>Frankfurt</v1:City>
<v1:State>Hessen</v1:State>
<v1:Zip>12345</v1:Zip>
<v1:Country>DEU</v1:Country>
<v1:Phone>01522113356</v1:Phone>
<v1:Email>[email protected]</v1:Email>
</v1:Billing>
<v1:Shipping>
<v1:Name>Max Mustermann</v1:Name>
<v1:Address1>407,Gilpin Drive</v1:Address1>
<v1:Address2>407,Gilpin Drive2</v1:Address2>
<v1:City>Frankfurt</v1:City>
<v1:State>Hessen</v1:State>
<v1:Zip>12345</v1:Zip>
<v1:Country>DEU</v1:Country>
<v1:Phone>1234567890</v1:Phone>
</v1:Shipping>
</v1:Transaction>
</ipg:IPGApiOrderRequest>
</soapenv:Body>
</soapenv:Envelope>
In case you want to pass other than mobile device details. You can do so, it is possible to pass i.e. also device intelligence details and more. As a reference please check this section where you can find further information: Fraud Detect
Updated about 2 months ago
