API Reference

Server API version 1.0
Java

Results for

icon-search-large No search results yet
Enter your search query above

Risk-assess card

POST https://{domainname}/v1/{merchantId}/riskassessments/cards

Risk assessments

Through this API you can have our fraud prevention systems assess the risk for potential fraud based using the details you provide. You can either have us assess this risk when you submit the transaction for processing or you can do this separately from the payment process, using the risk assessment calls.

We offers two groups of checks:

  • Centred around card data
  • Centred around bank account data
Both groups perform multiple check within one call depending on configuration.

Request

When evaluating the risk of fraud on card transactions a generic rule of thumb is: more relevant data = more relevant results. This is especially true of the checks performed at Retail Decisions as their solutions allow you to take much more data points into account for the evaluation of the risk. Any relevant additional data can be used to build rulesets on or is potential differentiating data for the neural score.

The other checks only focus on the card data itself and no additional data is taken into consideration. This API allows you to submit almost the same data as when you do a transaction. In this case the data is only used to assess the risk and not actually process a payment.

PayloadRiskAssessmentCard

Property Type Required Details
card object depends read close
close

Description

Object containing Card object

Depends on:

Required if no paymentProductId has been provided.
  • SDK Object type
    Card
cardNumber string (19) depends read close
close

Description

The complete credit/debit card number (also know as the PAN)
The card number is always obfuscated in any of our responses

Depends on:

Please note that this field is required, except when a token or encryptedCustomerInput has been included in the request that includes this data.
cardholderName string (51) no read close
close

Description

Card holder's name on the card
cvv string (4) depends read close
close

Description

Card Verification Value, a 3 or 4 digit code used as an additional security feature for card not present transactions.

Depends on:

Normally, this field is required except in special cases. For example: this field should not be submitted for recurring transactions. Not submitting this field for non-recurring transactions can negatively impact your authorization rate.
expiryDate string (4) depends read close
close

Description

Expiry date of the card
Format: MMYY

Depends on:

Please note that this field is required, except when a token or encryptedCustomerInput has been included in the request that includes this data.
issueNumber string (2) no read close
close

Description

Issue number on the card (if applicable)
fraudFields object no read close
close

Description

Object containing additional data that will be used to assess the risk of fraud
  • SDK Object type
    FraudFields
addressesAreIdentical boolean no read close
close

Description

Indicates that invoice and shipping addresses are equal.
blackListData string (50) no read close
close

Description

Additional black list input
cardOwnerAddress object no read close
close

Description

The address that belongs to the owner of the card
  • SDK Object type
    Address
additionalInfo string (50) no read close
close

Description

Additional address information
city string (40) depends read close
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.
countryCode string (2) depends read close
close

Description

ISO 3166-1 alpha-2 country code

Depends on:

Required, except when a token has been included in the request that includes this value.
Required when address is included in Seller.
houseNumber string (15) depends read close
close

Description

House number

Depends on:

Required when address is included in Seller.
state string (35) no read close
close

Description

Full name of the state or province
stateCode string (9) no read close
close

Description

State code
Note: For payments with product 1503 the maximum length is not 9 but 2.
street string (50) depends read close
close

Description

Streetname

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.
zip string (10) depends read close
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.

Depends on:

Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for payments with product 9000 or 9001.
customerIpAddress string (32) depends read close
close

Description

The IP Address of the consumer that is making the payment

Depends on:

This field is required for payments with products 863, 9000 and 9001, and hosted checkouts with products 9000 and 9001.
defaultFormFill string no read close
close

Description

Degree of default form fill, with the following possible values:
  • automatically - All fields filled automatically
  • automatically-but-modified - All fields filled automatically, but some fields were modified manually
  • manually - All fields were entered manually
deviceFingerprintActivated boolean no read close
close

Description

Indicates that the device fingerprint has been used while processing the order.
deviceFingerprintTransactionId string no read close
close

Description

One must set the deviceFingerprintTransactionId received by the response of the endpoint /{merchant}/products/{paymentProductId}/deviceFingerprint
giftCardType string no read close
close

Description

