addToFraudList
To search in the page use Ctrl+F on your keyboard
The operation allows the management of the list types by insertion of PAN, TOKEN, Tid /Date, Tref.
Endpoints
-
- PROD
-
https://office-server.sogenactif.com/rs-services/v2/fraud/addToFraudList - method
- POST
-
- TEST
-
https://office-server-sogenactif.test.sips-services.com/rs-services/v2/fraud/addToFraudList - method
- POST
-
- PROD
-
https://office-server.sogenactif.com/services/v2/fraud?wsdl - method
- POST
-
- TEST
-
https://office-server-sogenactif.test.sips-services.com/services/v2/fraud?wsdl - method
- POST
Request
Required
-
fraudListElementValue- presence
- Required
- Interface version
- 2.15
Depending on the fraudListElementType, this field refers to the fraud list used. Below two examples of use cases:fraudListElementType = PAN fraudListElementValue contains a list of card numbers. fraudListElementType = TRANSACTION_ID fraudListElementValue contains a list of pairs (transactionId – transactionDate) in the following form: transactionId”@”transactionDate (example: 123987@20180919).
-
fraudListLevel- presence
- Required
- Interface version
- 2.15
Level / Color of the fraud list to be fed.
List of values
Black- Black list
Grey- Grey list
White- White list
-
fraudListType- presence
- Required
- Interface version
- 2.15
Type of list used for the Fraud check.
List of values
BicList- Bic List
CardBinList- Card Bin list
CardList- Card list
CustomerNameList- Customer name list
EmailList- Email list
IbanList- IBAN list
IdList- ID List
IpList- IP Address List
MandateList- Mandate List
PhoneNumberList- Phone number list
PostalCodeList- Postal code list
-
interfaceVersion- presence
- Required
- Interface version
- 2.15
Version value and number of the interface used.
List of values
AR_WS_2.- Obsolete
AUT_WS_2.- AUT_WS: Sogenactif Office Serveur (SOAP/JSON) interface for the Sogenactif authentication services.2.x: version referenced in the documentation of the function used by the merchant
CPR_WS_2.- Obsolete
CR_WS_2.- CR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for Cash Management functions. 2.x: connector version used by the merchant
DR_WS_2.- DR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for Diagnostic functions. 2.x: connector version used by the merchant
FR_WS_2.- FR_WS: Sogenactif Office Serveur (SOAP) interface for Fraud functions. 2.x: connector version used by the merchant
HP_x.x- HP: Sogenactif Paypage (POST) interface. x.x: connector version used by the merchant
IR_MB_- IR_MB: Sogenactif In-App (JSON) interface for Sogenactif In-App functions. 1.x: connector version used by the merchant
IR_WS_- IR_WS: Sogenactif Paypage (SOAP/JSON) interface. x.x: connector version used by the merchant
IR_WS_2.- IR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for payment request functions. 2.x: connector version used by the merchant
MR_WS_2.- MR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for mandate management. 2.x: connector version used by the merchant
OR_WS_1.0- OR_WS: Sogenactif Office Serveur (SOAP) interface for Sogenactif Office Serveur functions. 1.0: connector version used by the merchant
PMR_WS_2.- PMR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for payment method repository information request functions. 2.x: connector version used by the merchant
POR_WS_2.- Obsolete
TR_WS_2.- TR_WS: Sogenactif Office Serveur (SOAP) interface for Token functions. 2.x: connector version used by the merchant
WMR_WS_2.- WMR_WS: Sogenactif Walletpage interface 2.x: connector version used by the merchant
WR_WS_2.- WR_WS: Sogenactif Office Serveur (SOAP/JSON) interface for Wallet functions. 2.x: connector version used by the merchant
-
keyVersion- presence
- Required
- Interface version
- 2.15
Version of the merchant’s secret key used to calculate the imprint of the message (key stored by the merchant to verify the imprint of the automatic and manual notifications).
-
merchantId- presence
- Required
- Interface version
- 2.15
Identifier of the shop, this value is provided to the merchant by Sogenactif during the shop registration.
-
seal- presence
- Required
- Interface version
- 2.15
Message seal used to ensure the integrity of the request and the authentication of sender / receiver of the message.
Conditional
-
fraudListElementType- presence
- Conditional
- Interface version
- 2.15
Feeding mode of the fraud card list.
List of values
PAN- Fraud list is populated with PAN of card
TOKEN- Fraud list is populated with Token of card
TRANSACTION_ID- Fraud list is populated with transaction identifier (transactionId, transactionDate)
TRANSACTION_REF- Fraud list is populated with transaction reference (transactionReference)
Optional
-
fraudListReasonCode- presence
- Optional
- Interface version
- 2.15
The code of the reason why the element is added in the fraud list.
List of values
b2bCustomer- B2B Customer
bin_rangeTrusted- Bin range Trusted
cardForbidden- Card Forbidden
cardHolderReject- Cardholder Reject
cardLost- Card Lost
cardStolen- Card Stolen
cardUnknown- card Unknown
customerTrusted- Customer Trusted
debitNotPossible- Debit Not Possible
duplicatePaymentAttempt- Duplicate Payment Attempt
emailTrusted- Email Trusted
emailUnknown- Email Unknown
externallyBlackListed- Externally Black Listed
fraudSuspicion- Fraud Suspicion
fromMdiFiles- From Mdi Files
generalSuspicion- General Suspicion
ibanTrusted- Iban Trusted
ipTrusted- IP Trusted
ipUnknown- IP Unknown
mandateTrusted- Mandate trusted
nameTrusted- Name Trusted
negativeExperience- Negative Experience
notSpecified- Not Specified
panTrusted- Pan Trusted
phoneTrusted- Phone Trusted
phoneUnknown- Phone Unknown
positiveExperience- Positive experience
specialAction- Special Action
travelCards- Travel Cards
unpaid- Unpaid
vip- VIP
zipUnknown- Zip Unknown
-
intermediateServiceProviderId- presence
- Optional
- Interface version
- 2.15
Identifier of the Service used by the merchant for the exchanges with the Sogenactif platform.
-
sealAlgorithm- presence
- Optional
- Interface version
- 2.15
Algorithm applied to calculate the seal encryption.
List of values
HMAC-SHA-256- The encryption algorithm applied is HMAC-SHA-256
HMAC-SHA-512- The encryption algorithm applied is HMAC-SHA-512
SHA-256- The encryption algorithm applied is SHA-256
Request sample
{
"fraudListElementType": "PAN",
"fraudListElementValue": "5017674000000200",
"fraudListLevel": "WHITE",
"fraudListType": "CARD_LIST",
"interfaceVersion": "FR_WS_2.15",
"keyVersion": "1",
"merchantId": "226000009630001",
"seal": "b3f44355e912ebb9c3fed0e3a00a5782762afd604055f3a56438971a4e9ec58f"
}
<urn:addToFraudList>
<urn:merchantId>226000009630001</urn:merchantId>
<urn:interfaceVersion>FR_WS_2.15</urn:interfaceVersion>
<urn:fraudListType>CARD_LIST</urn:fraudListType>
<urn:fraudListLevel>WHITE</urn:fraudListLevel>
<urn:fraudListElementType>WHITE</urn:fraudListElementType >
<urn:fraudListElementValue>5017674000000200</urn:fraudListElementValue>
<urn:secretKey>EqoB2nuLFmbz79YQ0G1JGlxKoNzCx9objHYb49GGp_A</urn:secretKey>
<urn:keyVersion>1</urn:keyVersion>
</urn:addToFraudList >
Response
Required
-
seal- presence
- Required
- Interface version
- 2.15
Message seal used to ensure the integrity of the request and the authentication of sender / receiver of the message.
Optional
-
errorFieldName- presence
- Optional
- Interface version
- 2.15
Error field name of the incoming request.Present when responseCode = 12 or 30.
-
fraudResponseCode- presence
- Optional
- Interface version
- 2.15
Fraud response code.
Response sample
{
"fraudResponseCode": "00",
"seal": "0a7c1ab8fa767313e0631d166843eb55b9f783426241690a2b6e23ca40087811"
}
<addToFraudListResponse xmlns="urn:sips:cn:contract:office:diagnostic:v2">
<output>
<responseCode>00</responseCode>
<seal>0cecd48cf50085be7bbf24d6929b13115323639724f58d5aea1350cc670f14e1</seal>
</output>
</addToFraudListResponse>
