Legacy Docs

Deposit Destinations

Where paychecks are sent, and how they are allocated.

#The deposit destination object

Attributes
  • idstring (uuid)

    Unique ID of the deposit destination.

  • accountstring (uuid)

    ID of the account associated with the deposit destination.

  • employerstring

    Employer name.

  • destination_typestring (enum)

    Destination where payouts are sent.

  • statusstring (enum)

    Whether the deposit destination is currently set to receive payments.

  • allocation_typestring (enum)

    Whether payments sent to this deposit destination are a percentage or amount of the user's total pay.

  • currencystring

    Currency (ISO 4217) in which payouts are sent to the deposit destination.

  • allocation_valuestring

    Whether this deposit destination is receiving an exact amount of the user's pay, or a remainder amount after pay has been sent other deposit destinations.

  • methodstring

    Payment method, such as direct deposit.

  • ach_deposit_accountobject

    Details for deposit destinations with a destination_type of ach_deposit_account, which pertains to U.S. bank accounts.

  • account_numberstring

    Bank account number. May be obfuscated depending on the payroll system.

  • bank_namestring

    Name of the bank.

  • routing_numberstring

    Routing number of the bank account.

  • account_typestring

    The type of bank account.

  • cardobject

    Details for deposit destinations with a destination_type of card, which pertains to debit cards or similar cards that can receive payouts.

  • card_numberstring

    Card number. Typically obfuscated.

  • card_namestring

    Card name or vendor. Typically Visa or MasterCard.

  • is_platform_cardboolean

    Whether the card is directly issued by a platform such as Uber or Lyft.

  • acss_debitobject

    Details for deposit destinations with a destination_type of acss_debit, which pertains to Canadian bank accounts that use the Automated Clearing Settlement System (ACSS).

  • account_numberstring

    Bank account number. May be obfuscated depending on the payroll system.

  • account_typestring

    The type of bank account.

  • institution_numberstring

    3-digit code that identifies the user's bank.

  • transit_numberstring

    5-digit code that identifies the bank branch.

  • created_atstring (datetime)

    Timestamp (ISO 8601) when the deposit destination object was created.

  • updated_atstring (datetime)

    Timestamp (ISO 8601) when a property value of the deposit destination object most recently changed.

  • metadataobject

    Additional, non-categorized information.

Example
1{
2  "id": "0176e1ea-60ca-c561-eb8e-6dcdb33b1b55",
3  "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
4  "employer": "Whole Goods",
5  "destination_type": "ach_deposit_account",
6  "status": "active",
7  "allocation_type": "percent",
8  "currency": "USD",
9  "allocation_value": "remainder",
10  "method": "Direct deposit",
11  "ach_deposit_account": {
12    "account_number": "123456780000",
13    "bank_name": "NW Bank",
14    "routing_number": "026010000",
15    "account_type": "savings"
16  },
17  "created_at": "2023-03-14T16:00:49.420Z",
18  "updated_at": "2023-03-14T16:00:49.420Z",
19  "metadata": {}
20}

#Retrieve a deposit destination

get/v2/deposit-destinations/{id}

Retrieves a deposit destination object.

Path parameters
  • idstring (uuid)
    required

    ID of the deposit destination object to be retrieved.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/deposit-destinations/{id} \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1{
2  "id": "0176e1ea-60ca-c561-eb8e-6dcdb33b1b55",
3  "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
4  "employer": "Whole Goods",
5  "destination_type": "ach_deposit_account",
6  "status": "active",
7  "allocation_type": "percent",
8  "currency": "USD",
9  "allocation_value": "remainder",
10  "method": "Direct deposit",
11  "ach_deposit_account": {
12    "account_number": "123456780000",
13    "bank_name": "NW Bank",
14    "routing_number": "026010000",
15    "account_type": "savings"
16  },
17  "created_at": "2023-03-14T16:00:49.420Z",
18  "updated_at": "2023-03-14T16:00:49.420Z",
19  "metadata": {}
20}

#List all deposit destinations

get/v2/deposit-destinations

Returns an array of all deposit destination objects.

Query parameters
  • accountstring (uuid)
    optional

    Filter by account ID.

  • userstring (uuid)
    optional

    Filter by user ID.

  • limitinteger
    optional

    Number of deposit destination objects returned per page. Default: 10. Maximum: 200.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/deposit-destinations?limit=2 \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1[
2  {
3    "id": "0185da22-3322-eeaf-57b2-a6527214e456",
4    "account": "0185a8b8-60eb-80ca-7482-5f24504573f7",
5    "employer": "Half Bads",
6    "destination_type": "card",
7    "status": "active",
8    "allocation_type": null,
9    "currency": null,
10    "allocation_value": null,
11    "method": "Instant payout",
12    "card": {
13      "card_number": "****5678",
14      "card_name": "Visa",
15      "is_platform_card": false
16    },
17    "created_at": "2023-03-13T19:53:49.090Z",
18    "updated_at": "2023-03-13T19:53:49.091Z",
19    "metadata": {}
20  },
21  {
22    "id": "0185e091-cbe2-775c-bc32-7bc943cb4264",
23    "account": "0187e091-b47d-3cc6-a273-2b5e3cab83af",
24    "employer": "Bullseye",
25    "destination_type": "ach_deposit_account",
26    "status": "inactive",
27    "allocation_type": "percent",
28    "currency": "USD",
29    "allocation_value": "18",
30    "method": "Direct deposit",
31    "ach_deposit_account": {
32      "account_number": "757127245584",
33      "bank_name": "SW Bank",
34      "routing_number": "016012008",
35      "account_type": "checking"
36    },
37    "created_at": "2023-03-14T14:41:37.989Z",
38    "updated_at": "2023-03-14T14:41:37.989Z",
39    "metadata": {}
40  }
41]