Simulate Repayments

1. A Highnote account
2. An API key or API Explorer
3. A financial account with simulated transactions and an outstanding balance

Warning: The Highnote test environment lets you explore the platform features and functionality. It is intended for experimenting, building integrations, and training your team.

To ensure the security of your real-world data, please do not enter production data in the test environment. Production data includes sensitive information like customer details, financial data, or personally identifiable information (PII).

Use only dummy or test data explicitly created for testing purposes in the test environment.

Credit and charge card products use ACH transfers to drive repayments on the Highnote platform. For more information on repayments, see Schedule Repayments.

Simulating repayments in the test environment requires the following steps:

1. Creating a payment.
2. Updating the status of the transfer.
3. Processing a transfer.

This guide provides steps for simulating repayments in the test environment.

Note: Scheduled payments are initiated by the account holder. You can not schedule a payment for an account holder in the live environment.

One-time payments can be scheduled based on a balance amount or a custom amount. A scheduled payment will not be initiated if the financial account has an OUTSTANDING_BALANCE less than or equal to $0.

In the test environment, a transfer ID will be generated within 5 minutes of scheduling a payment for today. Use the findScheduledTransferEvent query to find a transfer event ID and simulate changing the status of the transfer:

In the test environment, you can change the status of a fund in transfer from NEW to PROCESSING using the transfer ID. The simulation will allow you to view the impacts to ledgers from initiating a transfer:

In the test environment, you can change the status of a fund in transfer from PROCESSING to PROCESSED using the transfer ID. The simulation will allow you to view the impacts to ledgers from processing a transfer:

To automate your integration, subscribe to ACH repayment notification events.

The details provided in the payloads from this event can be used for the following use cases:

• Automate your application or website's repayment workflows
• Create account holder notifications or alerts
• Create status views in your application or website