One of the following gift card types:
  • celebrate-fall - Celebrate Fall
  • grandparents-day - Grandparent's Day
  • independence-day - Independence Day
  • anniversary - Anniversary
  • birthday - Birthday
  • congratulations - Congratulations
  • april-fools-day - April Fool's Day
  • easter - Easter
  • fathers-day - Father's Day
  • graduation - Graduation
  • holiday - Holiday
  • seasons-greetings - Season's Greetings
  • passover - Passover
  • kwanzaa - Kwanzaa
  • halloween - Halloween
  • mothers-day - Mother's Day
  • new-years-day - New Year's Day
  • bosses-day - Bosses' Day
  • st-patricks-day - St. Patrick's Day
  • sweetest-day - Sweetest Day
  • christmas - Christmas
  • baby-shower - Baby Shower
  • thanksgiving - Thanksgiving
  • other - Other
  • valentines-day - Valentine's Day
  • wedding - Wedding
  • secretarys-day - Secretary's Day
  • chinese-new-year - Chinese New Year
  • hanukkah - Hanukkah
giftMessage string (160) no read close
close

Description

Gift message
hasForgottenPwd boolean no read close
close

Description

Specifies if the consumer (initially) had forgotten their password
  • true - The consumer has forgotten their password
  • false - The consumer has not forgotten their password
hasPassword boolean no read close
close

Description

Specifies if the consumer entered a password to gain access to an account registered with the you
  • true - The consumer has used a password to gain access
  • false - The consumer has not used a password to gain access
isPreviousCustomer boolean no read close
close

Description

Specifies if the consumer has a history of online shopping with the merchant
  • true - The consumer is a known returning consumer
  • false - The consumer is new/unknown consumer
orderTimezone string (2) no read close
close

Description

Timezone in which the order was placed
shipComments string (160) no read close
close

Description

Comments included during shipping
shipmentTrackingNumber string (19) no read close
close

Description

Shipment tracking number
shippingDetails object no read close
close

Description

Details on how the order is shipped to the customer
  • SDK Object type
    FraudFieldsShippingDetails
methodDetails string (50) no read close
close

Description

Details regarding the shipping method
methodSpeed integer no read close
close

Description

Shipping method speed indicator
methodType integer no read close
close

Description

Shipping method type indicator
userData array no read close
close

Description

Array of up to 16 userData fields, each with a max length of 256 characters, that can be used for fraudscreening
website string (60) no read close
close

Description

The website from which the purchase was made
order object no read close
close

Description

Order object containing order related data
  • SDK Object type
    OrderRiskAssessment
additionalInput object no read close
close

Description

Object containing additional input on the order
  • SDK Object type
    AdditionalOrderInputAirlineData
airlineData object no read close
close

Description

Object that holds airline specific data
  • SDK Object type
    AirlineData
agentNumericCode string (8) no read close
close

Description

Numeric code identifying the agent
code string (3) yes read close
close

Description

Airline numeric code
flightDate string (8) no read close
close

Description

Date of the Flight
Format: YYYYMMDD
flightLegs array of object no read close
close

Description

Object that holds the data on the individual legs of the ticket
items object no read close
close
  • SDK Object type
    AirlineFlightLeg
airlineClass string (2) yes read close
close

Description

Reservation Booking Designator
arrivalAirport string (3) yes read close
close

Description

Arrival airport/city code
arrivalTime string (5) no read close
close

Description

The arrival time in the local time zone
Format: HH:MM
carrierCode string (2) yes read close
close

Description

IATA carrier code
conjunctionTicket string (14) no read close
close

Description

Identifying number of a ticket issued to a passenger in conjunction with this ticket and that constitutes a single contract of carriage
couponNumber string (1) no read close
close

Description

The coupon number associated with this leg of the trip. A ticket can contain several legs of travel, and each leg of travel requires a separate coupon
date string (8) yes read close
close

Description

Date of the leg
Format: YYYYMMDD
departureTime string (6) depends read close
close

Description

The departure time in the local time at the departure airport
Format: HH:MM

Depends on:

Required for PayPal (840) when Airline data is submitted
endorsementOrRestriction string (20) no read close
close

Description

An endorsement can be an agency-added notation or a mandatory government required notation, such as value-added tax. A restriction is a limitation based on the type of fare, such as a ticket with a 3-day minimum stay
exchangeTicket string (15) no read close
close

