post https://{instance}-api.private.fin.ag/v3/{customerId}/prepayment/login//
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
| Name | Type | Description |
|---|---|---|
| Name | string | The full name of the user that has connected their bank account |
| Address | string | The full civic address of the user that has connected their bank account |
| string | The email address of the user that has connected their bank account, null if not available. | |
| EFTEligibleAccounts | string | A count of accounts (displayed below in lists) that are eligible to be setup for EFT or ACH payments. |
| AccountName | string | The name of the account as it is at the Financial Institution. |
| AccountNumber | string | The full account number of the account as it is at the Financial Institution. To be used to setup payments. |
| InstitutionNumber | string | The institution number of the Financial Institution linked. To be used to setup payments. |
| SortCode | string | The sort-code of the Financial Institution and Account linked. To be used to setup payments. |
| RoutingNumber | string | The routing number (if available) of the Financial Institution and Account linked. To be used to setup payments. |
| OptimalPayments | list | A list of payments that correspond with the scheduled frequency and duration as passed within the request. For example, a duration of 4 will generate 4 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 most successful. Format of date is MM/DD/YYYY. |
| OptimalDay | string | A 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 utilized if the OptimalPayments schedule above is not attainable for a given user. Responses can be any of; Monday, Tuesday, Wednesday, Thursday or Friday. |
| OverallPaymentRisk | string | A 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 within their account to perform the required payment. This is not a credit risk estimation, it is simply a cash flow projection. |
| NSFsLast90Days | string | A count of NSFs that have occurred within the last 90 days. To be utilized to understand the direct risk of that user not having sufficient funds as per their direct history. |
| StopPaymentsLast90Days | string | A count of Stop Payments that have occurred within the last 90 days. To be utilized to understand the direct risk of a user initiating a stop on any payments as per their direct history. |
| Frequency | string | A pass-through of the requested frequency of repayments. |
| PaymentDates | list | A 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. |
| Date | date | The anticipated date of funding for the initial deposit. |
| Amount | string | The anticipated amount of funding for the initial deposit. |