Maintenance Work Notice!

We will carry out maintenance work on this documentation on Wednesday, 22.09.2021 between 1:30 pm and 2:30 pm CEST. During this time, this documentation will not be available to you. Thank you for your understanding.

Page tree

Search

Skip to end of metadata
Go to start of metadata


About S2S Blacklist Editing in Paygate

General information about Server-2-Server blacklist editing

Scope: Right now, editing a blacklist can only be done via Analytics 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 Paygate feature. Computop 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 Paygate 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 Paygate 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


Paygate interface

Definitions

Data formats

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

ISODateTime (YYYY-MM-DDThh:mm:ss)


Abbreviations

Abbreviation

Description

Comment

CND

condition


M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional


Notice: Please note that the names of parameters can be returned in upper or lower case.


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:


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

HändlerID, die von Computop vergeben wird. Dieser Parameter ist zusätzlich auch unverschlüsselt zu übergeben.

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.

The following table describes the result parameters with which the Computop Paygate responds to your system

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. MerchantId, RefNr) should not be checked case-sentive

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescriptionBeschreibung

MID

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

KeyFormatCNDDescriptionBeschreibung
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

OK (URLSuccess) oder FAILED (URLFailure)

KeyFormatCNDDescriptionBeschreibung
Description

ans..1024

M
Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!
Nähere Beschreibung bei Ablehnung der Zahlung. Bitte nutzen Sie nicht den Parameter Description, sondern Code für die Auswertung des Transaktionsstatus!

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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

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

IBAN, if Category=EDD

Credit card number, if Category=CC

IBAN, wenn Category=EDD

Kreditkartennummer, wenn Category=CC

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

Parameters for blacklist editing, EventToken Insert

 

The following table describes the BlackListInfo object for EventToken Update:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

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:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

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 Paygate responds:

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

Key

Format

CND

Description

Beschreibung

BlockID

an..32

M

Unique BlockID

Eindeutige BlockID

KeyFormatCNDDescriptionBeschreibung

MID

ans..30

M

MerchantID, assigned by Computop

HändlerID, die von Computop vergeben wird

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