Description

New ticket number that is issued when a ticket is exchanged
fare string (12) no read close
close

Description

Fare of this leg
fareBasis string (15) no read close
close

Description

Fare Basis/Ticket Designator
fee integer no read close
close

Description

Fee for this leg of the trip
flightNumber string (4) depends read close
close

Description

The flight number assigned by the airline carrier with no leading spaces
Should be a numeric string

Depends on:

Required for PayPal (840) when Airline data is submitted
number integer (5) yes read close
close

Description

Sequence number of the flight leg
originAirport string (3) yes read close
close

Description

Origin airport/city code
passengerClass string no read close
close

Description

PassengerClass if this leg
serviceClass enum no read close
close
Deprecated: Use passengerClass instead

Description

ServiceClass of this leg (this field is used for fraud screening on the Ogone Payment Platform).

Possible values are:

  • economy
  • premium-economy
  • business
  • first
stopoverCode string depends read close
close

Description

Possible values are:
  • permitted = Stopover permitted
  • non-permitted = Stopover not permitted

Depends on:

Required for PayPal (840) when Airline data is submitted
taxes integer no read close
close

Description

Taxes for this leg of the trip
invoiceNumber string (6) no read close
close

Description

Airline tracing number
isETicket boolean no read close
close

Description

  • true = The ticket is an E-Ticket
  • false = the ticket is not an E-Ticket
isRegisteredCustomer boolean no read close
close

Description

  • true = a registered known consumer
  • false = unknown consumer
isRestrictedTicket boolean no read close
close

Description

  • true - Restricted, the ticket is non-refundable
  • false - No restrictions, the ticket is (partially) refundable
isThirdParty boolean no read close
close

Description

  • true - The payer is the ticket holder
  • false - The payer is not the ticket holder
issueDate string (8) no read close
close

Description

This is the date of issue recorded in the airline system In a case of multiple issuances of the same ticket to a cardholder, you should use the last ticket date.
Format: YYYYMMDD
merchantCustomerId string (16) no read close
close

Description

Your ID of the consumer in the context of the airline data
name string (20) yes read close
close

Description

Name of the airline
passengerName string (49) no read close
close

Description

Name of passenger
passengers array of object no read close
close

Description

Object that holds the data on the individual passengers (this object is used for fraud screening on the Ogone Payment Platform)
items object no read close
close
  • SDK Object type
    AirlinePassenger
firstName string (15) no read close
close

Description

First name of the passenger (this field is used for fraud screening on the Ogone Payment Platform)
surname string (70) no read close
close

Description

Surname of the passenger (this field is used for fraud screening on the Ogone Payment Platform)
surnamePrefix string (15) no read close
close

Description

Surname prefix of the passenger (this field is used for fraud screening on the Ogone Payment Platform)
title string (35) no read close
close

Description

Title of the passenger (this field is used for fraud screening on the Ogone Payment Platform)
placeOfIssue string (15) no read close
close

Description

Place of issue
For sales in the US the last two characters (pos 14-15) must be the US state code.
pnr string (127) no read close
close

Description

Passenger name record
pointOfSale string (25) no read close
close

Description

IATA point of sale name
posCityCode string (10) no read close
close

Description

city code of the point of sale
ticketDeliveryMethod string no read close
close

Description

Possible values:
  • e-ticket
  • city-ticket-office
  • airport-ticket-office
  • ticket-by-mail
  • ticket-on-departure
ticketNumber string (13) no read close
close

Description

The ticket or document number contains:
  • Airline code: 3-digit airline code number
  • Form code: A maximum of 3 digits indicating the type of document, the source of issue and the number of coupons it contains
  • Serial number: A maximum of 8 digits allocated on a sequential basis, provided that the total number of digits allocated to the form code and serial number shall not exceed ten
  • TICKETNUMBER can be replaced with PNR if the ticket number is unavailable
totalFare integer no read close
close

Description

Total fare for all legs on the ticket, excluding taxes and fees. If multiple tickets are purchased, this is the total fare for all tickets
totalFee integer no read close
close

Description

Total fee for all legs on the ticket. If multiple tickets are purchased, this is the total fee for all tickets
totalTaxes integer no read close
close

