> ## Documentation Index > Fetch the complete documentation index at: /llms.txt > Use this file to discover all available pages before exploring further. # Blocklist batch status ## OpenAPI ````yaml get /blocklist/batch/{job_id} 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 paths: /blocklist/batch/{job_id}: get: tags: - Blocklist operationId: Get batch blocklist job status parameters: - name: job_id in: path description: >- The job ID returned by the batch upload endpoint, or the export ID returned by `POST /blocklist/export` required: true schema: type: string - 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: >- Batch blocklist job status. For a completed export whose file is still stored, this is where the short-lived `download_url` is issued. content: application/json: schema: $ref: '#/components/schemas/BatchBlocklistJobStatusResponse' '404': description: Job not found security: - api_key: [] - jwt_key: [] components: schemas: BatchBlocklistJobStatusResponse: type: object description: >- One batch blocklist job, as returned by the listing and by `GET /blocklist/batch/{job_id}`. required: - job_id - merchant_id - job_type - status - total_rows - succeeded_rows - failed_rows - created_at - updated_at - downloadable properties: job_id: type: string merchant_id: type: string profile_id: type: string description: >- The profile that owns this job; for a clone job, the profile whose entries are copied. example: pro_abcdefghijklmnop nullable: true job_type: $ref: '#/components/schemas/BatchBlocklistJobType' file_name: type: string description: >- The file the merchant uploaded, or the name the export downloads as. Clone jobs return `null`. nullable: true status: $ref: '#/components/schemas/BatchBlocklistJobStatus' total_rows: type: integer format: int32 minimum: 0 succeeded_rows: type: integer format: int32 minimum: 0 failed_rows: type: integer format: int32 minimum: 0 metadata: allOf: - $ref: '#/components/schemas/ProfileCloneJobMetadata' nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time expires_at: type: string format: date-time description: >- Exports only: when the stored file is removed by the storage lifecycle rule. nullable: true downloadable: type: boolean description: Whether this job's file can be fetched right now. error_message: type: string nullable: true download_url: type: string description: >- Exports only: short-lived signed link, generated per request and never stored. Null in the listing, which does not mint a link per row. nullable: true download_url_expires_at: type: string format: date-time nullable: true BatchBlocklistJobType: type: string description: Distinguishes bulk upload, CSV export, and profile clone jobs. enum: - upload - export - profile_clone BatchBlocklistJobStatus: type: string enum: - initiated - processing - completed - failed ProfileCloneJobMetadata: type: object description: Progress of a profile-clone job across its target profiles. required: - targets properties: targets: type: array items: $ref: '#/components/schemas/ProfileCloneTargetMetadata' ProfileCloneTargetMetadata: type: object description: Progress of one target profile within a profile-clone job. required: - profile_id - status - processed_rows properties: profile_id: type: string example: pro_abcdefghijklmnop status: $ref: '#/components/schemas/BatchBlocklistJobStatus' processed_rows: type: integer format: int32 description: Source entries handled so far for this target. minimum: 0 error_message: type: string description: Present when this target's clone failed. nullable: true 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 ````