---
title: "Prepayment"
method: POST
path: "/v3/{customerId}/prepayment/login/{LoginId}/{RequestId}"
tags: ["Enrich"]
---

# Prepayment

`POST /v3/{customerId}/prepayment/login/{LoginId}/{RequestId}`

Use this endpoint to submit additional information on a given end-user and retrieve Payment Optimization insights.

## Path parameters

- `customerId` string, required
- `LoginId` string, required
- `RequestId` string, required

## Request body

- object
  - `LoanFrequency` 'Weekly' | 'BiWeekly' | 'BiMonthly' | 'Monthly' — Input that defines the frequency to be used in calculating the optimal days of payment.
  - `ExpectedRepaymentTotal` string — Submitted value that represents the entire amount that will be repaid back at the end of the given duration/term.
  - `FundingDate` string — The date that a funding event is expected to occur. Format should be in YYYY-MM-DD.
  - `Duration` string — An integer corresponding with how many payments are expected to take place.

## Response `200`

Successful Request

- object
  - `UserInformation` object — Object containing user details.
  - `AccountsInformation` object[] — Array of account objects containing payment optimization details.

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/flinks/apis/flinks-api.md) · [All operations](https://skmtc.net/flinks/apis/flinks-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flinks/flinks-api/versions/0983646f91b4/schema)
