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.

Recommended interfaceVersion: WR_WS_2.55

Endpoints

json
soap

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

Format

ANS128

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

Format

ANS20(restricted values)

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

Format

ANS20(restricted values)

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
Format
AN20(restricted String)
Version of the interface used. It is composed of a prefix that varies according to the function used and a version number (e.g. IR_WS_2.47).

Please refer to the function page for the value to use. Use the latest interface version number.

List of values

FR_WS_2.

Sogenactif Office Serveur (SOAP) interface for Fraud functions.
keyVersion

presence

Required

Interface version

2.15

Format

N10

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

Format

N15

Identifier of the shop, this value is provided to the merchant by Sogenactif during the shop registration.
seal

presence

Required

Interface version

2.15

Format

ANS128

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

Format

ANS20(restricted values)

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

Format

AN3(restricted values)

The code of the reason why the element is added in the fraud list.

List of values

B2B_CUSTOMER

B2B Customer

BIN_RANGE_TRUSTED

Bin range Trusted

CARD_FORBIDDEN

Card Forbidden

CARD_HOLDER_REJECT

Cardholder Reject

CARD_LOST

Card Lost

CARD_STOLEN

Card Stolen

CARD_UNKNOWN

card Unknown

CUSTOMER_TRUSTED

Customer Trusted

DEBIT_NOT_POSSIBLE

Debit Not Possible

DUPLICATE_PAYMENT_ATTEMPT

Duplicate Payment Attempt

EMAIL_TRUSTED

Email Trusted

EMAIL_UNKNOWN

Email Unknown

EXTERNALLY_BLACK_LISTED

Externally Black Listed

FRAUD_SUSPICION

Fraud Suspicion

FROM_MDI_FILES

From Mdi Files

GENERAL_SUSPICION

General Suspicion

IBAN_TRUSTED

Iban Trusted

IP_TRUSTED

IP Trusted

IP_UNKNOWN

IP Unknown

MANDATE_TRUSTED

Mandate trusted

NAME_TRUSTED

Name Trusted

NEGATIVE_EXPERIENCE

Negative Experience

NOT_SPECIFIED

Not Specified

PAN_TRUSTED

Pan Trusted

PHONE_TRUSTED

Phone Trusted

PHONE_UNKNOWN

Phone Unknown

POSITIVE_EXPERIENCE

Positive experience

SPECIAL_ACTION

Special Action

TRAVEL_CARDS

Travel Cards

UNPAID

Unpaid

VIP

VIP

ZIP_UNKNOWN

Zip Unknown
intermediateServiceProviderId

presence

Optional

Interface version

2.15

Format

AN30

Identifier of the Service used by the merchant for the exchanges with the Sogenactif platform.
sealAlgorithm

presence

Optional

Interface version

2.15

Format

ANS20(restricted values)

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

            {
  "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

Format

ANS128

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

Format

ANS50

Error field name of the incoming request. Present when responseCode = 12 or 30.
fraudResponseCode

presence

Optional

Interface version

2.15

Format

N2

Fraud response code.

Response sample

json
soap

            {
  "fraudResponseCode": "00",
  "seal": "0a7c1ab8fa767313e0631d166843eb55b9f783426241690a2b6e23ca40087811"
}

                  <addToFraudListResponse xmlns="urn:sips:cn:contract:office:diagnostic:v2">
         <output>
            <responseCode>00</responseCode>
            <seal>0cecd48cf50085be7bbf24d6929b13115323639724f58d5aea1350cc670f14e1</seal>
         </output>
      </addToFraudListResponse>

Changelog

Filter

Interface version	Data	Attendance
2.15	`fraudListReasonCode`	Request
2.15	`intermediateServiceProviderId`	Request
2.15	`sealAlgorithm`	Request
2.15	`fraudListElementValue`	Request
2.15	`fraudListLevel`	Request
2.15	`fraudListType`	Request
2.15	`interfaceVersion`	Request
2.15	`keyVersion`	Request
2.15	`merchantId`	Request
2.15	`seal`	Request/Response
2.15	`fraudListElementType`	Request
2.15	`errorFieldName`	Response
2.15	`fraudResponseCode`	Response

addToFraudList

Endpoints

Request

Required

`fraudListElementValue`

`fraudListLevel`

`fraudListType`

`interfaceVersion`

`keyVersion`

`merchantId`

`seal`

Conditional

`fraudListElementType`

Optional

`fraudListReasonCode`

`intermediateServiceProviderId`

`sealAlgorithm`

Request sample

Response

Required

`seal`

Optional

`errorFieldName`

`fraudResponseCode`

Response sample

Changelog

Need help?