Check card status via Blacklist API
Use the Blacklist API to check whether a credit card is blacklisted in the gateway system. This is useful for fraud prevention and transaction filtering.
What is the Blacklist API?
The Blacklist API allows merchants to verify if a specific card number (PAN) is on any of the following blacklist levels:
Blacklist level | Scope | Checked when… |
---|---|---|
Global | System-wide block | Always |
Merchant | Specific to your merchant account | Always |
Terminal | Specific to a terminal token |
terminal_token is provided |
If the terminal_token
is provided, all three levels (terminal, merchant, and global) are checked.
Request parameters
Parameter | Required | Format | Description |
---|---|---|---|
card_number |
Yes | int(13..16) | Credit card number to be checked |
terminal_token |
No | string(40) | Token identifying a terminal; enables terminal-level blacklist checks |
Request example
<blacklist_request>
<card_number>4200000000000000</card_number>
<terminal_token>abd30ed00f88f838c5d233cbb62b6da0b69267b4</terminal_token>
</blacklist_request>
Response example
<blacklist_response>
<blacklisted>true</blacklisted>
</blacklist_response>
Response parameters
Parameter | Type | Description |
---|---|---|
blacklisted |
boolean | Whether the card is blacklisted (`true` or `false`) |
Error response example
<blacklist_response>
<code>350</code>
<message>Invalid XML: No close tag for /blacklist_request</message>
</blacklist_response>
Error response parameters
Parameter | Type | Description |
---|---|---|
code |
integer | API error code |
message |
string | Details about the error |