Skip to main content
POST
/
v3
/
{customerId}
/
prepayment
/
login
/
{LoginId}
/
{RequestId}
Prepayment
curl --request POST \
  --url https://{instance}-api.private.fin.ag/v3/{customerId}/prepayment/login/{LoginId}/{RequestId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "LoanFrequency": "Monthly"
}
'
{
  "UserInformation": {},
  "AccountsInformation": [
    {}
  ]
}
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

NAMETYPEDESCRIPTION
NamestringThe full name of the user that has connected their account.
AddressstringThe full civic address of the user that has connected their bank account.
EmailstringThe email address of the user that has connected their bank account. This value is null if unavailable.
EFTEligibleAccountsstringA count of accounts (displayed below in lists) that are eligible to be set up for EFT or ACH payments.
AccountNamestringThe name of the account as it is at the Financial Institution.
AccountNumberstringThe full account number of the account as it is at the Financial Institution. To be used to setup payments.
InstitutionNumberstringThe institution number of the Financial Institution linked. To be used to setup payments.
SortCodestringThe sort-code of the Financial Institution and Account linked. To be used to setup payments.
RoutingNumberstringThe routing number (if available) of the Financial Institution and Account linked. To be used to setup payments.
OptimalPaymentslistA list of payments that correspond with the scheduled frequency and duration as passed within the request. For example, a duration of four will generate four distinct dates within this list. These dates are the most optimal dates within the calendar week where a payment of the requested frequency and amount are identified to be the most successful. Format of date is MM/DD/YYYY.
OptimalDaystringA textual field that represents the most optimal day of the week (limited to Monday-Friday) to initiate a payment given the amount requested. This field should be used if the OptimalPayments schedule above is not attainable for a given user. Responses can be any of: Monday, Tuesday, Wednesday, Thursday, or Friday.
OverallPaymentRiskstringA decimal field that represents the percentage chance of a payment of the submitted amount failing at any point in the future. I.e. What is the risk that the given user’s balance falls below the expected repayment amount on any day in the future. A 1.00 response (100%) indicates that the user will never have enough money within their account to perform the required payment, whereas a 0.00 response (0%) indicates that the user will always have enough money in their account to perform the required payment. This is not a credit risk estimation, it is simply a cash flow projection.
NSFsLast90DaysstringA count of NSFs that have occurred within the last 90 days. To be used to understand the direct risk of that user not having sufficient funds as per their direct history.
StopPaymentsLast90DaysstringA count of stop payments that have occurred within the last 90 days. To be used to understand the direct risk of a user initiating a stop on any payments as per their direct history.
FrequencystringA pass-through of the requested frequency of payments.
PaymentDateslistA non-optimized list of dates (following the same format as the OptimalPayments list above. This list simply returns the exact dates that are requested based on the frequency and duration, with no optimization performed.
DatedateThe anticipated date of funding for the initial deposit.
AmountstringThe anticipated amount of funding for the initial deposit.

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.