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
Properties Expand all properties Hide deprecated properties
card	object	depends	read close
close Description Object containing Card object Depends on: Required when 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 minimum input length is 12 digits. The card number is always obfuscated in any of our responses Depends on: Required, except when a token or encryptedCustomerInput that includes this data is provided.
cardholderName	string	no depends depends no yes	read close
close Description The card holder's name on the card. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required by the Ogone platform, except when a token or encryptedCustomerInput that includes this data is provided Required by the TechProcess platform. Depends on: Required, except when a token or encryptedCustomerInput that includes this data is provided
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: Required, except in special cases. For example: this property should not be submitted for recurring transactions. Not submitting this property 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: Required, except when a token or encryptedCustomerInput that includes this data is provided.
issueNumber	string (2)	no	read close
close Description Issue number on the card (if applicable)
partialPin	string (2)	no	read close
close Description The first 2 digits of the card's PIN code. May be optionally submitted for South Korean cards (paymentProductIds 180, 181, 182, 183, 184, 185 and 186). Submitting this property may improve your authorization rate.
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 Deprecated: For risk assessments there is no replacement. For other calls, please use order.shipping.addressIndicator to indicate that the billing and shipping address are identical. 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 Deprecated: This should be the same as order.customer.billingAddress Description The address that belongs to the owner of the card SDK Object type Address
additionalInfo	string (50)	no	read close
close Deprecated Description Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
city	string	depends	read close
close Deprecated 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 (AfterPay Installments) or 9001 (AfterPay Invoice). Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required when address is included in Seller.
countryCode	string (2)	no depends no yes no	read close
close Deprecated Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform.
houseNumber	string (15)	depends	read close
close Deprecated Description House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform Depends on: Required when address is included in Seller. Required for 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) and 6107 (PicPay).
state	string (35)	no	read close
close Deprecated Description Full name of the state or province
stateCode	string	depends	read close
close Deprecated Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
street	string (50)	depends	read close
close Deprecated 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 (AfterPay Installments) or 9001 (AfterPay Invoice). Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required when address is included in Seller.
zip	string	depends	read close
close Deprecated 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 (AfterPay Installments) or 9001 (AfterPay Invoice). Required for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
customerIpAddress	string (45)	no depends no depends yes	read close
close Description The IP Address of the customer that is making the payment. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required by the GlobalCollect platform for payments with products 863 (WeChat Pay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for payments with products 863 (WeChat Pay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice).
defaultFormFill	string	no	read close
close Deprecated: Use order.customer.device.defaultFormFill instead 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 Deprecated: No replacement Description Indicates that the device fingerprint has been used while processing the order.
deviceFingerprintTransactionId	string	no	read close
close Deprecated: Use order.customer.device.deviceFingerprintTransactionId instead 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 Deprecated: Use order.customer.account.hasForgottenPassword instead Description Specifies if the customer (initially) had forgotten their password true - The customer has forgotten their password false - The customer has not forgotten their password
hasPassword	boolean	no	read close
close Deprecated: Use order.customer.account.hasPassword instead Description Specifies if the customer entered a password to gain access to an account registered with the you true - The customer has used a password to gain access false - The customer has not used a password to gain access
isPreviousCustomer	boolean	no	read close
close Deprecated: Use order.customer.isPreviousCustomer instead Description Specifies if the customer has a history of online shopping with the merchant true - The customer is a known returning customer false - The customer is new/unknown customer
orderTimezone	string (2)	no depends no no yes	read close
close Description Timezone in which the order was placed. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required by the TechProcess platform.
shipComments	string (160)	no	read close
close Deprecated: Use order.shipping.comments instead Description Comments included during shipping
shipmentTrackingNumber	string (19)	no	read close
close Deprecated: Use order.shipping.trackingNumber instead Description Shipment tracking number
shippingDetails	object	no	read close
close Deprecated: No replacement Description Details on how the order is shipped to the customer SDK Object type FraudFieldsShippingDetails
methodDetails	string (50)	no	read close
close Deprecated: No replacement Description Details regarding the shipping method
methodSpeed	integer	no	read close
close Deprecated: No replacement Description Shipping method speed indicator
methodType	integer	no	read close
close Deprecated: No replacement Description Shipping method type indicator
userData	array	no	read close
close Description Array of up to 16 userData properties, each with a max length of 256 characters, that can be used for fraudscreening
website	string (60)	no	read close
close Deprecated: Use merchant.websiteUrl instead Description The website from which the purchase was made
merchant	object	no	read close
close Description Object containing information on you, the merchant SDK Object type MerchantRiskAssessment
websiteUrl	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)	no	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	no	read close
close Description Reservation Booking Designator
arrivalAirport	string (3)	no	read close
close Description Arrival airport/city code
arrivalTime	string	no	read close
close Description The arrival time in the local time zone Format: HH:MM
carrierCode	string (2)	no	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)	no	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)	no	read close
close Description Sequence number of the flight leg
originAirport	string (3)	no	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 property 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 Deprecated: Use order.customer.accountType instead Description true = a registered known customer false = unknown customer
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 customer in the context of the airline data
name	string (20)	no	read close
close Description Name of the airline
numberInParty	integer	no	read close
close Description Total number of passengers in the party. If the the property numberInParty is not present, then the number of passengers will be used on the WL Online Payment Acceptance Platform.
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 property is used for fraud screening on the Ogone Payment Platform)
surname	string (70)	no	read close
close Description Surname of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
surnamePrefix	string (15)	no	read close
close Description Surname prefix of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
title	string (35)	no	read close
close Description Title of the passenger (this property 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. On the Ogone Payment Platform and the GlobalCollect Payment Platform it 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 property blank on the Ogone Payment Platform.
lodgingData	object	no	read close
close Description Object that holds lodging specific data SDK Object type LodgingData
charges	array of object	no	read close
close Description Object that holds lodging related charges
items	object	no	read close
close SDK Object type LodgingCharge
chargeAmount	integer (12)	no	read close
close Description Amount of additional charges associated with the stay of the guest. Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
chargeAmountCurrencyCode	string (3)	no	read close
close Description Currency for Charge amount. The code should be in 3 letter ISO format.
chargeType	string	no	read close
close Description Type of additional charges associated with the stay of the guest. Allowed values: lodging telephone restaurant minibar giftshop laundry transport gratuity conferenceRoom audiovisual banquet internet earlyDeparture roomService loungeBar other
checkInDate	string (8)	no	read close
close Description The date the guest checks into (or plans to check in to) the facility. Format: YYYYMMDD
checkOutDate	string (8)	no	read close
close Description The date the guest checks out of (or plans to check out of) the facility. Format: YYYYMMDD
folioNumber	string (25)	no	read close
close Description The Lodging Folio Number assigned to the itemized statement of charges and credits associated with this lodging stay, which can be any combination of characters and numerals defined by the Merchant or authorized Third Party Processor.
isConfirmedReservation	boolean	no	read close
close Description Indicates whether the room reservation is confirmed. true - The room reservation is confirmed false - The room reservation is not confirmed
isFacilityFireSafetyConform	boolean	no	read close
close Description Defines whether or not the facility conforms to the requirements of the Hotel and Motel Fire Safety Act of 1990, or similar legislation. true - The facility conform to the requirements false - The facility doesn't conform to the requirements
isNoShow	boolean	no	read close
close Description Indicate if this the customer is a no show case. In such case, the lodging property can charge a no show fee. true - The customer is a no show false - Not applicable
isPreferenceSmokingRoom	boolean	no	read close
close Description Indicated the preference of the customer for a smoking or non-smoking room. true - A smoking room is preferred false - A non-smoking room is preferred
numberOfAdults	integer (3)	no	read close
close Description The total number of adult guests staying (or planning to stay) at the facility (i.e., all booked rooms)
numberOfNights	integer (4)	no	read close
close Description The number of nights for the lodging stay
numberOfRooms	integer (4)	no	read close
close Description The number of rooms rented for the lodging stay
programCode	string	no	read close
close Description Code that corresponds to the category of lodging charges detailed in this message. Allowed values: lodging - (Default) Submitted charges are for lodging noShow - Submitted charges are for the failure of the guest(s) to check in for reserved a room advancedDeposit - Submitted charges are for an Advanced Deposit to reserve one or more rooms If no value is submitted the default value lodging is used.
propertyCustomerServicePhoneNumber	string (20)	no	read close
close Description The international customer service phone number of the facility
propertyPhoneNumber	string (20)	no	read close
close Description The local phone number of the facility in an international phone number format
renterName	string (26)	no	read close
close Description Name of the person or business entity charged for the reservation and/or lodging stay
rooms	array of object	no	read close
close Description Object that holds lodging related room data
items	object	no	read close
close SDK Object type LodgingRoom
dailyRoomRate	string (12)	no	read close
close Description Daily room rate exclusive of any taxes and fees Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
dailyRoomRateCurrencyCode	string (3)	no	read close
close Description Currency for Daily room rate. The code should be in 3 letter ISO format
dailyRoomTaxAmount	string (12)	no	read close
close Description Daily room tax Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
dailyRoomTaxAmountCurrencyCode	string (3)	no	read close
close Description Currency for Daily room tax. The code should be in 3 letter ISO format
numberOfNightsAtRoomRate	integer (4)	no	read close
close Description Number of nights charged at the rate in the dailyRoomRate property
roomLocation	string (10)	no	read close
close Description Location of the room within the facility, e.g. Park or Garden etc.
roomNumber	string (6)	no	read close
close Description Room number
typeOfBed	string (12)	no	read close
close Description Size of bed, e.g., king, queen, double.
typeOfRoom	string (12)	no	read close
close Description Describes the type of room, e.g., standard, deluxe, suite.
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 customer SDK Object type CustomerRiskAssessment
account	object	no	read close
close Description Object containing data related to the account the customer has with you SDK Object type CustomerAccountRiskAssessment
hasForgottenPassword	boolean	no	read close
close Description Specifies if the customer (initially) had forgotten their password true - The customer has forgotten their password false - The customer has not forgotten their password
hasPassword	boolean	no	read close
close Description Specifies if the customer entered a password to gain access to an account registered with the you true - The customer has used a password to gain access false - The customer has not used a password to gain access
accountType	string	no	read close
close Description Type of the customer account that is used to place this order. Can have one of the following values: none - The account that was used to place the order is a guest account or no account was used at all created - The customer account was created during this transaction existing - The customer account was an already existing account prior to this transaction
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. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
city	string	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 (AfterPay Installments) or 9001 (AfterPay Invoice). Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required when address is included in Seller.
countryCode	string (2)	no depends no yes no	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform.
houseNumber	string (15)	depends	read close
close Description House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform Depends on: Required when address is included in Seller. Required for 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) and 6107 (PicPay).
state	string (35)	no	read close
close Description Full name of the state or province
stateCode	string	depends	read close
close Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
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 (AfterPay Installments) or 9001 (AfterPay Invoice). Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required when address is included in Seller.
zip	string	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 (AfterPay Installments) or 9001 (AfterPay Invoice). Required for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
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 customer
device	object	no	read close
close Description Object containing information on the device and browser of the customer SDK Object type CustomerDeviceRiskAssessment
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
deviceFingerprintTransactionId	string	no	read close
close Description One must set the deviceFingerprintTransactionId received by the response of the endpoint /{merchant}/products/{paymentProductId}/deviceFingerprint
isPreviousCustomer	boolean	no	read close
close Description Specifies if the customer has a history of online shopping with the merchant true - The customer is a known returning customer false - The customer is new/unknown customer
locale	string (6)	no	read close
close Description The locale that the customer 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 customer SDK Object type PersonalNameRiskAssessment
firstName	string (15)	no	read close
close Description Given name(s) or first name(s) of the customer
surname	string (70)	no	read close
close Description Surname(s) or last name(s) of the customer
surnamePrefix	string (15)	no	read close
close Description The prefix of the surname - in between first name and surname - of the customer
shippingAddress	object	no	read close
close Deprecated: Use order.shipping.address instead Description Object containing shipping address details SDK Object type AddressPersonal
additionalInfo	string (50)	no	read close
close Deprecated Description Additional address information
city	string	no	read close
close Deprecated Description City
countryCode	string (2)	no	read close
close Deprecated Description ISO 3166-1 alpha-2 country code
houseNumber	string (15)	no	read close
close Deprecated Description House number
name	object	no	read close
close Deprecated Description Object that holds the name elements SDK Object type PersonalName
firstName	string (15)	depends depends no depends depends	read close
close Deprecated Description Given name(s) or first name(s) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540 Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required by the TechProcess platform for payments. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540 Depends on: Required for payments.
surname	string (70)	depends depends depends depends depends	read close
close Deprecated Description Surname(s) or last name(s) of the customer. The surname is truncated after 25 characters, with the limit being applied after surnamePrefix is prepended, for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required for the creation of a Payout. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for the creation of a Payout. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540 Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required for the creation of a Payout. Required by the Ogone platform for the creation of a Payout. Required by the TechProcess platform for the creation of a Payout. Depends on: Required for the creation of a Payout. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for the creation of a Payout. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540 Depends on: Required for the creation of a Payout.
surnamePrefix	string (15)	no	read close
close Deprecated Description Middle name - In between first name and surname - of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
title	string (35)	depends	read close
close Deprecated Description Title of customer Depends on: Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice) in Austria (AT), Belgium (BE), Germany (DE), the Netherlands (NL) and Switzerland (CH).
state	string (35)	no	read close
close Deprecated Description Full name of the state or province
stateCode	string	depends	read close
close Deprecated Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto)
street	string (50)	depends	read close
close Deprecated 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	depends	read close
close Deprecated 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.
shipping	object	no	read close
close Description Object containing information regarding shipping / delivery SDK Object type ShippingRiskAssessment
address	object	no	read close
close Description Object containing address information SDK Object type AddressPersonal
additionalInfo	string (50)	no	read close
close Description Additional address information
city	string	no	read close
close Description City
countryCode	string (2)	no	read close
close Description ISO 3166-1 alpha-2 country code
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 depends no depends depends	read close
close Description Given name(s) or first name(s) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540 Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required by the TechProcess platform for payments. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540 Depends on: Required for payments.
surname	string (70)	depends depends depends depends depends	read close
close Description Surname(s) or last name(s) of the customer. The surname is truncated after 25 characters, with the limit being applied after surnamePrefix is prepended, for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required for the creation of a Payout. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for the creation of a Payout. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540 Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required for the creation of a Payout. Required by the Ogone platform for the creation of a Payout. Required by the TechProcess platform for the creation of a Payout. Depends on: Required for the creation of a Payout. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for the creation of a Payout. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540 Depends on: Required for the creation of a Payout.
surnamePrefix	string (15)	no	read close
close Description Middle name - In between first name and surname - of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
title	string (35)	depends	read close
close Description Title of customer Depends on: Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice) 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	depends	read close
close Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto)
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	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.
comments	string (160)	no	read close
close Description Comments included during shipping
trackingNumber	string (19)	no	read close
close Description Shipment tracking number
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 when no card information has been provided.

