Skip to main content
POST
Prepayment
Use the /Prepayment Endpoint to submit additional information on a given end-user and retrieve Payment Optimization insights that will help you and your team set the correct payment dates.

Response Fields

Path Parameters

customerId
string
default:43387ca6-0391-4c82-857d-70d95f087ecb
required

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

LoginId
string
required

GUID representing end user's login ID.

RequestId
string
required

GUID representing an authorized request to the API.

Body

application/json
LoanFrequency
enum<string>

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

Available options:
Weekly,
BiWeekly,
BiMonthly,
Monthly
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

Successful Request

UserInformation
object

Object containing user details.

AccountsInformation
object[]

Array of account objects containing payment optimization details.