Sign in

v1

latestOpenAPI 3.0.32026-07-13347237.5 KB
Enrich

Prepayment

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

post/v3/{customerId}/prepayment/login/{LoginId}/{RequestId}

Path parameters

customerIdstring required

Key that grants access to the environment specified in the instance field.

LoginIdstring required

GUID representing end user's login ID.

RequestIdstring required

GUID representing an authorized request to the API.

Request body

LoanFrequency'Weekly' | 'BiWeekly' | 'BiMonthly' | 'Monthly'

Input that defines the frequency to be used in calculating the optimal days of payment.

ExpectedRepaymentTotalstring

Submitted value that represents the entire amount that will be repaid back at the end of the given duration/term.

FundingDatestring

The date that a funding event is expected to occur. Format should be in YYYY-MM-DD.

Durationstring

An integer corresponding with how many payments are expected to take place.

Example request

{
  "LoanFrequency": "Monthly"
}

Response

Successful Request

UserInformationobject

Object containing user details.

AccountsInformationobject[]

Array of account objects containing payment optimization details.