Description

Total taxes for all legs on the ticket. If multiple tickets are purchased, this is the total taxes for all tickets
travelAgencyName string (25) no read close
close

Description

Name of the travel agency issuing the ticket. For direct airline integration, leave this field blank
amountOfMoney object yes read close
close

Description

Object containing amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
amount integer (12) yes read close
close

Description

Amount in cents and always having 2 decimals
currencyCode string (3) yes read close
close

Description

Three-letter ISO currency code representing the currency for the amount
customer object no read close
close

Description

Object containing the details of the consumer
  • SDK Object type
    CustomerRiskAssessment
billingAddress object no read close
close

Description

Object containing billing address details
  • SDK Object type
    Address
additionalInfo string (50) no read close
close

Description

Additional address information
city string (40) depends read close
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.
countryCode string (2) depends read close
close

Description

ISO 3166-1 alpha-2 country code

Depends on:

Required, except when a token has been included in the request that includes this value.
Required when address is included in Seller.
houseNumber string (15) depends read close
close

Description

House number

Depends on:

Required when address is included in Seller.
state string (35) no read close
close

Description

Full name of the state or province
stateCode string (9) no read close
close

Description

State code
Note: For payments with product 1503 the maximum length is not 9 but 2.
street string (50) depends read close
close

Description

Streetname

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.
zip string (10) depends read close
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.

Depends on:

Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for payments with product 9000 or 9001.
contactDetails object no read close
close

Description

Object containing contact details like email address
  • SDK Object type
    ContactDetailsRiskAssessment
emailAddress string no read close
close

Description

Email address of the consumer
locale string (6) no read close
close

Description

The locale that the consumer should be addressed in (for 3rd parties). Note that some 3rd party providers only support the languageCode part of the locale, in those cases we will only use part of the locale provided.
personalInformation object no read close
close

Description

Object containing personal information like name, date of birth and gender
  • SDK Object type
    PersonalInformationRiskAssessment
name object no read close
close

Description

Object containing the name details of the consumer
  • SDK Object type
    PersonalNameRiskAssessment
firstName string (15) no read close
close

Description

Given name(s) or first name(s) of the consumer
surname string (70) no read close
close

Description

Surname(s) or last name(s) of the consumer
surnamePrefix string (15) no read close
close

Description

The prefix of the surname - in between first name and surname - of the consumer
shippingAddress object no read close
close

Description

Object containing shipping address details
  • SDK Object type
    AddressPersonal
additionalInfo string (50) no read close
close

Description

Additional address information
city string (40) depends read close
close

Description

City

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
countryCode string (2) depends read close
close

Description

ISO 3166-1 alpha-2 country code

Depends on:

Please note that this field is required, except when a token has been included in the request that includes this value.
houseNumber string (15) no read close
close

Description

House number
name object no read close
close

Description

Object that holds the name elements
  • SDK Object type
    PersonalName
firstName string (15) depends read close
close

Description

Given name(s) or first name(s) of the consumer

Depends on:

Required for payments with product 806, 9000 or 9001.
surname string (70) depends read close
close

Description

Surname(s) or last name(s) of the consumer

Depends on:

Required for the creation of a Payout.
Required for payments with product 806, 9000 or 9001.
surnamePrefix string (15) no read close
close

Description

Middle name - In between first name and surname - of the consumer
title string (35) depends read close
close

Description

Title of consumer

Depends on:

Required for payments with product 9000 or 9001 in Austria (AT), Belgium (BE), Germany (DE), the Netherlands (NL) and Switzerland (CH).
state string (35) no read close
close

Description

Full name of the state or province
stateCode string (9) no read close
close

Description

State code
street string (50) depends read close
close

Description

Streetname

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
zip string (10) depends read close
close

Description

Zip code

Depends on:

Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
paymentProductId integer (5) depends read close
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.

Depends on:

Required if no card information has been provided.

Request example

SDK: Java

