Create or pre-initiate a microdeposit
Use this endpoint to create or pre-initiate a microdeposit. The response will include the new microdeposit record with a status of INITIATED or PREINITIATED respectively.
To pre-initiate a microdeposit, you only need to set email (string), first_name (string), and last_name (string) in the request body.
Pre-initiating a microdeposit allows 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-initiating, make sure to set the current_microdeposit_guid to the resulting microdeposit's guid and set data_request.products to include account_verification. If you use this enhanced flow, a micro_deposit should be pre-initiated for all connect sessions in verification mode. After pre-initiating a microdeposit, pass the GUID to the config as current_microdeposit_guid and set data_request.products to include account_verification when requesting a Connect URL. Pre-initiating a microdeposit is optional. If you choose to implement this flow, it should be used for all Connect Widget sessions in verification mode.
Path Parameters
| Field | Required | Type |
|---|---|---|
user_guid The unique identifier for a | Required | String |
Header Parameters
| Field | Required | Type |
|---|---|---|
Accept-Version MX Platform API version. | Required | String |
Request Body
| Field | Required | Type |
|---|---|---|
micro_deposit | Required | MicrodepositElements |