List Bank Discounts

Developing

GET

{store_url}/api/v1/cart/checkout/bank-discounts

Retrieves the bank and card discounts configured for the store. Bank discounts can apply a percentage or fixed discount based on the customer's bank and card network, with optional minimum order and maximum discount limits.

Use this endpoint to display available bank discounts during the storefront checkout experience. The discount is automatically applied when the customer pays using an eligible card. Apple Pay payments are excluded.

Note:
Bank discounts require ZidPay. The discount applies automatically when the customer pays with a card that matches the configured bank and card network. Apple Pay is excluded.

Request

Header Params

Responses

🟢200Success

application/json

Bodyapplication/json

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff '{store_url}/api/v1/cart/checkout/bank-discounts' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "status": "object",
    "coupons": [
        {
            "id": 6198823,
            "created_at": "2026-08-19T22:45:38.000000Z",
            "name": "Arab National Bank Visa Discount",
            "conditions": [
                {
                    "field": "bank",
                    "action": "INCLUDE",
                    "value": [
                        "ARNBSARI"
                    ],
                    "operator": "in"
                }
            ],
            "discount_type": "p",
            "discount": 10,
            "min_total_amount": 0,
            "max_total_amount": 0,
            "date_start": "2026-08-19",
            "date_end": "2026-11-19",
            "show_in_cart_page": true,
            "show_in_product_page": true,
            "bank_code": "ARNBSARI",
            "card_network": "visa",
            "status_code": "coupon_active",
            "maximum_discount_value": 50,
            "is_manageable": true,
            "is_active": true,
            "bank_id": 6,
            "bank_name": "Arab National Bank",
            "bank_logo": "https://example.com/bank-arabi.png"
        }
    ],
    "count": 12,
    "message": {
        "type": "object",
        "code": null,
        "name": null,
        "description": null
    }
}

Modified at 2026-08-20 10:06:56

Customer’s Current Points Balance

Get Profile