Nexus API
Create or Preinitiate a Microdeposit
Use this endpoint to create a microdeposit. To create a microdeposit include the first_name, last_name, email, account_number, routing_number, and account_type in the request body. The response will include the new microdeposit record with a status of INITIATED.
You can also use this endpoint to pre-initiate a microdeposit. If you want to preinitiate only include the first_name, last_name, and email in the request body. The response will include the new microdeposit record with a status of PREINITIATED.
Pre-initiating a microdeposit is optional. However, if you choose to implement this flow, it should be used for all Connect Widget sessions in verification mode.
Pre-initiating a microdeposit enables you to pass the end user's first name, last name, and email, if this data has already been collected. If the end user selects an institution which requires the microdeposit flow, the pre-initiated micro_deposit will be used and the Connect Widget step that normally requests this info from the end user will be skipped. However, if the end user selects an institution which supports IAV, the pre-initiated micro_deposit will be deleted and IAV will be used instead. When requesting a Connect Widget URL after pre-inititiating, make sure to set the current_microdeposit_guid to the resulting microdeposit's guid and set the mode to verification.
Request Body
| Field | Required | Type |
|---|---|---|
micro_deposit | Required | Object |