- Integration Guidelines
- Implementing Standalone Risk Assessment Integration
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 gateway.
ExamplesCreate or Update Risk Assessment "RISK_ASSESSMENT" Request
url used: https://qa06.gateway.mastercard.com/api/rest/version/64/merchant/XXXXXX/riskassessment/6b3b263f-2d5a-4650-80be-70910a04bv54
api 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": "Adjascent 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": "Adjascent 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": "riskAssessmentResultAccept",
"amount": "1550",
"cashbackAmount": "10.23",
"discount": {
"code": "SEPT-100",
"amount": "500"
},
"currency": "USD"
},
"sourceOfFunds": {
"provided": {
"card": {
"nameOnCard": "Peanut Butter Jam",
"number": "****************",
"expiry": {
"year": "**",
"month": "**"
},
"securityCode": "***"
}
},
"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": "Adjascent To Cat St",
"city": "Pittsburgh",
"country": "USA",
"street": "1 Horse St",
"stateProvince": "Pennsylvania",
"company": "Horse Co Ltd."
}
},
"agreement": {
"type": "RECURRING"
},
"authentication": {
"3ds": {
"acsEci": "5"
}
}
}
Create or Update Risk Assessment "RISK_ASSESSMENT" Response
Response with recommendation: ACCEPT
{
"correlationId": "RC_correlationId_StandAloneRisk",
"id": "6b3b263f-2d5a-4650-80be-70910a04bv54 ",
"provider": {
"name": "EMULATORWITHCLEARPIIFIELDS",
"riskAssessmentRequestId": "EUUPerDnSsO7C-mOdrUtIQ"
},
"recommendation": "ACCEPT",
"result": "SUCCESS",
"totalScore": -81
}
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
}
Create or Update Risk Assessment "INFORMATION_ONLY" Request
url used: https://qa06.gateway.mastercard.com/api/rest/version/64/merchant/XXXXXX/riskassessment/6b3b263f-2d5a-4650-80be-70910a04bv54
api 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": "Adjascent 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": "Adjascent 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": "Adjascent To Cat St",
"city": "Pittsburgh",
"country": "USA",
"street": "1 Horse St",
"stateProvince": "Pennsylvania",
"company": "Horse Co Ltd."
}
},
"agreement": {
"type": "RECURRING"
},
"authentication": {
"3ds": {
"acsEci": "5"
}
}
}
Create or Update Risk Assessment "INFORMATION_ONLY" Response
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.
Retrieve Risk Assessment Request
api METHOD: GET url used: https://qa06.gateway.mastercard.com/api/rest/version/64/merchant/XXXXXX/riskassessment/6b3b263f-2d5a-4650-80be-70910a04bv54a?correlationId=MyCorrelationId
Retrieve Risk Assessment Response
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
}