> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Record repayment

> Records a repayment allocation for an active loan account. Idempotency is enforced in the use case via the X-Request-ID header (X-Idempotency fallback): a reused request ID with different facts yields 409. A malformed UUID or amount yields 422.



## OpenAPI

````yaml en/openapi/v3-current/lender.yaml post /api/v1/loan-accounts/{id}/repayments
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: Code-first OpenAPI 3.1 surface for the Lender service.
  license:
    name: Lerian Studio General License
  title: Lender API
  version: 1.0.0
servers:
  - url: https://lender.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - description: >-
      Ledger accounting operations: journal entries and accrual postings for
      loan accounts.
    name: Accounting
  - description: >-
      Loan application intake and lifecycle: submission, decisioning, and
      status.
    name: LoanApplications
  - description: >-
      Loan product catalog: definition, versioning, and activation of lending
      products.
    name: LoanProducts
  - description: >-
      Loan account servicing operations: balances, schedules, and account-level
      actions.
    name: Loan Accounts
  - description: >-
      Servicing read operations: repayment schedules and servicing state for
      loan accounts.
    name: Servicings
  - description: >-
      Portfolio dashboard read operations: aggregated portfolio and performance
      views.
    name: Dashboard
  - description: >-
      Jurisdiction registry: supported jurisdiction profiles and their
      capabilities.
    name: Jurisdictions
  - description: >-
      Jurisdiction-specific loan application operations (Brazil origination
      surface).
    name: Loan Applications
  - description: >-
      Tax computation operations for jurisdiction-specific lending (e.g. Brazil
      IOF).
    name: Tax
  - description: >-
      Brazil consignado privado operations: contract origination (contratação
      ativa) and lifecycle.
    name: Consignado
paths:
  /api/v1/loan-accounts/{id}/repayments:
    post:
      tags:
        - Loan Accounts
      summary: Record repayment
      description: >-
        Records a repayment allocation for an active loan account. Idempotency
        is enforced in the use case via the X-Request-ID header (X-Idempotency
        fallback): a reused request ID with different facts yields 409. A
        malformed UUID or amount yields 422.
      operationId: recordRepayment
      parameters:
        - description: Loan account identifier (UUID).
          in: path
          name: id
          required: true
          schema:
            description: Loan account identifier (UUID).
            examples:
              - 550e8400-e29b-41d4-a716-446655440000
            format: uuid
            type: string
        - description: >-
            Canonical idempotency request ID. Falls back to X-Idempotency when
            absent.
          in: header
          name: X-Request-ID
          schema:
            description: >-
              Canonical idempotency request ID. Falls back to X-Idempotency when
              absent.
            examples:
              - 550e8400-e29b-41d4-a716-446655440010
            type: string
        - description: Fallback idempotency request ID used when X-Request-ID is absent.
          in: header
          name: X-Idempotency
          schema:
            description: Fallback idempotency request ID used when X-Request-ID is absent.
            examples:
              - 550e8400-e29b-41d4-a716-446655440011
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RepaymentRequestHumaBody'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepaymentRecordHumaBody'
          description: Created
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    RepaymentRequestHumaBody:
      additionalProperties: false
      properties:
        amount:
          description: >-
            Repayment amount in major currency units (e.g. "125.00"). Must be
            positive with at most 2 fractional digits.
          examples:
            - '125.00'
          type: string
        effectiveDate:
          description: ISO-8601 or YYYY-MM-DD effective date.
          examples:
            - '2026-06-14'
          type: string
        transactionDate:
          description: >-
            ISO-8601 or YYYY-MM-DD transaction date (fallback when effectiveDate
            is absent).
          examples:
            - '2026-06-14'
          type: string
      required:
        - amount
      type: object
    RepaymentRecordHumaBody:
      additionalProperties: false
      properties:
        allocations:
          description: Per-installment allocation breakdown.
          items:
            $ref: '#/components/schemas/RepaymentAllocationHumaBody'
          type:
            - array
            - 'null'
        appliedAmount:
          description: Amount applied to the loan (2 d.p. string).
          examples:
            - '125.00'
          type: string
        backdated:
          description: True if the repayment effective date is before the business date.
          type: boolean
        effectiveDate:
          description: ISO-8601 effective date applied to the repayment.
          examples:
            - '2026-06-14'
          type: string
        loanAccountId:
          description: Loan account UUID.
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        overpaymentAmount:
          description: Excess amount above total outstanding (2 d.p. string).
          examples:
            - '0.00'
          type: string
        requestId:
          description: Idempotency request ID echoed from the request.
          examples:
            - 550e8400-e29b-41d4-a716-446655440010
          type: string
        transactionId:
          description: Recorded repayment transaction UUID.
          examples:
            - 550e8400-e29b-41d4-a716-446655440001
          type: string
      required:
        - transactionId
        - loanAccountId
        - effectiveDate
        - allocations
        - appliedAmount
        - overpaymentAmount
        - backdated
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    RepaymentAllocationHumaBody:
      additionalProperties: false
      properties:
        dueDate:
          description: ISO-8601 installment due date.
          examples:
            - '2026-06-14'
          type: string
        feesAmount:
          description: Fees component (2 d.p. string).
          examples:
            - '3.50'
          type: string
        fullyPaid:
          description: True if this installment is fully settled.
          type: boolean
        installmentNumber:
          description: 1-based installment sequence number.
          examples:
            - 3
          format: int64
          type: integer
        interestAmount:
          description: Interest component (2 d.p. string).
          examples:
            - '20.00'
          type: string
        penaltiesAmount:
          description: Penalties component (2 d.p. string).
          examples:
            - '1.50'
          type: string
        principalAmount:
          description: Principal component (2 d.p. string).
          examples:
            - '100.00'
          type: string
        totalAmount:
          description: Total installment amount (2 d.p. string).
          examples:
            - '125.00'
          type: string
      required:
        - installmentNumber
        - dueDate
        - principalAmount
        - interestAmount
        - feesAmount
        - penaltiesAmount
        - totalAmount
        - fullyPaid
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````