Need help?

Card Filter

Card Filter Feature – API Implementation Guide

To implement the card filter feature, navigate to Merchant Admin Portal → Security → Card Filter, set the status to "Mandatory", and define the custom message to display when an invalid BIN is used.

Overview

The Card Filter Feature allows merchants to restrict the types of cards accepted for a specific transaction by specifying allowed BIN or PAN patterns in the create order API request. This feature is useful for compliance, routing logic, and business rules enforcement.


API Parameters

The following optional fields can be included in the create order API request:

  • filter_cards1
  • filter_cards2
  • filter_cards3
  • filter_cards4

Each field accepts up to 16 filter entries, allowing a maximum of 64 filter rules per transaction.


Filter Format

Each filter entry must include:

  • The first 4 or 6 digits of the card number (i.e., BIN)
  • Optionally, a hyphen and the last 4 digits of the card number

Examples

FilterDescription
5545Accepts any card starting with 5545
554576Accepts any card starting with 554576
5545-3879Accepts card starting with 5545 and ending with 3879
554576-3879Accepts card starting with 554576 and ending with 3879

Multiple filters can be provided in a single field using commas.


Example Usage

{
  "order_id": "123456",
  "amount": "100.00",
  "currency": "AED",
  "filter_cards1": "4000-0002,411111,5454,558158-2229"
}