Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space ENWORK and version Documentation

Table of Contents


About S2S Blacklist Editing in 
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording

General information about Server-2-Server blacklist editing

Scope: Right now, editing a blacklist can only be done via

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBackoffice-Kurz
PageWithExcerptWording
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
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
feature.
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
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


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
interface

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameDefinition
PageWithExcerptDefinition EN


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:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
blacklist.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1623158288233_1457109538
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameblacklist_request
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1623158288236_-1571344443
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Key

Format

CND

Description

Beschreibung
EventTokenenumMAbbreviation of the action to be done: <Create>, <Read>, <Update> or <Delete>Abkürzung der auszuführender Aktion: <Create>, <Read>, <Update> oder <Delete>
BlackListInfoans..1024MInformation 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.

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1623158367551_1718169916
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameblacklist_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1623158367553_-554805894
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

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:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1623158418979_-1940300710
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameblacklistinfo_insert
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1623158418981_283851467
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Key

Format

CND

Description

Beschreibung
CategoryenumMCategory <EDD> for direct debit or <CC> for credit cardKategorie <EDD> für Lastschrift oder <CC> für Kreditkarte
Numberans..64M

Credit card number/PCNr, if Category=CC

IBAN/PBAN, if Category=EDD

(info) you also can add a German Bankleitzahl (BLZ) to blacklist by a record like this: DE00xxxxxxxx0000000000 where xxxxxxxx is the BLZ you want to blacklist. While EDD processing DE-IBAN is separated into BLZ/Konto so this BLZ will be blacklisted even if IBAN is used.

KreditkartennummerCredit card number/PCNr, if wenn Category=CC

IBAN/PBAN, wenn Category=EDDKreditkartennummer/PCNr, wenn Category=CC

(info) Sie können auch eine Deutsche Bankleitzahl (BLZ) auf Blacklist setzen, indem Sie eine IBAN verwenden wie: DE00xxxxxxxx0000000000 wobei xxxxxxxx die BLZ ist, welche Sie auf Blacklist setzen möchten. Während des EDD-Prozessings wird die DE-IBAN in BLZ/Kontonummer aufgesplittet, so dass diese BLZ auch bei Eingabe der IBAN gesperrt wird.

BICans..32CBIC, if Category=EDDBIC, wenn Category=EDD

Parameters for blacklist editing, EventToken Insert

 

The following table describes the BlackListInfo object for EventToken Update:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1623158454125_-1942571709
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameblacklistinfo_update
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1623158454127_-587454873
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Key

Format

CND

Description

Beschreibung
BlockIDan..32MUnique BlockIDEindeutige BlockID
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>

Parameters for blacklist editing, EventToken Update

 

The following table describes the BlackListInfo object for EventToken Delete:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1623158476514_-27435769
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameblacklistinfo_delete
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1623158476515_-754084146
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

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

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
responds:

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1623158499235_-1259712854
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameblacklistinfo_response
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1623158499237_1541754107
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Key

Format

CND

Description

Beschreibung

BlockID

an..32

M

Unique BlockID

Eindeutige BlockID

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

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