Implementing Standalone Risk Assessment Integration
If you are enabled for Standalone Risk Assessment, you can trigger a specific response recommendation (response.recommendation) using a specific value in the Order Description field in the request.
Details
| Order Description | Recommendation |
|---|---|
| riskAssessmentResultAccept | ACCEPT |
| riskAssessmentResultReject | REJECT |
Create or Update Risk Assessment
The Create or Update Risk Assessment operation is used to send a card transaction to a risk service provider without processing a payment in the CommWeb payment gateway.
Example: Create or Update Risk Assessment
Request
| URL | https://paymentgateway.commbank.com.au/api/rest/version/100/merchant/XXXXXX/riskassessment/6b3b263f-2d5a-4650-80be-70910a04bv54 |
| HTTP method | PUT |
{
"correlationId": "RC_correlationId_StandAloneRisk",
"apiOperation": "CREATE_OR_UPDATE_RISK_ASSESSMENT",
"requestAction": "RISK_ASSESSMENT",
"cruise": {
"passenger": [
{
"middleName": "Boat",
"folioNumber": "123456789",
"firstName": "Cruisey",
"lastName": "McCruiseFace",
"title": "Mr"
},
{
"middleName": "Cruise",
"title": "Mrs",
"firstName": "Boaty",
"lastName": "McBoatFace",
"folioNumber": "987654321"
}
],
"company": {
"contact": {
"companyPhone": "451231231",
"customerServicePhone": "4351231231"
}
},
"travelAgentCode": "code1234",
"departurePort": {
"address": {
"country": "AUS",
"city": "Brisbane",
"postCodeZip": "4008",
"street2": "Adjacent to Kangroo Drive",
"stateProvinceCode": "QLD",
"street": "12 Wallaby Way"
}
},
"returnDate": "2023-02-02",
"departureDate": "2010-07-09",
"shipName": "BigBoat",
"bookingReference": "XYZ1234",
"travelAgentName": "Johnny Johnson",
"travelPackageItems": "CRUISE_ONLY"
},
"shipping": {
"address": {
"city": "Pittsburgh",
"country": "USA",
"street": "1 Horse St",
"street2": "Adjacent to Koala park",
"stateProvince": "Pennsylvania",
"postcodeZip": "15106",
"company": "Horse Co Ltd."
},
"contact": {
"firstName": "Peanut",
"phone": "45741111",
"email": "test@test.mastercard.com",
"mobilePhone": "485631111",
"lastName": "Butter"
},
"method": "PICKUP"
},
"order": {
"item": [
{
"category": "abc",
"unitPrice": "3",
"name": "iphone",
"brand": "apple",
"quantity": "2",
"sku": "iphone 320"
},
{
"name": "boots",
"category": "footwear",
"sku": "111988",
"quantity": "1",
"brand": "MYER",
"unitPrice": "50"
}
],
"description": "riskAssessmentResultAccept",
"amount": "1550",
"cashbackAmount": "10.23",
"discount": {
"code": "SEPT-100",
"amount": "500"
},
"merchantCategoryCode": "4148",
"currency": "USD",
"subMerchant": {
"marketplaceId": "1234",
"identifier": "A",
"tradingName": "Mastercard",
"address": {
"city": "Pune",
"country": "IND",
"postcodeZip": "411052",
"stateProvince": "MH",
"street": "Line1",
"street2": "Line2",
"company": "Mastercard"
},
"bankIndustryCode": "6789",
"email": "test@test.com",
"phone": "98765432211",
"governmentCountryCode": "IND",
"registeredName": "Mastercard",
"disputeContactPhone": "2233445577"
}
},
"airline": {
"ticket": {
"issue": {
"address": "address1",
"date": "2020-10-04",
"travelAgentName": "Agent1",
"carrierName": "carrierName1",
"country": "AUS",
"carrierCode": "q1/321",
"travelAgentCode": "trv1Code1",
"city": "NSW"
},
"totalFare": "132.2",
"totalTaxes": "10.32",
"conjunctionTicketIndicator": "true",
"totalFees": "43.1",
"ticketNumber": "ticketNumber1",
"taxOrFee": [
{
"amount": "182.52",
"type": "TT1"
}
],
"restricted": "false",
"eTicket": "true",
"exchangedTicketNumber": "ticketNumA24"
},
"itinerary": {
"leg": [
{
"departureTax": "20.5",
"destinationArrivalDate": "2020-10-04",
"carrierCode": "a1/123",
"flightNumber": "AIR1",
"travelClass": "Y",
"fare": "113.23",
"stopoverPermitted": "true",
"conjunctionTicketNumber": "conjunction1",
"fareBasis": "fareBasis1",
"destinationAirport": "MEL",
"taxes": "42.3",
"departureTime": "14:22:22Z",
"endorsementsRestrictions": "endorsements1",
"departureDate": "2020-10-04",
"destinationArrivalTime": "15:22:22Z",
"departureAirport": "SYD",
"fees": "65.8",
"couponNumber": "1",
"exchangeTicketNumber": "exchangeTicket1"
},
{
"fare": "280.13",
"travelClass": "F",
"destinationArrivalTime": "18:48:22Z",
"endorsementsRestrictions": "endorsements2",
"flightNumber": "AIR2",
"fareBasis": "fareBasis2",
"couponNumber": "2",
"taxes": "59.98",
"departureAirport": "MEL",
"destinationAirport": "BNE",
"exchangeTicketNumber": "exchangeTicket2",
"conjunctionTicketNumber": "conjunction2",
"departureTax": "12.1",
"carrierCode": "a2/456",
"fees": "71.83",
"stopoverPermitted": "false",
"departureTime": "18:48:22Z",
"departureDate": "2020-10-04"
}
],
"originCountry": "AUS",
"numberInParty": "12"
},
"bookingReference": "bookingRef123",
"passenger": [
{
"firstName": "John",
"middleName": "Jones",
"lastName": "Smith",
"title": "title1",
"frequentFlyerNumber": "frequentFlyerNumber1",
"specificInformation": "specificInformation1"
},
{
"middleName": "Parker",
"firstName": "Adams",
"title": "title2",
"lastName": "Sarah",
"specificInformation": "specificInformation2"
}
],
"planNumber": "1B",
"documentType": "ADDITIONAL_COLLECTION",
"transactionType": "TICKET_PURCHASE"
},
"sourceOfFunds": {
"provided": {
"card": {
"nameOnCard": "Peanut Butter Jam",
"number": "***************",
"expiry": {
"year": "**",
"month": "**"
},
"securityCode": "***"
}
},
"type": "CARD"
},
"cardScheme ": "MC",
"device": {
"mobilePhoneModel": "SAMSUNG 20S",
"ipAddress": "34.99.20.52",
"browser": "CHROM 5.4.4.4.4",
"fingerprint": "ffhshgsgsgjf;sd;kvndkjgnlnlznvndnkbgbxfgbkdsgkbdjgkbdbgdbgnmdgbmndbgmdbgmkbdkfkwfghkjsabfxzbfkjsfklsbsbsbfksbvfmnscbsmkfksfksbvkfh"
},
"transaction": {
"creationDate": "2020-10-04T05:02:03.002Z",
"source": "CARD_PRESENT",
"url": "https://www.mastercard.com.au/Home",
"type": "AUTHORIZATION"
},
"transactionProcessingResponse": {
"rrn": "2221",
"authorizationMethod": "OFFLINE_AFTER_ONLINE_FAILURE",
"stan": "12",
"transationReceipt": "005124566456",
"transationAuthenticationStatus": "Y"
},
"customer": {
"phone": "485631111",
"email": "test2@test.mastercard.com",
"mobilePhone": "401678394",
"customer.firstname": "Jon",
"customer.lastname": "Doe"
},
"billing": {
"address": {
"postcodeZip": "15106",
"street2": "Adjacent To Cat St",
"city": "Pittsburgh",
"country": "USA",
"street": "1 Horse St",
"stateProvince": "Pennsylvania",
"company": "Horse Co Ltd."
}
},
"agreement": {
"type": "RECURRING"
},
"authentication": {
"3ds": {
"acsEci": "07"
},
"3ds2": {
"acsEci": "07",
"transactionStatus": "J",
"statusReasonCode": "88",
"protocolVersion": "abcde"
}
},
"posTerminal": {
"address": {
"city": "Little Whinging",
"company": "Howards",
"country": "WWW",
"postcodeZip": "44444",
"stateProvince": "NKL",
"street": "The Cupboard",
"street2": "Under the Stairs"
},
"attended": "ATTENDED",
"cardPresenceCapability": "CARD_PRESENT",
"cardholderActivated": "MPOS_ACCEPTANCE_DEVICE",
"inputCapability": "BARCODE",
"lane": "SA_Risk",
"location": "MERCHANT_TERMINAL_ON_PREMISES",
"mobile": {
"cardInputDevice": "INTEGRATED_DONGLE"
},
"onlineReasonCode": "RANDOM_SELECTION_BY_TERMINAL",
"panEntryMode": "CHIP",
"pinEntryCapability": "PIN_PAD_INOPERATIVE",
"pinLengthCapability": "4",
"serialNumber": "SARiskPosTerm"
}
}
Response
Response with recommendation: ACCEPT
{
"correlationId": "RC_correlationId_StandAloneRisk",
"id": "70001",
"provider": {
"name": "Emulator WithClearPiiFields",
"riskAssessmentRequestId": "hdxP6OmJQw6p3_JdwK300A"
},
"recommendation": "ACCEPT",
"result": "SUCCESS",
"totalScore": -20
}
Response with recommendation: REJECT
{
"correlationId": "RC_correlationId_StandAloneRisk",
"id": "85477c82-17f2-4e11-9e60-0565",
"provider": {
"name": "EMULATORWITHCLEARPIIFIELDS",
"riskAssessmentRequestId": "aU3srGX4ShWmIA74nKqPIg"
},
"recommendation": "REJECT",
"result": "SUCCESS",
"rule": [
{
"id": "Test Rule 2",
"name": "Emulator Reject 14382",
"score": 25
},
{
"id": "Test Rule 47",
"name": "Emulator Reject 33090",
"score": 71
},
{
"id": "Test Rule 53",
"name": "Emulator Reject 81665",
"score": 24
}
],
"totalScore": 81
}
Request
| URL | https://paymentgateway.commbank.com.au/api/rest/version/100/merchant/XXXXXX/riskassessment/6b3b263f-2d5a-4650-80be-70910a04bv54 |
| HTTP method | PUT |
{
"correlationId": "RC_correlationId_StandAloneRisk",
"apiOperation": "CREATE_OR_UPDATE_RISK_ASSESSMENT",
"requestAction": "INFORMATION_ONLY",
"cruise": {
"passenger": [
{
"middleName": "Boat",
"folioNumber": "123456789",
"firstName": "Cruisey",
"lastName": "McCruiseFace",
"title": "Mr"
},
{
"middleName": "Cruise",
"title": "Mrs",
"firstName": "Boaty",
"lastName": "McBoatFace",
"folioNumber": "987654321"
}
],
"company": {
"contact": {
"companyPhone": "451231231",
"customerServicePhone": "4351231231"
}
},
"travelAgentCode": "code1234",
"departurePort": {
"address": {
"country": "AUS",
"city": "Brisbane",
"postCodeZip": "4008",
"street2": "Adjacent to Kangroo Drive",
"stateProvinceCode": "QLD",
"street": "12 Wallaby Way"
}
},
"returnDate": "2020-10-04",
"shipName": "BigBoat",
"bookingReference": "ref54",
"travelAgentName": "Johnny Johnson",
"travelPackageItems": "CRUISE_ONLY"
},
"shipping": {
"address": {
"city": "Pittsburgh",
"country": "USA",
"street": "1 Horse St",
"street2": "Adjacent to Koala park",
"stateProvince": "Pennsylvania",
"postcodeZip": "15106",
"company": "Horse Co Ltd."
},
"contact": {
"firstName": "Peanut",
"phone": "45741111",
"email": "test@test.mastercard.com",
"mobilePhone": "485631111",
"lastName": "Butter"
},
"method": "PICKUP"
},
"order": {
"item": [
{
"category": "apparel",
"unitPrice": "1500",
"name": "t-shirt",
"brand": "MYER",
"quantity": "1",
"sku": "111657"
},
{
"name": "boots",
"category": "footwear",
"sku": "111988",
"quantity": "1",
"brand": "MYER",
"unitPrice": "50"
}
],
"description": "riskAssessmentResultUpdateReject",
"amount": "1550",
"cashbackAmount": "10.23",
"discount": {
"code": "SEPT-100",
"amount": "500"
},
"currency": "USD"
},
"sourceOfFunds": {
"provided": {
"card": {
"nameOnCard": "Peanut Butter Jam",
"expiry": {
"year": "21",
"month": "10"
},
"securityCode": "258"
}
},
"type": "CARD"
},
"device": {
"mobilePhoneModel": "SAMSUNG 20S",
"ipAddress": "34.99.20.52",
"browser": "CHROM 5.4.4.4.4",
"fingerprint": "ffhshgsgsgjf;sd;kvndkjgnlnlznvndnkbgbxfgbkdsgkbdjgkbdbgdbgnmdgbmndbgmdbgmkbdkfkwfghkjsabfxzbfkjsfklsbsbsbfksbvfmnscbsmkfksfksbvkfh"
},
"transaction": {
"creationDate": "2020-10-04T05:02:03.002Z",
"source": "CARD_PRESENT",
"url": "https://www.mastercard.com.au/Home",
"type": "AUTHORIZATION"
},
"customer": {
"phone": "485631111",
"email": "test2@test.mastercard.com",
"mobilePhone": "401678394"
},
"billing": {
"address": {
"postcodeZip": "15106",
"street2": "Adjacent To Cat St",
"city": "Pittsburgh",
"country": "USA",
"street": "1 Horse St",
"stateProvince": "Pennsylvania",
"company": "Horse Co Ltd."
}
},
"agreement": {
"type": "RECURRING"
},
"authentication": {
"3ds": {
"acsEci": "5"
}
}
}
Response
{
"correlationId": "RC_correlationId_StandAloneRisk",
"id": "6b3b263f-2d5a-4650-80be-70910a04bv54",
"provider": {
"name": "EMULATORWITHCLEARPIIFIELDS",
"riskAssessmentRequestId": "aG1Xl2Y4S_ey_RJaoSwFOA"
},
"result": "SUCCESS"
}
Retrieve Risk Assessment
The Retrieve Risk Assessment operation is used to retrieve the details of a risk assessment performed by a risk service provider.
Example: Retrieve Risk Assessment
Request
| URL | https://paymentgateway.commbank.com.au/api/rest/version/100/merchant/XXXXXX/riskassessment/6b3b263f-2d5a-4650-80be-70910a04bv54a?correlationId=MyCorrelationId |
| HTTP method | GET |
Response
{
"correlationId": "MyCorrelationId",
"id": "6b3b263f-2d5a-4650-80be-70910a04bv54a",
"provider": {
"name": "Emulator",
"riskAssessmentRequestId": "xEN1wYlqSC6BN2Gg1Ho5Qg"
},
"recommendation": "REJECT",
"result": "SUCCESS",
"rule": [
{
"id": "MRS Test Rule 27",
"name": "Emulator MRS Reject 69976",
"score": 78
},
{
"id": "MRS Test Rule 61",
"name": "Emulator MRS Reject 63826",
"score": 37
},
{
"id": "MRS Test Rule 70",
"name": "Emulator MRS Reject 39812",
"score": 25
}
],
"totalScore": 47
}