microdeposits

Read a microdeposit for a user

Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID. <br></br> Webhooks for microdeposit status changes are triggered when a status changes. The actual status of the microdeposit guid updates every minute. You may force a status update by calling the read microdeposit endpoint.

get/users/{user_guid}/micro_deposits/{micro_deposit_guid}

Response

OK

Example response

{
  "micro_deposit": [
    {
      "account_name": "My test account",
      "account_number": "3331261",
      "account_type": "CHECKING",
      "email": "joshyboy2@example.com",
      "first_name": "Joshy",
      "last_name": "Grobanne",
      "routing_number": "091000019",
      "guid": "MIC-09ba578e-8448-4f7f-89e1-b62ff2517edb",
      "institution_code": "mxbank",
      "institution_name": "MX Bank",
      "status": "INITIATED",
      "updated_at": "2023-06-01T19:18:06Z"
    }
  ]
}

Changes

Changed in 2 of the 50 revisions of this API.162

  • e74cd2b059b5161See the full diff
    • deleted the path request parameter micro_deposit_guid

      request-parameter-removed

    • deleted the path request parameter user_guid

      request-parameter-removed

    • removed the optional property micro_deposit/account_name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property micro_deposit/account_number from the response with the 200 status

      response-optional-property-removed

    • removed the optional property micro_deposit/account_type from the response with the 200 status

      response-optional-property-removed

    • removed the optional property micro_deposit/email from the response with the 200 status

      response-optional-property-removed

    • removed the optional property micro_deposit/error_message from the response with the 200 status

      response-optional-property-removed

    • removed the optional property micro_deposit/first_name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property micro_deposit/guid from the response with the 200 status

      response-optional-property-removed

    • removed the optional property micro_deposit/institution_code from the response with the 200 status

      response-optional-property-removed

    • removed the optional property micro_deposit/institution_name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property micro_deposit/last_name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property micro_deposit/routing_number from the response with the 200 status

      response-optional-property-removed

    • removed the optional property micro_deposit/status from the response with the 200 status

      response-optional-property-removed

    • removed the optional property micro_deposit/updated_at from the response with the 200 status

      response-optional-property-removed

    • removed the optional property micro_deposit/verified_at from the response with the 200 status

      response-optional-property-removed

    • api operation id readUserMicrodeposit was added

      api-operation-id-added

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

Of the 50 revisions, 1 has no diff computed.