microdeposits

List all microdeposits for a user

Changed on

Use this endpoint to read the attributes of a specific microdeposit according to its unique GUID.

get/users/{user_guid}/micro_deposits

Request

  • Base URL
    https://int-api.mx.com
  • URL
    https://int-api.mx.com/users/{user_guid}/micro_deposits
  • Auth
    HTTP basic

Path parameters

user_guidstring required

The unique identifier for a user, beginning with the prefix USR-.

Response

OK

Example response

{
  "micro_deposits": [
    {
      "guid": "MIC-09ba578e-8448-4f7f-89e1-b62ff2517edb",
      "institution_code": "mxbank",
      "institution_name": "MX Bank",
      "status": "INITIATED",
      "updated_at": "2023-06-01T19:18:06Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 25,
    "total_entries": 1,
    "total_pages": 1
  }
}

Changes

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the / response's property type changed from no type to object for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      api operation id listUserMicrodeposits was added

    • info

      endpoint added