Risk-assess bankaccount
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
Request
The evaluation of the risk on bank account data is less concerned with additional data, but focusses primarily just on the bank account data. As an online authorization is not possible against a bank account most checks focus on the, fairly static, checks whether the bank account data is wellformed, i.e. algorithms checks, correct length and syntax. Some are however based on more or less static blacklists that do try to take past transaction results 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.
PayloadRiskAssessmentBankAccount
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
object | no | read close | |
close
DescriptionObject containing account holder name and bank account information
|
|||
accountHolderName | string (30) | depends | read close |
close
DescriptionName of the account holder
|
|||
accountNumber | string | depends | read close |
close
DescriptionBank account number
|
|||
bankCode | string | depends | read close |
close
DescriptionBank code
|
|||
bankName | string (40) | no | read close |
close
DescriptionName of the bank
|
|||
branchCode | string | no | read close |
close
DescriptionBranch code
|
|||
checkDigit | string | no | read close |
close
DescriptionBank check digit
|
|||
countryCode | string (2) | no | read close |
close
DescriptionISO 3166-1 alpha-2 country code of the country where the bank account is held
For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
|
|||
object | no | read close | |
close
DescriptionObject containing account holder name and IBAN information
|
|||
accountHolderName | string (30) | depends | read close |
close
DescriptionName in which the account is held.
|
|||
iban | string (50) | depends | read close |
close
DescriptionThe IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.
|
|||
object | no | read close | |
close
DescriptionObject containing additional data that will be used to assess the risk of fraud
|
|||
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.
DescriptionIndicates that invoice and shipping addresses are equal.
|
|||
blackListData | string (50) | no | read close |
close
DescriptionAdditional black list input
|
|||
object | no | read close | |
close
Deprecated:
This should be the same as order.customer.billingAddress
DescriptionThe address that belongs to the owner of the card
|
|||
additionalInfo | string (50) | no | read close |
close
Deprecated
DescriptionAdditional 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
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes no | read close |
close
Deprecated
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
close
Deprecated
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
state | string (35) | no | read close |
close
Deprecated
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
Deprecated
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends | read close |
close
Deprecated
DescriptionStreetname
|
|||
zip | string | depends | read close |
close
Deprecated
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
customerIpAddress | string (45) | no depends no depends yes | read close |
close
DescriptionThe 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.
|
|||
defaultFormFill | string | no | read close |
close
Deprecated:
Use order.customer.device.defaultFormFill instead
DescriptionDegree of default form fill, with the following possible values:
|
|||
deviceFingerprintActivated | boolean | no | read close |
close
Deprecated:
No replacement
DescriptionIndicates that the device fingerprint has been used while processing the order.
|
|||
deviceFingerprintTransactionId | string | no | read close |
close
Deprecated:
Use order.customer.device.deviceFingerprintTransactionId instead
DescriptionOne must set the deviceFingerprintTransactionId received by the response of the endpoint /{merchant}/products/{paymentProductId}/deviceFingerprint
|
|||
giftCardType | string | no | read close |
close
DescriptionOne of the following gift card types:
|
|||
giftMessage | string (160) | no | read close |
close
DescriptionGift message
|
|||
hasForgottenPwd | boolean | no | read close |
close
Deprecated:
Use order.customer.account.hasForgottenPassword instead
DescriptionSpecifies if the customer (initially) had forgotten their password
|
|||
hasPassword | boolean | no | read close |
close
Deprecated:
Use order.customer.account.hasPassword instead
DescriptionSpecifies if the customer entered a password to gain access to an account registered with the you
|
|||
isPreviousCustomer | boolean | no | read close |
close
Deprecated:
Use order.customer.isPreviousCustomer instead
DescriptionSpecifies if the customer has a history of online shopping with the merchant
|
|||
orderTimezone | string (2) | no depends no no yes | read close |
close
DescriptionTimezone in which the order was placed. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
shipComments | string (160) | no | read close |
close
Deprecated:
Use order.shipping.comments instead
DescriptionComments included during shipping
|
|||
shipmentTrackingNumber | string (19) | no | read close |
close
Deprecated:
Use order.shipping.trackingNumber instead
DescriptionShipment tracking number
|
|||
object | no | read close | |
close
Deprecated:
No replacement
DescriptionDetails on how the order is shipped to the customer
|
|||
methodDetails | string (50) | no | read close |
close
Deprecated:
No replacement
DescriptionDetails regarding the shipping method
|
|||
methodSpeed | integer | no | read close |
close
Deprecated:
No replacement
DescriptionShipping method speed indicator
|
|||
methodType | integer | no | read close |
close
Deprecated:
No replacement
DescriptionShipping method type indicator
|
|||
userData | array | no | read close |
close
DescriptionArray 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
DescriptionThe website from which the purchase was made
|
|||
object | no | read close | |
close
DescriptionObject containing information on you, the merchant
|
|||
websiteUrl | string (60) | no | read close |
close
DescriptionThe website from which the purchase was made
|
|||
object | no | read close | |
object | no | read close | |
close
DescriptionObject containing additional input on the order
|
|||
object | no | read close | |
agentNumericCode | string (8) | no | read close |
close
DescriptionNumeric code identifying the agent
|
|||
code | string (3) | no | read close |
close
DescriptionAirline numeric code
|
|||
flightDate | string (8) | no | read close |
close
DescriptionDate of the Flight
Format: YYYYMMDD |
|||
array of object | no | read close | |
close
DescriptionObject that holds the data on the individual legs of the ticket
|
|||
object | no | read close | |
airlineClass | string | no | read close |
close
DescriptionReservation Booking Designator
|
|||
arrivalAirport | string (3) | no | read close |
close
DescriptionArrival airport/city code
|
|||
arrivalTime | string | no | read close |
close
DescriptionThe arrival time in the local time zone
Format: HH:MM |
|||
carrierCode | string (2) | no | read close |
close
DescriptionIATA carrier code
|
|||
conjunctionTicket | string (14) | no | read close |
close
DescriptionIdentifying 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
DescriptionThe 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
DescriptionDate of the leg
Format: YYYYMMDD |
|||
departureTime | string (6) | depends | read close |
close
DescriptionThe departure time in the local time at the departure airport
Format: HH:MM |
|||
endorsementOrRestriction | string (20) | no | read close |
close
DescriptionAn 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
DescriptionNew ticket number that is issued when a ticket is exchanged
|
|||
fare | string (12) | no | read close |
close
DescriptionFare of this leg
|
|||
fareBasis | string (15) | no | read close |
close
DescriptionFare Basis/Ticket Designator
|
|||
fee | integer | no | read close |
close
DescriptionFee for this leg of the trip
|
|||
flightNumber | string (4) | depends | read close |
close
DescriptionThe flight number assigned by the airline carrier with no leading spaces
Should be a numeric string |
|||
number | integer (5) | no | read close |
close
DescriptionSequence number of the flight leg
|
|||
originAirport | string (3) | no | read close |
close
DescriptionOrigin airport/city code
|
|||
passengerClass | string | no | read close |
close
DescriptionPassengerClass if this leg
|
|||
serviceClass | enum | no | read close |
close
Deprecated:
Use passengerClass instead
DescriptionServiceClass of this leg (this property is used for fraud screening on the Ogone Payment Platform).
Possible values are:
|
|||
stopoverCode | string | depends | read close |
close
DescriptionPossible values are:
|
|||
taxes | integer | no | read close |
close
DescriptionTaxes for this leg of the trip
|
|||
invoiceNumber | string (6) | no | read close |
close
DescriptionAirline tracing number
|
|||
isETicket | boolean | no | read close |
close
Description
|
|||
isRegisteredCustomer | boolean | no | read close |
close
Deprecated:
Use order.customer.accountType instead
Description
|
|||
isRestrictedTicket | boolean | no | read close |
close
Description
|
|||
isThirdParty | boolean | no | read close |
close
Description
|
|||
issueDate | string (8) | no | read close |
close
DescriptionThis 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
DescriptionYour ID of the customer in the context of the airline data
|
|||
name | string (20) | no | read close |
close
DescriptionName of the airline
|
|||
numberInParty | integer | no | read close |
close
DescriptionTotal 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
DescriptionName of passenger
|
|||
array of object | no | read close | |
close
DescriptionObject that holds the data on the individual passengers (this object is used for fraud screening on the Ogone Payment Platform)
|
|||
object | no | read close | |
firstName | string (15) | no | read close |
close
DescriptionFirst name of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
|
|||
surname | string (70) | no | read close |
close
DescriptionSurname of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
|
|||
surnamePrefix | string (15) | no | read close |
close
DescriptionSurname prefix of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
|
|||
title | string (35) | no | read close |
close
DescriptionTitle of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
|
|||
placeOfIssue | string (15) | no | read close |
close
DescriptionPlace 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
DescriptionPassenger name record
|
|||
pointOfSale | string (25) | no | read close |
close
DescriptionIATA point of sale name
|
|||
posCityCode | string (10) | no | read close |
close
Descriptioncity code of the point of sale
|
|||
ticketDeliveryMethod | string | no | read close |
close
DescriptionPossible values:
|
|||
ticketNumber | string (13) | no | read close |
close
DescriptionThe ticket or document number. On the Ogone Payment Platform and the GlobalCollect Payment Platform it contains:
|
|||
totalFare | integer | no | read close |
close
DescriptionTotal 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
DescriptionTotal 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
DescriptionTotal 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
DescriptionName of the travel agency issuing the ticket. For direct airline integration, leave this property blank on the Ogone Payment Platform.
|
|||
object | no | read close | |
array of object | no | read close | |
close
DescriptionObject that holds lodging related charges
|
|||
object | no | read close | |
chargeAmount | integer (12) | no | read close |
close
DescriptionAmount 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
DescriptionCurrency for Charge amount. The code should be in 3 letter ISO format.
|
|||
chargeType | string | no | read close |
close
DescriptionType of additional charges associated with the stay of the guest.
Allowed values:
|
|||
checkInDate | string (8) | no | read close |
close
DescriptionThe date the guest checks into (or plans to check in to) the facility.
Format: YYYYMMDD |
|||
checkOutDate | string (8) | no | read close |
close
DescriptionThe date the guest checks out of (or plans to check out of) the facility.
Format: YYYYMMDD |
|||
folioNumber | string (25) | no | read close |
close
DescriptionThe 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
DescriptionIndicates whether the room reservation is confirmed.
|
|||
isFacilityFireSafetyConform | boolean | no | read close |
close
DescriptionDefines whether or not the facility conforms to the requirements of the Hotel and Motel Fire Safety Act of 1990, or similar legislation.
|
|||
isNoShow | boolean | no | read close |
close
DescriptionIndicate if this the customer is a no show case. In such case, the lodging property can charge a no show fee.
|
|||
isPreferenceSmokingRoom | boolean | no | read close |
close
DescriptionIndicated the preference of the customer for a smoking or non-smoking room.
|
|||
numberOfAdults | integer (3) | no | read close |
close
DescriptionThe 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
DescriptionThe number of nights for the lodging stay
|
|||
numberOfRooms | integer (4) | no | read close |
close
DescriptionThe number of rooms rented for the lodging stay
|
|||
programCode | string | no | read close |
close
DescriptionCode that corresponds to the category of lodging charges detailed in this message.
Allowed values:
|
|||
propertyCustomerServicePhoneNumber | string (20) | no | read close |
close
DescriptionThe international customer service phone number of the facility
|
|||
propertyPhoneNumber | string (20) | no | read close |
close
DescriptionThe local phone number of the facility in an international phone number format
|
|||
renterName | string (26) | no | read close |
close
DescriptionName of the person or business entity charged for the reservation and/or lodging stay
|
|||
array of object | no | read close | |
close
DescriptionObject that holds lodging related room data
|
|||
object | no | read close | |
dailyRoomRate | string (12) | no | read close |
close
DescriptionDaily 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
DescriptionCurrency for Daily room rate. The code should be in 3 letter ISO format
|
|||
dailyRoomTaxAmount | string (12) | no | read close |
close
DescriptionDaily room tax
Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode. |
|||
dailyRoomTaxAmountCurrencyCode | string (3) | no | read close |
close
DescriptionCurrency for Daily room tax. The code should be in 3 letter ISO format
|
|||
numberOfNightsAtRoomRate | integer (4) | no | read close |
close
DescriptionNumber of nights charged at the rate in the dailyRoomRate property
|
|||
roomLocation | string (10) | no | read close |
close
DescriptionLocation of the room within the facility, e.g. Park or Garden etc.
|
|||
roomNumber | string (6) | no | read close |
close
DescriptionRoom number
|
|||
typeOfBed | string (12) | no | read close |
close
DescriptionSize of bed, e.g., king, queen, double.
|
|||
typeOfRoom | string (12) | no | read close |
close
DescriptionDescribes the type of room, e.g., standard, deluxe, suite.
|
|||
object | yes | read close | |
close
DescriptionObject containing amount and ISO currency code attributes
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
object | no | read close | |
close
DescriptionObject containing the details of the customer
|
|||
object | no | read close | |
close
DescriptionObject containing data related to the account the customer has with you
|
|||
hasForgottenPassword | boolean | no | read close |
close
DescriptionSpecifies if the customer (initially) had forgotten their password
|
|||
hasPassword | boolean | no | read close |
close
DescriptionSpecifies if the customer entered a password to gain access to an account registered with the you
|
|||
accountType | string | no | read close |
close
DescriptionType of the customer account that is used to place this order. Can have one of the following values:
|
|||
object | no | read close | |
additionalInfo | string (50) | no | read close |
close
DescriptionAdditional 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
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes no | read close |
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
state | string (35) | no | read close |
close
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends | read close |
close
DescriptionStreetname
|
|||
zip | string | depends | read close |
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
object | no | read close | |
close
DescriptionObject containing contact details like email address
|
|||
emailAddress | string | no | read close |
close
DescriptionEmail address of the customer
|
|||
object | no | read close | |
close
DescriptionObject containing information on the device and browser of the customer
|
|||
defaultFormFill | string | no | read close |
close
DescriptionDegree of default form fill, with the following possible values:
|
|||
deviceFingerprintTransactionId | string | no | read close |
close
DescriptionOne must set the deviceFingerprintTransactionId received by the response of the endpoint /{merchant}/products/{paymentProductId}/deviceFingerprint
|
|||
isPreviousCustomer | boolean | no | read close |
close
DescriptionSpecifies if the customer has a history of online shopping with the merchant
|
|||
locale | string (6) | no | read close |
close
DescriptionThe 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.
|
|||
object | no | read close | |
close
DescriptionObject containing personal information like name, date of birth and gender
|
|||
object | no | read close | |
close
DescriptionObject containing the name details of the customer
|
|||
firstName | string (15) | no | read close |
close
DescriptionGiven name(s) or first name(s) of the customer
|
|||
surname | string (70) | no | read close |
close
DescriptionSurname(s) or last name(s) of the customer
|
|||
surnamePrefix | string (15) | no | read close |
close
DescriptionThe prefix of the surname - in between first name and surname - of the customer
|
|||
object | no | read close | |
close
Deprecated:
Use order.shipping.address instead
DescriptionObject containing shipping address details
|
|||
additionalInfo | string (50) | no | read close |
close
Deprecated
DescriptionAdditional address information
|
|||
city | string | no | read close |
close
Deprecated
DescriptionCity
|
|||
countryCode | string (2) | no | read close |
close
Deprecated
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | no | read close |
close
Deprecated
DescriptionHouse number
|
|||
object | no | read close | |
firstName | string (15) | depends depends no depends depends | read close |
close
Deprecated
DescriptionGiven 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.
|
|||
surname | string (70) | depends depends depends depends depends | read close |
close
Deprecated
DescriptionSurname(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.
|
|||
surnamePrefix | string (15) | no | read close |
close
Deprecated
DescriptionMiddle 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
DescriptionTitle of customer
|
|||
state | string (35) | no | read close |
close
Deprecated
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
Deprecated
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends | read close |
close
Deprecated
DescriptionStreetname
|
|||
zip | string | depends | read close |
close
Deprecated
DescriptionZip code
|
|||
object | no | read close | |
close
DescriptionObject containing information regarding shipping / delivery
|
|||
object | no | read close | |
additionalInfo | string (50) | no | read close |
close
DescriptionAdditional address information
|
|||
city | string | no | read close |
close
DescriptionCity
|
|||
countryCode | string (2) | no | read close |
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | no | read close |
close
DescriptionHouse number
|
|||
object | no | read close | |
firstName | string (15) | depends depends no depends depends | read close |
close
DescriptionGiven 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.
|
|||
surname | string (70) | depends depends depends depends depends | read close |
close
DescriptionSurname(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.
|
|||
surnamePrefix | string (15) | no | read close |
close
DescriptionMiddle 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
DescriptionTitle of customer
|
|||
state | string (35) | no | read close |
close
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends | read close |
close
DescriptionStreetname
|
|||
zip | string | depends | read close |
close
DescriptionZip code
|
|||
comments | string (160) | no | read close |
close
DescriptionComments included during shipping
|
|||
trackingNumber | string (19) | no | read close |
close
DescriptionShipment tracking number
|
|||
paymentProductId | integer (5) | no | read close |
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
Request example
This scenario you will probably use the most
-
var bankAccountBban = new BankAccountBban(); bankAccountBban.AccountNumber = "0532013000"; bankAccountBban.BankCode = "37040044"; bankAccountBban.CountryCode = "DE"; var amountOfMoney = new AmountOfMoney(); amountOfMoney.Amount = 100L; amountOfMoney.CurrencyCode = "EUR"; var billingAddress = new Address(); billingAddress.CountryCode = "US"; var customer = new CustomerRiskAssessment(); customer.BillingAddress = billingAddress; customer.Locale = "en_US"; var order = new OrderRiskAssessment(); order.AmountOfMoney = amountOfMoney; order.Customer = customer; var body = new RiskAssessmentBankAccount(); body.BankAccountBban = bankAccountBban; body.Order = order; var response = await client.V1.WithNewMerchant("merchantId").Riskassessments.Bankaccounts(body);
-
var bankAccountIban = new BankAccountIban(); bankAccountIban.Iban = "NL78RABO0190491810"; var amountOfMoney = new AmountOfMoney(); amountOfMoney.Amount = 100L; amountOfMoney.CurrencyCode = "EUR"; var billingAddress = new Address(); billingAddress.CountryCode = "NL"; var customer = new CustomerRiskAssessment(); customer.BillingAddress = billingAddress; var order = new OrderRiskAssessment(); order.AmountOfMoney = amountOfMoney; order.Customer = customer; var body = new RiskAssessmentBankAccount(); body.BankAccountIban = bankAccountIban; body.Order = order; var response = await client.V1.WithNewMerchant("merchantId").Riskassessments.Bankaccounts(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 check in the results array.
The results to the following checks are included:
- dd-fraud-check - Checks performed by Intercard (only in Germany)
- validation-bank-account - Validation of the bank account details using an account validation check provided by BankWizard from Experian
- globalcollect-blacklist-check-dd - Checks performed against blacklist entries on the GlobalCollect platform
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
array of object | no | read close | |
close
DescriptionObject that contains the results of the performed fraudchecks
|
|||
object | no | read close | |
category | string | no | read close |
close
DescriptionThe Risk Services category with the following possible values:
|
|||
result | string | no | read close |
close
DescriptionRisk service result with the following possible results:
|
|||
object | no | read close | |
close
DescriptionObject containing the results of the fraud checks performed by Retail Decisions
|
|||
fraudCode | string | no | read close |
close
DescriptionProvides additional information about the fraud result
|
|||
fraudNeural | string | no | read close |
close
DescriptionThe raw score returned by the Neural check returned by the evaluation of the transaction
|
|||
fraudRCF | string | no | read close |
close
DescriptionList of RuleCategoryFlags as setup in the Retail Decisions system that lead to the result
|
|||
object | no | read close | |
close
DescriptionObject containing the results of the fraud checks performed on the bank account data
|
|||
array of object | no | read close | |
close
DescriptionArray of checks performed with the results of each check
|
|||
object | no | read close | |
code | string | no | read close |
close
DescriptionCode of the bank account validation check
|
|||
description | string | no | read close |
close
DescriptionDescription of check performed
|
|||
result | string | no | read close |
close
DescriptionResult of the bank account validation check performed, with the following possible results:
|
|||
newBankName | string | no | read close |
close
DescriptionBank name, matching the bank code of the request
|
|||
reformattedAccountNumber | string | no | read close |
close
DescriptionReformatted account number according to local clearing rules
|
|||
reformattedBankCode | string | no | read close |
close
DescriptionReformatted bank code according to local clearing rules
|
|||
reformattedBranchCode | string | no | read close |
close
DescriptionReformatted branch code according to local clearing rules
|
Response example
This scenario you will probably use the most
-
{ "results" : [ { "category" : "validationBankAccount", "validationBankAccountOutput" : { "checks" : [ { "code" : "0500", "description" : "Bank/branch code format", "result" : "PASSED" }, { "code" : "0050", "description" : "Account number format", "result" : "PASSED" } ], "reformattedAccountNumber" : "0532013000", "reformattedBankCode" : "37040044" }, "result" : "no-advice" }, { "category" : "globalcollectBlacklistCheckDD", "result" : "accepted" }, { "category" : "ddFraudCheck", "result" : "accepted" } ] }
Response 400 - Bad requestErrorResponse
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
errorId | string | yes | read close |
close
DescriptionUnique reference, for debugging purposes, of this error response
|
|||
array of object | yes | read close | |
close
DescriptionList of one or more errors
|
|||
object | no | read close | |
category | string | no | read close |
close
DescriptionCategory the error belongs to. The category should give an indication of the type of error you are dealing with.
Possible values:
|
|||
code | string | yes | read close |
close
DescriptionError code
|
|||
httpStatusCode | integer | no | read close |
close
DescriptionHTTP status code for this error that can be used to determine the type of error
|
|||
id | string | no | read close |
close
DescriptionID of the error. This is a short human-readable message that briefly describes the error.
|
|||
message | string | no | read close |
close
DescriptionHuman-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
DescriptionReturned 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:
|
|||
requestId | string | no | read close |
close
DescriptionID of the request that can be used for debugging purposes
|
Response example
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" } ] }