---
updatedAt: 2026-04-21T16:06:54.000Z
agentTools:
  projectIndex: https://canopy-api.readme.io/llms.txt
---

# Get the minimum payment for a line of credit

Gets the minimum payment for a line of credit.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Canopy Servicing Core API",
    "description": "\nCanopy allows you to easily manage credit, installment, or other more complex lending programs from a servicing and compliance perspective -\nwhether newly launched or migrated from existing systems. using canopy, you can track balances and transactions for each customer of your product, both in real-time and historically.\nYou can see how various policy and product changes would impact your customers, and readily generate compliance reports and minimize your risk with all real-time information always on hand.\nCanopy additionally surfaces information around all of your lending activity through its intuitive ui which provides a customer support interface as well as at-a-glance data needed for compliance and insights.\nSimply configure your product`s policies through our create product api endpoint, and then you can immediately begin adding customer accounts and relying on canopy for accurate servicing information.\n",
    "contact": {
      "name": "Canopy Support",
      "url": "https://www.canopyservicing.com/contact",
      "email": "support@canopyservicing.com"
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "Contact sales to enable your sandbox",
      "description": "Your private sandbox environment"
    },
    {
      "url": "https://demo-api.us.canopyservicing.com",
      "description": "Demo environment"
    }
  ],
  "paths": {
    "/revolving/v1/accounts/{account_id}/line_of_credit/{line_of_credit_id}/min_pay": {
      "get": {
        "tags": [
          "Lines of Credit"
        ],
        "summary": "Get the minimum payment for a line of credit",
        "description": "Gets the minimum payment for a line of credit.",
        "operationId": "LineOfCreditCBV_get_min_pay_revolving_v1_accounts__account_id__line_of_credit__line_of_credit_id__min_pay_get",
        "security": [
          {
            "HTTPBearer": []
          }
        ],
        "parameters": [
          {
            "name": "account_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "title": "Account Id"
            }
          },
          {
            "name": "line_of_credit_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "title": "Line Of Credit Id"
            }
          },
          {
            "name": "effective_at",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "description": "The date to calculate the minimum payment as of.",
              "title": "Effective At"
            },
            "description": "The date to calculate the minimum payment as of."
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the minimum payment for a line of credit",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LineOfCreditMinPayResponse"
                }
              }
            }
          },
          "404": {
            "description": "Entity not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrNotFoundSchema"
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          },
          "500": {
            "description": "A server error has occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrServerErrorSchema"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ErrNotFoundSchema": {
        "properties": {
          "message": {
            "type": "string",
            "title": "Message",
            "description": "The error message",
            "examples": [
              "Entity not found."
            ]
          }
        },
        "type": "object",
        "required": [
          "message"
        ],
        "title": "ErrNotFoundSchema"
      },
      "ErrServerErrorSchema": {
        "properties": {
          "message": {
            "type": "string",
            "title": "Message",
            "description": "The error message",
            "examples": [
              "A server error has occurred."
            ]
          }
        },
        "type": "object",
        "required": [
          "message"
        ],
        "title": "ErrServerErrorSchema"
      },
      "HTTPValidationError": {
        "properties": {
          "detail": {
            "items": {
              "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
          }
        },
        "type": "object",
        "title": "HTTPValidationError"
      },
      "LineOfCreditMinPayResponse": {
        "properties": {
          "account_id": {
            "type": "string",
            "title": "Account Id",
            "description": "The account id.",
            "hidden": false
          },
          "line_of_credit_id": {
            "type": "string",
            "title": "Line Of Credit Id",
            "description": "The line of credit id.",
            "hidden": false
          },
          "effective_as_of": {
            "type": "string",
            "title": "Effective As Of",
            "description": "The effective as of date.",
            "hidden": false
          },
          "due_at": {
            "type": "string",
            "title": "Due At",
            "description": "The date of the next due payment, must be made before this date-time to be considered on time.",
            "hidden": false
          },
          "graced_due_at": {
            "type": "string",
            "title": "Graced Due At",
            "description": "The date at which if no payment is made, the line of credit will be issued a late fee if one is configured.",
            "hidden": false
          },
          "total_min_pay_cents": {
            "type": "integer",
            "title": "Total Min Pay Cents",
            "description": "The total minimum payment due.",
            "hidden": false
          },
          "unpaid_min_pay_cents": {
            "type": "integer",
            "title": "Unpaid Min Pay Cents",
            "description": "The amount of the `total_min_pay_cents` that is comprised of unpaid obligations.",
            "hidden": false
          },
          "current_min_pay_cents": {
            "type": "integer",
            "title": "Current Min Pay Cents",
            "description": "The amount of the `total_min_pay_cents` that is comprised of current obligations.",
            "hidden": false
          }
        },
        "type": "object",
        "required": [
          "account_id",
          "line_of_credit_id",
          "effective_as_of",
          "due_at",
          "graced_due_at",
          "total_min_pay_cents",
          "unpaid_min_pay_cents",
          "current_min_pay_cents"
        ],
        "title": "LineOfCreditMinPayResponse"
      },
      "ValidationError": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          },
          "input": {
            "title": "Input"
          },
          "ctx": {
            "type": "object",
            "title": "Context"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      }
    },
    "securitySchemes": {
      "HTTPBearer": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "tags": [
    {
      "name": "Lines of Credit",
      "description": "Manage lines of credit for your customers in Canopy."
    }
  ]
}
```