This scenario you will probably use the most

  • Card card = new Card();
    card.setCardNumber("4567350000427977");
    card.setCvv("123");
    card.setExpiryDate("0820");
    
    List<AirlineFlightLeg> flightLegs = new ArrayList<AirlineFlightLeg>();
    
    AirlineFlightLeg flightLeg1 = new AirlineFlightLeg();
    flightLeg1.setAirlineClass("1");
    flightLeg1.setArrivalAirport("AMS");
    flightLeg1.setCarrierCode("KL");
    flightLeg1.setDate("20150102");
    flightLeg1.setDepartureTime("17:59");
    flightLeg1.setFare("fare");
    flightLeg1.setFareBasis("INTERNET");
    flightLeg1.setFlightNumber("791");
    flightLeg1.setNumber(1);
    flightLeg1.setOriginAirport("BCN");
    flightLeg1.setStopoverCode("non-permitted");
    
    flightLegs.add(flightLeg1);
    
    AirlineFlightLeg flightLeg2 = new AirlineFlightLeg();
    flightLeg2.setAirlineClass("1");
    flightLeg2.setArrivalAirport("BCN");
    flightLeg2.setCarrierCode("KL");
    flightLeg2.setDate("20150102");
    flightLeg2.setDepartureTime("23:59");
    flightLeg2.setFare("fare");
    flightLeg2.setFareBasis("INTERNET");
    flightLeg2.setFlightNumber("792");
    flightLeg2.setNumber(2);
    flightLeg2.setOriginAirport("AMS");
    flightLeg2.setStopoverCode("non-permitted");
    
    flightLegs.add(flightLeg2);
    
    AirlineData airlineData = new AirlineData();
    airlineData.setAgentNumericCode("123321");
    airlineData.setCode("123");
    airlineData.setFlightDate("20150102");
    airlineData.setFlightLegs(flightLegs);
    airlineData.setInvoiceNumber("123456");
    airlineData.setIsETicket(true);
    airlineData.setIsRegisteredCustomer(true);
    airlineData.setIsRestrictedTicket(true);
    airlineData.setIsThirdParty(true);
    airlineData.setIssueDate("20150101");
    airlineData.setMerchantCustomerId("14");
    airlineData.setName("Air France KLM");
    airlineData.setPassengerName("WECOYOTE");
    airlineData.setPlaceOfIssue("Utah");
    airlineData.setPnr("4JTGKT");
    airlineData.setPointOfSale("IATA point of sale name");
    airlineData.setPosCityCode("AMS");
    airlineData.setTicketDeliveryMethod("e-ticket");
    airlineData.setTicketNumber("KLM20050000");
    
    AdditionalOrderInputAirlineData additionalInput = new AdditionalOrderInputAirlineData();
    additionalInput.setAirlineData(airlineData);
    
    AmountOfMoney amountOfMoney = new AmountOfMoney();
    amountOfMoney.setAmount(100L);
    amountOfMoney.setCurrencyCode("EUR");
    
    Address billingAddress = new Address();
    billingAddress.setCountryCode("US");
    
    CustomerRiskAssessment customer = new CustomerRiskAssessment();
    customer.setBillingAddress(billingAddress);
    customer.setLocale("en_US");
    
    OrderRiskAssessment order = new OrderRiskAssessment();
    order.setAdditionalInput(additionalInput);
    order.setAmountOfMoney(amountOfMoney);
    order.setCustomer(customer);
    
    RiskAssessmentCard body = new RiskAssessmentCard();
    body.setCard(card);
    body.setOrder(order);
    
    RiskAssessmentResponse response = client.merchant("merchantId").riskassessments().cards(body);
    
  • Card card = new Card();
    card.setCardNumber("****************");
    card.setCvv("***");
    card.setExpiryDate("****");
    
    AmountOfMoney amountOfMoney = new AmountOfMoney();
    amountOfMoney.setAmount(100L);
    amountOfMoney.setCurrencyCode("USD");
    
    Address billingAddress = new Address();
    billingAddress.setCountryCode("US");
    
    CustomerRiskAssessment customer = new CustomerRiskAssessment();
    customer.setBillingAddress(billingAddress);
    
    OrderRiskAssessment order = new OrderRiskAssessment();
    order.setAmountOfMoney(amountOfMoney);
    order.setCustomer(customer);
    
    RiskAssessmentCard body = new RiskAssessmentCard();
    body.setCard(card);
    body.setOrder(order);
    
    RiskAssessmentResponse response = client.merchant("merchantId").riskassessments().cards(body);
    
  • Card card = new Card();
    card.setCardNumber("****************");
    card.setCvv("***");
    card.setExpiryDate("****");
    
    List<AirlineFlightLeg> flightLegs = new ArrayList<AirlineFlightLeg>();
    
    AirlineFlightLeg flightLeg1 = new AirlineFlightLeg();
    flightLeg1.setAirlineClass("1");
    flightLeg1.setArrivalAirport("AMS");
    flightLeg1.setCarrierCode("KL");
    flightLeg1.setDate("20150102");
    flightLeg1.setDepartureTime("17:59");
    flightLeg1.setFare("fare");
    flightLeg1.setFareBasis("INTERNET");
    flightLeg1.setFlightNumber("791");
    flightLeg1.setNumber(1);
    flightLeg1.setOriginAirport("BCN");
    flightLeg1.setStopoverCode("non-permitted");
    
    flightLegs.add(flightLeg1);
    
    AirlineFlightLeg flightLeg2 = new AirlineFlightLeg();
    flightLeg2.setAirlineClass("1");
    flightLeg2.setArrivalAirport("BCN");
    flightLeg2.setCarrierCode("KL");
    flightLeg2.setDate("20150102");
    flightLeg2.setDepartureTime("23:59");
    flightLeg2.setFare("fare");
    flightLeg2.setFareBasis("INTERNET");
    flightLeg2.setFlightNumber("792");
    flightLeg2.setNumber(2);
    flightLeg2.setOriginAirport("AMS");
    flightLeg2.setStopoverCode("non-permitted");
    
    flightLegs.add(flightLeg2);
    
    AirlineData airlineData = new AirlineData();
    airlineData.setAgentNumericCode("123321");
    airlineData.setCode("123");
    airlineData.setFlightDate("20150102");
    airlineData.setFlightLegs(flightLegs);
    airlineData.setInvoiceNumber("123456");
    airlineData.setIsETicket(true);
    airlineData.setIsRegisteredCustomer(true);
    airlineData.setIsRestrictedTicket(true);
    airlineData.setIsThirdParty(true);
    airlineData.setIssueDate("20150101");
    airlineData.setMerchantCustomerId("14");
    airlineData.setName("Air France KLM");
    airlineData.setPassengerName("WECOYOTE");
    airlineData.setPlaceOfIssue("Utah");
    airlineData.setPnr("4JTGKT");
    airlineData.setPointOfSale("IATA point of sale name");
    airlineData.setPosCityCode("AMS");
    airlineData.setTicketDeliveryMethod("e-ticket");
    airlineData.setTicketNumber("KLM20050000");
    
    AdditionalOrderInputAirlineData additionalInput = new AdditionalOrderInputAirlineData();
    additionalInput.setAirlineData(airlineData);
    
    AmountOfMoney amountOfMoney = new AmountOfMoney();
    amountOfMoney.setAmount(100L);
    amountOfMoney.setCurrencyCode("USD");
    
    Address billingAddress = new Address();
    billingAddress.setCountryCode("US");
    
    CustomerRiskAssessment customer = new CustomerRiskAssessment();
    customer.setBillingAddress(billingAddress);
    
    OrderRiskAssessment order = new OrderRiskAssessment();
    order.setAdditionalInput(additionalInput);
    order.setAmountOfMoney(amountOfMoney);
    order.setCustomer(customer);
    
    RiskAssessmentCard body = new RiskAssessmentCard();
    body.setCard(card);
    body.setOrder(order);
    
    RiskAssessmentResponse response = client.merchant("merchantId").riskassessments().cards(body);
    

Responses

Please find below an overview of the possible responses.

Response 200 - OKRiskAssessmentResponse

When a risk assessments check was performed successfully you will find the results of the performed checks in the results array.

The results to the following checks are included:

  • retaildescisions-cc-fraud-check - Checks performed by Retail Descisions
  • globalcollect-blacklist-check-cc - Checks performed against blacklist entries on the GlobalCollect platform
  • authorization-check - Validation of the card details using an account validation check at the issuer
Depending on your configuration not all checks mentioned above might be performed.

Property Type Required Details
results array of object no read close
close

Description

Object that contains the results of the performed fraudchecks
items object no read close
close
  • SDK Object type
    ResultDoRiskAssessment
category string no read close
close

Description

The Risk Services category with the following possible values:
  • retaildecisionsCCFraudCheck - checks performed by Retail Decisions
  • globalcollectBlacklistCheckCC - Checked against the blacklist on the GlobalCollect platform
  • authorizationCheck - 0$ auth card account validation check
  • ddFraudCheck - Check performed for German market via InterCard
  • validationbankAccount - Bank account details are algorithmically checked if they could exist
  • globalcollectBlacklistCheckDD - Checked against the blacklist on the GlobalCollect platform
result string no read close
close

Description

Risk service result with the following possible results:
  • accepted - Based on the checks performed the transaction can be accepted
  • challenged - Based on the checks performed the transaction should be manually reviewed
  • denied - Based on the checks performed the transaction should be rejected
  • no-advice - No fraud check was requested/performed
  • error - The fraud check resulted in an error and the fraud check was thus not performed
