Skip to content

get-ifsc-lookup

Method: GET
Path: /payments/ifsc-lookup/{ifsc_code}

Tags: Payments

Summary

Lookup IFSC details

Description

Returns bank branch details for an IFSC code. Proxies Razorpay IFSC lookup; ifsc_code must match ^[A-Z]\{4\}0[A-Z0-9]\{6\}$.

Storefront SDK Usage

SDK Method: sdk.payments.verifyIfscCode()

Example:

typescript
const { data, error } = await sdk.payments.verifyIfscCode({
  ifsc_code: "HDFC0001234"
});

if (error) {
  console.error("Failed to verify IFSC:", error.message);
} else {
  console.log("Bank:", data.ifsc.bank);
  console.log("Branch:", data.ifsc.branch);
  console.log("Supports UPI:", data.ifsc.upi);
}

TypeScript Definition

typescript
"get-ifsc-lookup": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description 11-character Indian Financial System Code (IFSC). */
                ifsc_code: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message: string;
                        success: boolean;
                        content: {
                            ifsc: components["schemas"]["IfscDetail"];
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

ReferenceResolves To
components["schemas"]["IfscDetail"]IfscDetail
components["responses"]["BadRequest"]BadRequest
components["responses"]["Unauthorized"]Unauthorized
components["responses"]["NotFound"]NotFound

Parameters

  • ifsc_code (path): 11-character Indian Financial System Code (IFSC).

Responses

200

OK

400

Bad request

401

Not authorized for given operation on the Resource

404

Requested resource not found

OpenAPI Definition

json
{
  "tags": [
    "Payments"
  ],
  "operationId": "get-ifsc-lookup",
  "summary": "Lookup IFSC details",
  "description": "Returns bank branch details for an IFSC code. Proxies Razorpay IFSC lookup; `ifsc_code` must match `^[A-Z]{4}0[A-Z0-9]{6}$`.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/get-ifsc-lookup",
    "description": "API reference for the get-ifsc-lookup operation"
  },
  "parameters": [
    {
      "name": "ifsc_code",
      "in": "path",
      "description": "11-character Indian Financial System Code (IFSC).",
      "required": true,
      "schema": {
        "type": "string",
        "pattern": "^[A-Z]{4}0[A-Z0-9]{6}$"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "message",
              "success",
              "content"
            ],
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "ifsc": {
                    "$ref": "#/components/schemas/IfscDetail"
                  }
                },
                "required": [
                  "ifsc"
                ],
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "payments",
  "x-speakeasy-ignore": false,
  "x-speakeasy-name-override": "getIfscLookup"
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: