> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fyatu.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Restricted Merchants

> List the merchants restricted at the card network. GET /restricted-merchants. Requires cards:read scope.

## Overview

Returns the merchants currently blocked at the card network. A restricted merchant is declined at authorization time for every card you issue.

<Note>
  Restrictions are keyed by **currency** at the card network and **shared across all of your programs** — so there's no program in the path. It defaults to `USD`; pass `?currency=` only if you operate cards in another currency. Restricting is an operator action performed by Fyatu — reach out to your account manager to add or remove entries.
</Note>

## Query Parameters

| Parameter  | Type   | Default | Description                            |
| ---------- | ------ | ------- | -------------------------------------- |
| `currency` | string | `USD`   | Currency the restrictions are keyed by |

## Merchant Object

| Field          | Type   | Description                                                                                 |
| -------------- | ------ | ------------------------------------------------------------------------------------------- |
| `merchantName` | string | Blocked by **partial** name match — any merchant whose name contains this value is declined |
| `merchantId`   | string | Blocked by **exact** descriptor match                                                       |

Each entry has at least one of the two.

<Info>
  In the **sandbox** environment there are no real merchants, so this endpoint returns a small set of static example entries. Use it to validate your integration's response handling; the live environment returns the real restriction list.
</Info>

## Example

<CodeGroup>
  ```bash cURL theme={null}
  curl https://api.fyatu.com/api/v3.20/restricted-merchants \
    -H "Authorization: Bearer $FYATU_API_KEY"
  ```

  ```javascript Node.js theme={null}
  const resp = await fetch(
    'https://api.fyatu.com/api/v3.20/restricted-merchants',
    { headers: { 'Authorization': `Bearer ${process.env.FYATU_API_KEY}` } }
  );
  const { data } = await resp.json();
  console.log(`${data.merchants.length} restricted merchant(s) for ${data.currency}`);
  ```

  ```python Python theme={null}
  import os, requests

  resp = requests.get(
      'https://api.fyatu.com/api/v3.20/restricted-merchants',
      headers={'Authorization': f'Bearer {os.environ["FYATU_API_KEY"]}'}
  )
  data = resp.json()['data']
  for m in data['merchants']:
      print(m.get('merchantName') or m.get('merchantId'))
  ```
</CodeGroup>

## Success Response (200)

```json theme={null}
{
  "success": true,
  "status": 200,
  "message": "Restricted merchants retrieved",
  "data": {
    "currency": "USD",
    "merchants": [
      { "merchantName": "megaplaza" },
      { "merchantId": "GAMBLING*BET SHOP" }
    ]
  },
  "meta": {
    "requestId": "req_01HXY123456ABCDEF",
    "platform": "Fyatu CaaS",
    "timestamp": "2026-05-26T10:00:00Z"
  }
}
```

## Error Codes

| Code                 | HTTP | Cause                                                      |
| -------------------- | ---- | ---------------------------------------------------------- |
| `PROVIDER_ERROR`     | 500  | Card network unavailable — retry with exponential back-off |
| `INSUFFICIENT_SCOPE` | 403  | Key lacks `cards:read` scope                               |


## OpenAPI

````yaml v3.20/openapi.json GET /restricted-merchants
openapi: 3.1.0
info:
  title: FYATU CaaS API v3.20
  description: >-
    FYATU Cards-as-a-Service API — API key authentication, Cardholder
    lifecycle, Card issuance, Transactions, Webhooks, and Programs.
  version: 3.20.0
  contact:
    name: FYATU Support
    url: https://fyatu.com
    email: support@fyatu.com
servers:
  - url: https://api.fyatu.com/api/v3.20
    description: >-
      FYATU CaaS API — the environment (LIVE or SANDBOX) is determined by the
      API key, not the URL
security:
  - BearerAuth: []
tags:
  - name: Meta
    description: Liveness, account info, and supported event types
  - name: Account
    description: Account-level balance and funding status
  - name: Programs
    description: Read card program configuration
  - name: Cardholders
    description: Create and manage cardholder profiles
  - name: Cards
    description: Issue, fund, freeze, and terminate virtual cards
  - name: Transactions
    description: Read-only card transaction history
  - name: Webhooks
    description: Manage webhook endpoints for real-time event delivery
  - name: Products
    description: Read card product configurations
paths:
  /restricted-merchants:
    get:
      tags:
        - Cards
      summary: Get restricted merchants
      description: >-
        Returns the merchants restricted at the card network. Restrictions are
        keyed by currency and shared across every program, so no program is
        needed. Defaults to USD; override with ?currency=. In sandbox, returns
        static example data.
      operationId: getRestrictedMerchants
      parameters:
        - name: currency
          in: query
          required: false
          schema:
            type: string
            default: USD
          description: Currency the restrictions are keyed by (default USD)
      responses:
        '200':
          description: Restricted merchants retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  status:
                    type: integer
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      currency:
                        type: string
                      merchants:
                        type: array
                        items:
                          type: object
                          properties:
                            merchantName:
                              type: string
                            merchantId:
                              type: string
                  meta:
                    $ref: '#/components/schemas/Meta'
              example:
                success: true
                status: 200
                message: Restricted merchants retrieved
                data:
                  currency: USD
                  merchants:
                    - merchantName: megaplaza
                    - merchantId: GAMBLING*BET SHOP
components:
  schemas:
    Meta:
      type: object
      properties:
        requestId:
          type: string
          example: req_a1b2c3d4e5f6a7b8c9d0e1f2
        platform:
          type: string
          example: Fyatu CaaS
        timestamp:
          type: string
          format: date-time
          example: '2026-05-22T15:00:00Z'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key from the FYATU CaaS portal. Pass as `Authorization: Bearer
        <key>`.

````