Item Notifications

View changes in Item health and availability.

The Item notifications endpoint provides a searchable, public timeline of:

  • When new or previously removed Items are now available and support payroll connections in Link.
  • When there is a change in an Item's health status or related messaging, including when connection issues occurred.
  • When there is a change in the data fields an Item supports, or its deposit switch capabilities.
  • When an existing Item is removed from Link (uncommon).

#The Item notifications object

Attributes
  • #
    idstring (uuid)

    Unique ID of the Item notification.

  • #
    created_atstring (datetime)

    Timestamp (ISO 8601) when the Item notification was created.

  • #
    actionstring (enum)

    Item notification event.

  • #
    messagestring

    Additional messaging related to the event.

  • #
    itemobject

    Object containing Item and event information.

  • #
    idstring

    ID of the Item related to the Item notification.

  • #
    namestring

    Name of the Item.

  • #
    statusstring (enum)

    Health status of the Item.

  • #
    status_detailsstring

    Details the impact of status issues, such as degraded account connection ability or paused ongoing refresh. Otherwise null.

  • #
    known_limitationsstring

    Details any known limitations for the Item, such as historical data limits or unique behavior. Otherwise null.

  • #
    logo_urlstring

    URL location of the Item's logo image file.

  • #
    featuresobject

    What data fields the Item supports, and the Item's deposit switch capabilities.

  • #
    field_coverageobject

    Contains information on whether the Item returns data for a particular property within one of Argyle's data sets.

    Does not include object ID's, account ID's, or metadata. null values are returned for properties of new or uncommon Items until a determination on data availability can be made.

  • #
    identitiesobject

    All data fields of the identity object.

  • #
    paystubsobject

    All data fields of the paystub object.

  • #
    payroll_documentsobject

    All data fields of the payroll document object.

  • #
    deposit_destinationsobject

    All data fields of the deposit destination object.

  • #
    shiftsobject

    All data fields of the shift object.

  • #
    gigsobject

    All data fields of the gig object.

  • #
    shiftsobject

    (Upcoming release) All data fields of the shift object.

  • #
    vehiclesobject

    All data fields of the vehicle object.

  • #
    ratingsobject

    All data fields of the rating object.

  • #
    direct_deposit_switchobject

    Contains information on the Item's deposit switch capabilities.

  • #
    cardobject

    Card update capabilities.

  • #
    supportedboolean

    true if the Item supports adding debit cards to the user's account through Link.

    Generally applies to gig platforms, where users can send instant payouts to the added debit card.

  • #
    max_allocationsstring (integer)

    Number of debit cards that can be added to the Item's underlying platform.

  • #
    deposit_accountobject

    Direct deposit capabilities.

  • #
    typesarray of strings

    The types of bank accounts supported.

  • #
    supportedboolean

    true if the Item supports deposit switching.

  • #
    max_allocationsstring (integer)

    Number of total bank accounts supported by the Item's underlying platform.

  • #
    amount_allocationboolean

    true if the Item's direct deposit settings support using exact amounts to define how pay is allocated to different bank accounts.

  • #
    percent_allocationboolean

    true if the Item's direct deposit settings support using exact percentages of total pay to define how pay is allocated to different bank accounts.

  • #
    amount_precisionstring (enum)

    What level of precision is allowed when setting amount allocations.

  • #
    percent_precisionstring (enum)

    What level of precision is allowed when setting percentage allocations.

