# Get overdraft product

Get details of a specific overdraft product.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Banking - Overdraft",
    "version": "1.0.0",
    "description": "This API manages overdraft functionality, allowing account holders to perform debit transactions even with an insufficient balance. Additionally, it enables the configuration of grace periods and interest rates for overdrafts.",
    "contact": {
      "name": "API Support",
      "url": "https://developers.pismo.io/support/"
    },
    "license": {
      "name": "Copyright Pismo"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io/overdraft",
      "description": "Sandbox API server for testing"
    }
  ],
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Product",
      "description": "Endpoints that manage overdraft products"
    }
  ],
  "components": {
    "parameters": {
      "productIdPath": {
        "name": "productId",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string",
          "format": "uuid"
        },
        "description": "Overdraft product ID",
        "example": "2c336e9d-d04f-4fd0-8f6e-25808f48d70c"
      }
    },
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code",
            "example": "EOVD0001"
          },
          "message": {
            "type": "string",
            "description": "Error message",
            "example": "Error"
          },
          "details": {
            "type": "string",
            "description": "Details about the error",
            "example": "Error details"
          }
        }
      },
      "ProcessingCode": {
        "type": "object",
        "properties": {
          "interest_processing_code": {
            "type": "string",
            "description": "Processing code for interest calculation",
            "example": "123456"
          }
        },
        "required": [
          "interest_processing_code"
        ]
      },
      "Product": {
        "type": "object",
        "properties": {
          "product_id": {
            "type": "string",
            "format": "uuid",
            "description": "Product ID generated for an overdraft product. Once this ID is created, you must link it to your account ID."
          },
          "name": {
            "type": "string",
            "description": "Produt name",
            "example": "Overdraft Limit 1000"
          },
          "interest_plan_id": {
            "type": "string",
            "format": "uuid",
            "description": "Interest plan ID generated during the plan's creation. Created via the [Create interest plan](https://developers.pismo.io/pismo-docs/reference/post-v1-interest-plan-1) endpoint."
          },
          "grace_period": {
            "type": "integer",
            "description": "Grace period during which you can restore the balance without incurring any interest charges. The unit is measured in days."
          },
          "processing_code": {
            "$ref": "#/components/schemas/ProcessingCode"
          },
          "status": {
            "type": "string",
            "format": "enum",
            "description": "Overdraft product status.<br>\n* `CREATED`: When you successfully created an overdraft product.\n* `ACTIVE`: When you attach your overdraft product to an account or a program ID. Once it's attached, the product becomes `ACTIVE`.\n",
            "enum": [
              "CREATED",
              "ACTIVE"
            ]
          },
          "created_at_datetime": {
            "type": "string",
            "format": "date-time",
            "description": "Product created datetime. Format: `YYYY-MM-DDThh:mm:ss.sss`.\n"
          }
        }
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "responses": {
      "200GetOverdraftProductResponse": {
        "description": "Get product details successful",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Product"
            },
            "examples": {
              "Get overdraft product successful": {
                "$ref": "#/components/examples/200201ProductCreatedSuccessfulExample"
              }
            }
          }
        }
      },
      "400GetOverdraftProductErrorResponse": {
        "description": "Bad request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "Invalid product_id path parameter": {
                "$ref": "#/components/examples/EOVD0073"
              },
              "Invalid product ID format": {
                "$ref": "#/components/examples/EOVD0074"
              },
              "Metadata validation error": {
                "$ref": "#/components/examples/EOVD0075"
              },
              "Unicode escape sequence error": {
                "$ref": "#/components/examples/EOVD0076"
              }
            }
          }
        }
      },
      "404GetOverdraftProductErrorResponse": {
        "description": "Not found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "Product not found": {
                "$ref": "#/components/examples/EOVD0047"
              }
            }
          }
        }
      },
      "500GetOverdraftProductErrorResponse": {
        "description": "Internal server error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "examples": {
              "Failed to get product": {
                "$ref": "#/components/examples/EOVD0048"
              }
            }
          }
        }
      }
    },
    "examples": {
      "200201ProductCreatedSuccessfulExample": {
        "summary": "Product created successful",
        "value": {
          "product_id": "2c336e9d-d04f-4fd0-8f6e-25808f48d70c",
          "name": "Overdraft limit 1000",
          "interest_plan_id": "b935acaf-886c-4817-8f7c-c2cc3ce4d509",
          "grace_period": 10,
          "processing_code": {
            "interest_processing_code": "123456"
          },
          "status": "CREATED",
          "created_at_datetime": "2024-01-23T13:26:25"
        }
      },
      "EOVD0073": {
        "summary": "Invalid product_id path parameter",
        "value": {
          "code": "EOVD0073",
          "message": "Invalid product_id path param"
        }
      },
      "EOVD0074": {
        "summary": "Invalid product_id format",
        "value": {
          "code": "EOVD0074",
          "message": "Product ID format is invalid. Expected a valid UUID"
        }
      },
      "EOVD0075": {
        "summary": "Metadata validation error",
        "value": {
          "code": "EOVD0075",
          "message": "Metadata validation failed. Keys must be strings, and values must be ASCII strings."
        }
      },
      "EOVD0076": {
        "summary": "Unicode escape sequence error",
        "value": {
          "code": "EOVD0076",
          "message": "Request contains Unicode escape sequences, which are not allowed. Remove all Unicode escape sequences from the request."
        }
      },
      "EOVD0047": {
        "summary": "Product not found",
        "value": {
          "code": "EOVD0047",
          "message": "Product not found"
        }
      },
      "EOVD0048": {
        "summary": "Get product error",
        "value": {
          "code": "EOVD0048",
          "message": "Failed on get product"
        }
      }
    }
  },
  "paths": {
    "/v1/overdraft/{productId}": {
      "get": {
        "tags": [
          "Product"
        ],
        "summary": "Get overdraft product",
        "description": "Get details of a specific overdraft product.",
        "operationId": "get-overdraft-product",
        "parameters": [
          {
            "$ref": "#/components/parameters/productIdPath"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/200GetOverdraftProductResponse"
          },
          "400": {
            "$ref": "#/components/responses/400GetOverdraftProductErrorResponse"
          },
          "404": {
            "$ref": "#/components/responses/404GetOverdraftProductErrorResponse"
          },
          "500": {
            "$ref": "#/components/responses/500GetOverdraftProductErrorResponse"
          }
        }
      }
    }
  }
}
```