Group retaildecisionsCCFraudCheckOutput object no, one of group read close
close

Description

Object containing the results of the fraud checks performed by Retail Decisions
  • SDK Object type
    RetailDecisionsCCFraudCheckOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

fraudCode string no read close
close

Description

Provides additional information about the fraud result
fraudNeural string no read close
close

Description

The raw score returned by the Neural check returned by the evaluation of the transaction
fraudRCF string no read close
close

Description

List of RuleCategoryFlags as setup in the Retail Decisions system that lead to the result
Group validationBankAccountOutput object no, one of group read close
close

Description

Object containing the results of the fraud checks performed on the bank account data
  • SDK Object type
    ValidationBankAccountOutput
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

checks array of object no read close
close

Description

Array of checks performed with the results of each check
items object no read close
close
  • SDK Object type
    ValidationBankAccountCheck
code string no read close
close

Description

Code of the bank account validation check
description string no read close
close

Description

Description of check performed
result string no read close
close

Description

Result of the bank account validation check performed, with the following possible results:
  • PASSED - The check passed
  • ERROR - The check did not pass
  • WARNING - Depending on your needs this either needs to be treated as a passed or error response. It depends on your business logic and for what purpose you want to use the validated bank account details.
  • NOTCHECKED - This check was not performed, usually because one of the earlier checks already caused an error response to be triggered
newBankName string no read close
close

Description

Bank name, matching the bank code of the request
reformattedAccountNumber string no read close
close

Description

Reformatted account number according to local clearing rules
reformattedBankCode string no read close
close

Description

Reformatted bank code according to local clearing rules
reformattedBranchCode string no read close
close

Description

Reformatted branch code according to local clearing rules

Response example

SDK: Java

This scenario you will probably use the most

  • {
        "results" : [
            {
                "category" : "globalcollectBlacklistCheckCC",
                "result" : "Accepted"
            },
            {
                "category" : "authorisationCheck",
                "result" : "Error"
            },
            {
                "category" : "retaildecisionsCCFraudCheck",
                "result" : "Error"
            }
        ]
    }
    

Response 400 - Bad requestErrorResponse

Property Type Required Details
errorId string yes read close
close

Description

Unique reference, for debugging purposes, of this error response
errors array of object yes read close
close

Description

List of one or more errors
items object no read close
close
  • SDK Object type
    APIError
category string no read close
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
code string yes read close
close

Description

Error code
httpStatusCode integer no read close
close

Description

HTTP status code for this error that can be used to determine the type of error
id string no read close
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
message string no read close
close

Description

Human-readable error message that is not meant to be relayed to consumer as it might tip off people who are trying to commit fraud
propertyName string no read close
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
requestId string no read close
close

Description

ID of the request that can be used for debugging purposes

Response example

SDK: Java

This scenario you will probably use the most

  • {
        "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092",
        "errors" : [
            {
                "code" : "20000000",
                "propertyName" : "bankAccountBban.accountNumber",
                "message" : "PARAMETER_NOT_FOUND_IN_REQUEST"
            }
        ]
    }
    
icon_top_1