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
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) Abbreviation Description CND condition M mandatory O optional C conditional Notice: Please note that the names of parameters can be returned in upper or lower case.Definitions
Data formats
Abbreviations
Comment If a parameter is mandatory, then it must be present If a parameter is optional, then it can be present, but it is not required If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional
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, Paygate rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.
The following table describes the encrypted request parameters:
Parameter | Format | CND | Description | |
|---|---|---|---|---|
MerchantID | ans..30 | M | MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too. | |
EventToken | enum | M | Abbreviation of the action to be done: <Create>, <Read>, <Update> or <Delete> | |
BlackListInfo | ans...1024 | M | Information about blacklist entry as JSON-String in Base64-Format. See tables BlackListInfo below. | |
Parameters for blacklist editing request
The following table describes the parameters with which the Paygate responds:
Parameter | Format | CND | Description | |
|---|---|---|---|---|
MID | ans..30 | M | MerchantID, assigned by Computop | |
Status | a..30 | M | OK or FAILED | |
Description | ans..1024 | C | Further details, if Status=FAILED | |
BlackListInfo | ans..1024 | C | Information about blacklist entry as JSON-String in Base64-Format, if Status=OK. See tables BlackListInfo below. | |
Response parameters for blacklist editing request
BlackListInfo
The following table describes the BlackListInfo object for EventToken Insert:
Parameter | Format | CND | Description | |
|---|---|---|---|---|
Category | enum | M | Category <EDD> for DirectDebit or <CC> for CreditCard | |
Number | ans..64 | M | IBAN, if Category=EDD Credit card number, if Category=CC Notice: Pseudo card numbers (PcNr) are not supported. | |
BIC | ans..32 | C | BIC, if Category=EDD | |
Parameters for blacklist editing, EventToken Insert
The following table describes the BlackListInfo object for EventToken Update:
Parameter | Format | CND | Description | |
|---|---|---|---|---|
BlockID | an..32 | M | Unique BlockID | |
LockActive | bool | M | Defines, if the entry should be locked or not. Locked: <True> Unlocked: <False> | |
Parameters for blacklist editing, EventToken Update
The following table describes the BlackListInfo object for EventToken Delete:
Parameter | Format | CND | Description |
|---|---|---|---|
BlockID | an..32 | M | Unique BlockID |
Parameters for blacklist editing, EventToken Delete
The following table describes the BlackListInfo object with which the Paygate responds:
Parameter | Format | CND | Description | |
|---|---|---|---|---|
BlockID | an..32 | M | Unique BlockID | |
MID | ans..30 | M | MerchantID, assigned by Computop | |
Category | enum | M | Category <EDD> for DirectDebit or <CC> for CreditCard | |
Number | ans..64 | M | IBAN, if Category=EDD Credit card number, if Category=CC Notice: Pseudo card numbers (PcNr) are not supported. | |
BIC | ans..32 | C | BIC, if Category=EDD | |
LockActive | bool | M | Defines, if the entry should be locked or not. Locked: <True> Unlocked: <False> | |
Created | dttm | M | Time of creation (YYYY-MM-DD hh:mm:ss) | |
Changed | dttm | M | Time of change (YYYY-MM-DD hh:mm:ss) | |
Response parameters for blacklist editing request