Learn about the /link-items and /search/link-items endpoints.
Link items are employers and payroll providers that a user can select in Argyle Link when they are connecting their payroll accounts. The full list of Link items can be found in Argyle Console on the Coverage tab.
Attributes
| Attribute | Type | Description |
|---|---|---|
| id | string | Unique ID of the Link item. Link item IDs are usually human-readable, but not always. For human-readable values, you can refer to the name attribute. |
| item_id | string uuid | Unique ID of the Link item. This ID is not human-readable. |
| status | string | Provides information on the health of a particular Link item. The healthy value indicates successful account connections. When Link items are experiencing issues and connections are not successful or partially degraded, the value will be issues. In this case, the status_details field can be used to provide additional information about the Link item’s status.Possible values: healthy, issues. |
| status_details | string | The status_details field can be used to provide additional information about a particular Link item’s status. When status_details is not filled, the value returned will be null. |
| name | string | Name of the Link item—for example, Wellmart, Udre, Gusta. |
| type | string | Type of the Link item—for example, delivery, retail, rideshare, services, technology. |
| kind | string | Type of the Link item. Possible values: employer, gig, platform, benefits. |
| logo_url | string | A URL to the Link item logo. Authentication is required to access this field. |
| is_disabled | boolean | Will be true if the Link item is disabled. Link items are disabled if there is an issue with the underlying payroll provider. |
| has_two_fa | boolean | Will be true if the underlying payroll provider requires two-factor authorization to log in. |
| features | array of objects See underlying objects | Contains information about the direct deposit switching capabilities of a given Link item. |
| known_limitations | string | Describes Item's known limitations—for example, how far back historical data goes, degree of value obfuscation (if any). |
Objects within features
features| Attribute | Type | Description |
|---|---|---|
| pay_distribution_update | object See underlying attributes | Contains information about direct deposit switching: bank account update capabilities for a given Link item. Refer to Direct deposit switching for more information. |
| pay_distribution_card_update | object See underlying attributes | Contains information about direct deposit switching: card update capabilities of a given Link item. |
Attributes of pay_distribution_update
pay_distribution_update| Attribute | Type | Description |
|---|---|---|
| supported | boolean | Denotes if the Link item supports direct deposit updates for bank accounts. If false, the features fields will not be shown in the API response. |
| required_fields | object See underlying attributes | Contains information about fields required for a successful direct deposit update. |
| max_allocations | integer | Denotes the maximum amount of allocations an account can have in the given Link item for bank accounts. |
| amount_allocation | boolean | Denotes if the Link item allows setting amount allocations for bank accounts—for example, $500 to one bank account and remained to another. |
| percent_allocation | boolean | Denotes if the Link item allows setting percent allocations for bank accounts—for example, 60% to one bank account and remained to another. |
| amount_precision | integer optional | Denotes the level of granularity of the amount for bank accounts in your DDS configuration. This way you can define the amount up to the cent level of detail - with 2 decimals. Possible values: 100, 10, 1, 0.1, 0.01Note: null values indicate no precision has been set. Any value can be provided in your DDS configuration, where the default precision is 0.01. |
| percent_precision | integer optional | Denotes the level of granularity of the percentage for bank accounts in your DDS configuration. This way you can define the percentage of the pay allocation with up to the 4 decimal places. Possible values: 100, 10, 1, 0.1, 0.01, 0.001, 0.0001.Note: null values indicate no precision has been set. Any value can be provided in your DDS configuration, where the default precision is 0.01. |
| action_types | list of strings | Lists string enum values that indicate what types of actions are required by the Link item to make any newly added allocations active for bank accounts. If no action is required, then an empty list is returned. Possible values: microdeposit_verification. |
Attributes of required_fields for pay_distribution_update
required_fields for pay_distribution_update| Attribute | Type | Description |
|---|---|---|
| bank_account | list of strings | Lists the fields required by a given Link item to successfully update a direct deposit for bank accounts. |
Attributes of pay_distribution_card_update
pay_distribution_card_update| Attribute | Type | Description |
|---|---|---|
| supported | boolean | Denotes if the Link item supports card deposit switching updates. If false, the features fields will not be shown in the API response. |
| required_fields | object See underlying attributes | Contains information about fields required for a successful direct deposit update. |
| max_allocations | integer | Return Link items with the specified number of maximum allocations allowed. |
Attributes of required_fields for pay_distribution_card_update
required_fields for pay_distribution_card_update| Attribute | Type | Description |
|---|---|---|
| card | list of strings | Lists the fields required by a given Link item to successfully update a deposit update for cards. |
Argyle recommends populating every field in the
cardobject when creating a DDS configuration for cards, including the optional fields. Doing so enables compatibility with all payroll providers that support adding cards for payouts.
Endpoints
These are the endpoints available for link-items.
| Endpoints |
|---|
Retrieve a Link item - GET /link-items/:id |
List Link items - GET /link-items |
Search Link items - GET /search/link-items |
Example object
{
"id": "starbox",
"item_id": "0176ba6f-c70b-45a8-bd6e-6d7e13b9bfad",
"known_limitations": "Starbox only makes the past 2 years of Payouts data available.",
"status": "issues",
"status_details": "Following Starbox's acquisition of Starbox, most Starbox services have been switched off as of 2021-07-15. In Link, users who search for Starbox are now asked to connect their Walmart account instead.",
"name": "Starbox",
"type": "retail",
"has_two_fa": false,
"is_disabled": false,
"kind": "employer",
"logo_url": "https://company.com/logo.jpg",
"features": {
"pay_distribution_update": {
"supported": true,
"max_allocations": 8,
"amount_allocation": true,
"percent_allocation": false,
"amount_precision": "0.01",
"percent_precision": null,
"action_types": [],
"required_fields": {
"bank_account": [
"routing_number",
"account_number",
"account_type"
]
},
},
"pay_distribution_card_update": {
"supported": true,
"max_allocations": 1,
"required_fields": {
"card": [
"card_number",
"card_cvc_cvv",
"expiration_year",
"expiration_month",
"postal_code"
]
}
}
}
}