> ## Documentation Index > Fetch the complete documentation index at: https://api-reference.hyperswitch.io/llms.txt > Use this file to discover all available pages before exploring further. # Blocklist lookup ## OpenAPI ````yaml get /blocklist/lookup openapi: 3.0.3 info: title: Hyperswitch - API Documentation description: > ## Get started Hyperswitch provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. You can consume the APIs directly using your favorite HTTP/REST library. We have a testing environment referred to "sandbox", which you can setup to test API calls without affecting production data. Currently, our sandbox environment is live while our production environment is under development and will be available soon. You can sign up on our Dashboard to get API keys to access Hyperswitch API. ### Environment Use the following base URLs when making requests to the APIs: | Environment | Base URL | |---------------|------------------------------------| | Sandbox | | | Production | | ## Authentication When you sign up on our [dashboard](https://app.hyperswitch.io) and create a merchant account, you are given a secret key (also referred as api-key) and a publishable key. You may authenticate all API requests with Hyperswitch server by providing the appropriate key in the request Authorization header. | Key | Description | |-----------------|-----------------------------------------------------------------------------------------------| | api-key | Private key. Used to authenticate all API requests from your merchant server | | publishable key | Unique identifier for your account. Used to authenticate API requests from your app's client | Never share your secret api keys. Keep them guarded and secure. contact: name: Hyperswitch Support url: https://hyperswitch.io email: support.global@juspay.io license: name: Apache-2.0 version: 0.1.0 servers: - url: https://sandbox.hyperswitch.io description: Sandbox Environment security: [] tags: - name: Merchant Account description: Create and manage merchant accounts - name: Profile description: Create and manage profiles - name: Merchant Connector Account description: Create and manage merchant connector accounts - name: Payments description: Create and manage one-time payments, recurring payments and mandates - name: Refunds description: Create and manage refunds for successful payments - name: Mandates description: Manage mandates - name: Customers description: Create and manage customers - name: Payment Methods description: Create and manage payment methods of customers - name: Disputes description: Manage disputes - name: API Key description: Create and manage API Keys - name: Payouts description: Create and manage payouts - name: payment link description: Create payment link - name: Routing description: Create and manage routing configurations - name: Event description: Manage events - name: Authentication description: Create and manage authentication - name: Subscriptions description: Subscription management and billing endpoints - name: Card Issuer description: Create and manage card issuers - name: Telephone Order description: Charge cards collected over the phone by an IVR provider paths: /blocklist/lookup: get: tags: - Blocklist operationId: Look up whether a value is blocked parameters: - name: data in: query description: The raw value to check against the blocklist, e.g. a card BIN required: true schema: type: string - name: transaction_type in: query description: >- Looks up only payment or payout when selected. When omitted, both are included. Legacy NULL transaction namespaces belong to payment. required: false schema: allOf: - $ref: '#/components/schemas/BlocklistTransactionType' nullable: true - name: X-Profile-Id in: header description: >- Restricts the lookup to entries belonging to this business profile, plus entries with no profile. If omitted, the merchant's default profile is used; merchants with more than one profile have no default and will receive an error asking for this header. required: false schema: type: string nullable: true - name: X-Connected-Merchant-Id in: header description: >- Merchant ID of the connected merchant on whose behalf the operation is performed. Required when authenticating with a platform merchant's API key. Standard and connected merchants must not send it. required: false schema: type: string nullable: true example: merchant_abc responses: '200': description: >- All matches within the resolved profile, including merchant-wide entries. transaction_types contains distinct matching payment/payout namespaces, without data kinds or profile IDs. content: application/json: schema: $ref: '#/components/schemas/BlocklistLookupResponse' '400': description: Invalid Data, or no profile could be resolved security: - api_key: [] - jwt_key: [] components: schemas: BlocklistTransactionType: type: string description: The transaction namespace of a blocklist entry, stored as text. enum: - payment - payout BlocklistLookupResponse: type: object required: - data - blocked - transaction_types properties: data: type: string blocked: type: boolean description: >- Whether any entry matches within the resolved profile and selected transaction namespaces. transaction_types: type: array items: $ref: '#/components/schemas/BlocklistTransactionType' description: >- Distinct transaction types that block `data`, empty when `blocked` is false. securitySchemes: api_key: type: apiKey in: header name: api-key description: >- Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application. jwt_key: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.