Example
1{
2  "id": "47b216e2-d334-4235-bc1e-185d15ab18d0",
3  "created_at": "2023-01-30T23:39:34.962Z",
4  "action": "updated",
5  "message": "Whole Goods is performing maintenance. Expected downtime: 4 hours.",
6  "item": {
7    "id": "item_123456789",
8    "name": "Whole Goods",
9    "status": "unavailable",
10    "status_details": "New connections and ongoing refresh paused.",
11    "known_limitations": "Last 2 digits of SSN are available. The rest are obfuscated.",
12    "logo_url": "https://...",
13    "features": {
14      "field_coverage": {
15        "identities": {
16          "first_name": {
17            "supported": true
18          },
19          "last_name": {
20            "supported": true
21          },
22          "...": {
23            "supported": true
24          }
25        },
26        "paystubs": {
27          "...": {
28            "supported": true
29          }
30        },
31        "payroll_documents": {
32          "...": {
33            "supported": true
34          }
35        },
36        "deposit_destinations": {
37          "...": {
38            "supported": true
39          }
40        },
41        "shifts": {
42          "...": {
43            "supported": true
44          }
45        },
46        "gigs": {
47          "...": {
48            "supported": true
49          }
50        },
51        "vehicles": {
52          "...": {
53            "supported": true
54          }
55        },
56        "ratings": {
57          "...": {
58            "supported": true
59          }
60        }
61      },
62      "direct_deposit_switch": {
63        "card": {
64          "supported": true,
65          "max_allocations": "3"
66        },
67        "deposit_account": {
68          "types": [
69            "ach_deposit_account"
70          ],
71          "supported": true,
72          "max_allocations": "2",
73          "amount_allocation": false,
74          "percent_allocation": true,
75          "amount_precision": null,
76          "percent_precision": "0.01"
77        }
78      }
79    }
80  }
81}

#List all Item notifications

get/v2/item-notifications

Returns an array of all Item notifications.

Query parameters
  • #
    limitinteger
    optional

    Number of Item notifications returned per page. Default: 10. Maximum: 200.

  • #
    itemstring
    optional

    Filter Item notifications by Item ID.

  • #
    actionstring (enum)
    optional

    Filter by action.

  • #
    statusstring (enum)
    optional

    Filter by status.

  • #
    kindstring (enum)
    optional

    Filter for Item's with a specific kind value (see Items).

  • #
    from_created_atstring (datetime)
    optional

    Filter for Item notifications created on or after this timestamp. Format is ISO 8601.

  • #
    to_created_atstring (datetime)
    optional

    Filter for Item notifications created on or before this timestamp. Format is ISO 8601.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/item-notifications?limit=3 \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1[
2  {
3    "id": "47b216e2-d334-4235-bc1e-185d15ab18d0",
4    "created_at": "2023-01-31T03:23:45.827Z",
5    "action": "updated",
6    "message": "Whole Goods maintenance still in progress. Expected completion in 2 hours.",
7    "item": {
8      "id": "item_123456789",
9      "name": "Whole Goods",
10      "status": "unavailable",
11      "status_details": null,
12      "known_limitations": "Last 2 digits of SSN are available. The rest are obfuscated.",
13      "logo_url": "https://...",
14      "features": {
15        "field_coverage": {
16          "...": "..."
17        },
18        "direct_deposit_switch": {
19          "card": {
20            "...": "..."
21          },
22          "deposit_account": {
23            "...": "..."
24          }
25        }
26      }
27    }
28  },
29  {
30    "id": "47b216e2-d334-4235-bc1e-185d15ab18d0",
31    "created_at": "2023-01-31T05:13:54.372Z",
32    "action": "created",
33    "message": "Service to Whole Goods has been restored.",
34    "item": {
35      "id": "item_123456789",
36      "name": "Whole Goods",
37      "status": "healthy",
38      "status_details": null,
39      "known_limitations": "Last 2 digits of SSN are available. The rest are obfuscated.",
40      "logo_url": "https://...",
41      "features": {
42        "field_coverage": {
43          "...": "..."
44        },
45        "direct_deposit_switch": {
46          "card": {
47            "...": "..."
48          },
49          "deposit_account": {
50            "...": "..."
51          }
52        }
53      }
54    }
55  },
56  {
57    "id": "e2b5bf05-d84b-44c3-b48e-2c0beec83bdf",
58    "created_at": "2023-01-31T12:39:34.962Z",
59    "action": "updated",
60    "message": "Intermittent connection issues fully resolved.",
61    "item": {
62      "id": "item_000000001",
63      "name": "Half Bads",
64      "status": "healthy",
65      "status_details": null,
66      "known_limitations": null,
67      "logo_url": "https://...",
68      "features": {
69        "field_coverage": {
70          "...": "..."
71        },
72        "direct_deposit_switch": {
73          "card": {
74            "...": "..."
75          },
76          "deposit_account": {
77            "...": "..."
78          }
79        }
80      }
81    }
82  }
83]
Updating Argyle status...
┬ę 2024 Argyle Systems Inc.argyle.com