Request example

SDK: Node.js

This scenario you will probably use the most

var body = {
    "card" : {
        "expiryDate" : "1299",
        "cardNumber" : "4567350000427977",
        "cvv" : "123"
    },
    "order" : {
        "amountOfMoney" : {
            "currencyCode" : "EUR",
            "amount" : 100
        },
        "customer" : {
            "locale" : "en_US",
            "billingAddress" : {
                "countryCode" : "US"
            },
            "accountType" : "existing"
        },
        "additionalInput" : {
            "airlineData" : {
                "code" : "123",
                "name" : "Air France KLM",
                "invoiceNumber" : "123456",
                "agentNumericCode" : "123321",
                "ticketNumber" : "KLM20050000",
                "pnr" : "4JTGKT",
                "isETicket" : true,
                "ticketDeliveryMethod" : "e-ticket",
                "passengerName" : "WECOYOTE",
                "pointOfSale" : "IATA point of sale name",
                "placeOfIssue" : "Utah",
                "flightDate" : "20150102",
                "isThirdParty" : true,
                "posCityCode" : "AMS",
                "merchantCustomerId" : "14",
                "issueDate" : "20150101",
                "isRestrictedTicket" : true,
                "flightLegs" : [
                    {
                        "number" : 1,
                        "date" : "20150102",
                        "originAirport" : "BCN",
                        "arrivalAirport" : "AMS",
                        "stopoverCode" : "non-permitted",
                        "airlineClass" : "1",
                        "carrierCode" : "KL",
                        "fareBasis" : "INTERNET",
                        "flightNumber" : "791",
                        "departureTime" : "17:59",
                        "fare" : "fare"
                    },
                    {
                        "number" : 2,
                        "date" : "20150102",
                        "originAirport" : "AMS",
                        "arrivalAirport" : "BCN",
                        "stopoverCode" : "non-permitted",
                        "airlineClass" : "1",
                        "carrierCode" : "KL",
                        "fareBasis" : "INTERNET",
                        "flightNumber" : "792",
                        "departureTime" : "23:59",
                        "fare" : "fare"
                    }
                ]
            }
        }
    }
};
const sdkResponse = await client.v1.riskassessments.cards("merchantId", body);
// sdkResponse has the following properties:
// - status: the HTTP status code
// - body: the response body
// - isSuccess: true if the call was successful,
//              or false if the Worldline Global Collect platform returned an error response

var body = {
    "card" : {
        "expiryDate" : "****",
        "cardNumber" : "****************",
        "cvv" : "***"
    },
    "order" : {
        "amountOfMoney" : {
            "currencyCode" : "USD",
            "amount" : 100
        },
        "customer" : {
            "billingAddress" : {
                "countryCode" : "US"
            }
        }
    }
};
const sdkResponse = await client.v1.riskassessments.cards("merchantId", body);
// sdkResponse has the following properties:
// - status: the HTTP status code
// - body: the response body
// - isSuccess: true if the call was successful,
//              or false if the Worldline Global Collect platform returned an error response

var body = {
    "card" : {
        "expiryDate" : "****",
        "cardNumber" : "****************",
        "cvv" : "***"
    },
    "order" : {
        "amountOfMoney" : {
            "currencyCode" : "USD",
            "amount" : 100
        },
        "customer" : {
            "billingAddress" : {
                "countryCode" : "US"
            },
            "accountType" : "existing"
        },
        "additionalInput" : {
            "airlineData" : {
                "code" : "123",
                "name" : "Air France KLM",
                "invoiceNumber" : "123456",
                "agentNumericCode" : "123321",
                "ticketNumber" : "KLM20050000",
                "pnr" : "4JTGKT",
                "isETicket" : true,
                "ticketDeliveryMethod" : "e-ticket",
                "passengerName" : "WECOYOTE",
                "pointOfSale" : "IATA point of sale name",
                "placeOfIssue" : "Utah",
                "flightDate" : "20150102",
                "isThirdParty" : true,
                "posCityCode" : "AMS",
                "merchantCustomerId" : "14",
                "issueDate" : "20150101",
                "isRestrictedTicket" : true,
                "flightLegs" : [
                    {
                        "number" : 1,
                        "date" : "20150102",
                        "originAirport" : "BCN",
                        "arrivalAirport" : "AMS",
                        "stopoverCode" : "non-permitted",
                        "airlineClass" : "1",
                        "carrierCode" : "KL",
                        "fareBasis" : "INTERNET",
                        "flightNumber" : "791",
                        "departureTime" : "17:59",
                        "fare" : "fare"
                    },
                    {
                        "number" : 2,
                        "date" : "20150102",
                        "originAirport" : "AMS",
                        "arrivalAirport" : "BCN",
                        "stopoverCode" : "non-permitted",
                        "airlineClass" : "1",
                        "carrierCode" : "KL",
                        "fareBasis" : "INTERNET",
                        "flightNumber" : "792",
                        "departureTime" : "23:59",
                        "fare" : "fare"
                    }
                ]
            }
        }
    }
};
const sdkResponse = await client.v1.riskassessments.cards("merchantId", body);
// sdkResponse has the following properties:
// - status: the HTTP status code
// - body: the response body
// - isSuccess: true if the call was successful,
//              or false if the Worldline Global Collect platform returned an error response

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
Properties Expand all properties Hide deprecated properties
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	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	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: Node.js

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
Properties Expand all properties Hide deprecated properties
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 Description Contains detailed information on one single error. 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 customer 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: Node.js

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"
        }
    ]
}

Risk-assess card

Risk assessments

Request

PayloadRiskAssessmentCard

Description

Depends on:

Description

Depends on:

Description

Depends on:

Depends on:

Description

Depends on:

Description

Depends on:

Description

Description

Description

Description

Description

Description

Description

Description

Depends on:

Description

Depends on:

Description

Depends on:

Description

Description

Depends on:

Description

Depends on:

Description

Depends on:

Description

Depends on:

Depends on:

Description

Description

Description

Description

Description

Description

Description

Description

Description

Depends on:

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Depends on:

Description

Description

Description

Description

Description

Description