About S2S Blacklist Editing in 

General information about Server-2-Server blacklist editing

Scope: Right now, editing a blacklist can only be done via or via Merchant Services, this process is unfortunately slow and time consuming. Merchants needing to edit a huge number of transactions, or needing immediate control, including confirmation of the update done, requested this new feature. will now be offering the possibility to edit a Blacklist via server-to-server.

Integration: A merchant should send a request to blacklist.aspx with usual parameters like MerchantID, Data and Length. In encrypted data, there must be a parameter EventToken for Insert, Update or Delete and a parameter BlackListInfo with all the information about the blacklist item. The value of BlackListInfo is a JSON-String. The first checks, if the merchant has the right to send such a request. Depending on the request result, it creates a BlackListInfo object and can perform the action insert, update or delete in the blacklist database. The next step is a response from the to the merchant. There will be a parameter Status, which can have the value OK or FAILED. In case of OK there will also be a parameter BlackListInfo which delivers all blacklist information as JSON-String. In case of FAILED there will be a parameter Description, which gives an indication why the request failed.

In order to block a card on several MerchantIDs at the same time, but without having to send a request for each MerchantID, it is possible to define a Master-MerchantID and various Sub-MerchantIDs. Then it is sufficient to send a request to the Master-MerchantID with the necessary data and the block will then also apply to all Sub-MerchantIDs at the same time.

If you are interested in this special function, please contact our Merchant Support so that the necessary configuration can be discussed and established.

 

Process flow chart


Process flow S2S Blacklist editing


interface


Calling the interface for editing a blacklist

In order to Create, Read, Update or Delete a blacklist entry via server-to-server communication, go to the following URL:

blacklist.aspx


Key

Format

CND

Description

Beschreibung

EventToken

enum

M

Abbreviation of the action to be done: <Create>, <Read>, <Update> or <Delete>

Abkürzung der auszuführender Aktion: <Create>, <Read>, <Update> oder <Delete>

BlackListInfo

ans...1024

M

Information about the blacklist entry as JSON string in the Base64 format. See table BlackListInfo below.

Information über den Blacklist-Eintrag als JSON-String im Base64-Format. Siehe Tabelle BlackListInfo unten.

Parameters for blacklist editing request



Notice: The BlackListInfo object is also provided back in response to EventToken Insert and Status "Failed" with Error Description = "Entry already exists". In this way the requestor can always receive back the unique BlockID when trying to insert a duplicated record.

Key

Format

CND

Description

Beschreibung

BlackListInfo

ans..1024

C

Information about the blacklist entry as JSON string in the Base64 format, if Status=OK. See table BlackListInfo below.

Information über den Blacklist-Eintrag als JSON-String im Base64-Format, wenn Status=OK. Siehe Tabelle BlackListInfo unten.

Response parameters for blacklist editing request


BlackListInfo

The following table describes the BlackListInfo object for EventToken Insert:

Key

Format

CND

Description

Beschreibung

Category

enum

M

Category <EDD> for direct debit or <CC> for credit card

Kategorie <EDD> für Lastschrift oder <CC> für Kreditkarte

Number

ans..64

M

IBAN, if Category=EDD

Credit card number, if Category=CC

IBAN, wenn Category=EDD

Kreditkartennummer, wenn Category=CC

BIC

ans..32

C

BIC, if Category=EDD

BIC, wenn Category=EDD

Parameters for blacklist editing, EventToken Insert

 

The following table describes the BlackListInfo object for EventToken Update:

Key

Format

CND

Description

Beschreibung

BlockID

an..32

M

Unique BlockID

Eindeutige BlockID

LockActive

bool

M

Defines, if the entry should by blocked or not.

Blocked: <True>

Unlocked: <False>

Definiert, ob der Eintrag gesperrt werden soll oder nicht.

Gesperrt: <True>

Entsperrt: <False>

Parameters for blacklist editing, EventToken Update

 

The following table describes the BlackListInfo object for EventToken Delete:

Key

Format

CND

Description

Beschreibung

BlockID

an..32

M

Unique BlockID

Eindeutige BlockID

Parameters for blacklist editing, EventToken Delete

 

The following table describes the BlackListInfo object with which the responds:

Key

Format

CND

Description

Beschreibung

BlockID

an..32

M

Unique BlockID

Eindeutige BlockID

Key

Format

CND

Description

Beschreibung

Category

enum

M

Category <EDD> for direct debit or <CC> for credit card

Kategorie <EDD> für Lastschrift oder <CC> für Kreditkarte

Number

ans..64

M

IBAN, if Category=EDD

Credit card number, if Category=CC

IBAN, wenn Category=EDD

Kreditkartennummer, wenn Category=CC

BIC

ans..32

C

BIC, if Category=EDD

BIC, wenn Category=EDD
LockActiveboolM

Defines, if the entry should by blocked or not.

Blocked: <True>

Unlocked: <False>

Definiert, ob der Eintrag gesperrt werden soll oder nicht.

Gesperrt: <True>

Entsperrt: <False>

CreateddttmMTime of creation (YYYY-MM-DD hh:mm:ss)Zeit des Anlegens (YYYY-MM-DD hh:mm:ss)
ChangeddttmMTime of modification (YYYY-MM-DD hh:mm:ss)Zeit der Änderung (YYYY-MM-DD hh:mm:ss)

Response parameters for blacklist editing request