curl --request GET \
--url https://api-sandbox.argyle.com/v2/deposit-destinations/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-sandbox.argyle.com/v2/deposit-destinations/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api-sandbox.argyle.com/v2/deposit-destinations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.argyle.com/v2/deposit-destinations/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.argyle.com/v2/deposit-destinations/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.argyle.com/v2/deposit-destinations/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/deposit-destinations/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"id": "0176e1ea-60ca-c561-eb8e-6dcdb33b1b55",
"account": "0187c66e-e7e5-811c-b006-2232f00f426a",
"employer": "Whole Goods",
"destination_type": "ach_deposit_account",
"status": "active",
"allocation_type": "amount",
"currency": "USD",
"allocation_value": "325.70",
"method": "Direct deposit",
"ach_deposit_account": {
"account_number": "123456780000",
"bank_name": "NW Bank",
"routing_number": "026010000",
"account_type": "savings"
},
"created_at": "2023-03-14T16:00:49.420Z",
"updated_at": "2023-03-14T16:00:49.420Z",
"metadata": {}
}Retrieve A Deposit Destination
Retrieves a deposit destination object.
curl --request GET \
--url https://api-sandbox.argyle.com/v2/deposit-destinations/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-sandbox.argyle.com/v2/deposit-destinations/{id}"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api-sandbox.argyle.com/v2/deposit-destinations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.argyle.com/v2/deposit-destinations/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.argyle.com/v2/deposit-destinations/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-sandbox.argyle.com/v2/deposit-destinations/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/deposit-destinations/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"id": "0176e1ea-60ca-c561-eb8e-6dcdb33b1b55",
"account": "0187c66e-e7e5-811c-b006-2232f00f426a",
"employer": "Whole Goods",
"destination_type": "ach_deposit_account",
"status": "active",
"allocation_type": "amount",
"currency": "USD",
"allocation_value": "325.70",
"method": "Direct deposit",
"ach_deposit_account": {
"account_number": "123456780000",
"bank_name": "NW Bank",
"routing_number": "026010000",
"account_type": "savings"
},
"created_at": "2023-03-14T16:00:49.420Z",
"updated_at": "2023-03-14T16:00:49.420Z",
"metadata": {}
}Response
Whether the deposit destination is currently set to receive payments.
Additional details for gig employers:
inactive indicates the user added this card or bank account to the gig platform, but chose another preferred deposit destination in their payout settings.
Note: Deposit destination details for individual payouts from gig employers are also listed within the metadata object of the user's paystubs.
// Example - payout to debit card:
"metadata": {
"origin_type": "DRIVER_DIRECT",
"payout_on": "2022-06-28 21:15:04+00:00",
"issue_info": {
"description": "",
"type": "UNKNOWN_ISSUE_TYPE"
},
"deposited_ot": "2321 Visa",
"origin_period": null,
"raw_type": "DRIVER_DIRECT"
}
// Example - payout to bank account:
"metadata": {
"origin_type": "REGULAR",
"payout_on": "2022-11-17 07:20:32+00:00",
"issue_info": {
"description": "",
"type": "UNKNOWN_ISSUE_TYPE"
},
"deposited_ot": "5329 FIFTH SIXTH BANK",
"origin_period": {
"start": "2022-11-14 14:06:29+00:00",
"end": "2022-11-16 14:06:29+00:00"
},
"raw_type": "REGULAR"
}
active, inactive, pending Currency (ISO 4217) in which payouts are sent to the deposit destination.
What percent or amount of the user's pay is being allocated to this deposit destination.
Numerical values are used for exact amounts or percentages, and remainder is used when this deposit destination is receiving a remainder amount after pay is allocated to all other deposit destinations.
Timestamp (ISO 8601) when the deposit destination object was created.
Timestamp (ISO 8601) when a property value of the deposit destination object most recently changed.