Skip to main content
GET
/
v2
/
deposit-destinations
List all deposit destinations
curl --request GET \
  --url https://api-sandbox.argyle.com/v2/deposit-destinations \
  --header 'Authorization: Basic <encoded-value>'
import requests

url = "https://api-sandbox.argyle.com/v2/deposit-destinations"

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', 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",
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"

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")
.header("Authorization", "Basic <encoded-value>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.argyle.com/v2/deposit-destinations")

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
{
  "next": "https://api-sandbox.argyle.com/v2/deposit-destinations?cursor=ZXhhbXBsZV9jdXJzb3I",
  "previous": null,
  "results": [
    {
      "id": "0185da22-3322-eeaf-57b2-a6527214e456",
      "account": "0185a8b8-60eb-80ca-7482-5f24504573f7",
      "employer": "Half Bads",
      "destination_type": "card",
      "status": "active",
      "allocation_type": null,
      "currency": null,
      "allocation_value": null,
      "method": "Instant payout",
      "card": {
        "card_number": "****5678",
        "card_name": "Visa",
        "is_platform_card": false
      },
      "created_at": "2023-03-13T19:53:49.090Z",
      "updated_at": "2023-03-13T19:53:49.091Z",
      "metadata": {}
    },
    {
      "id": "0185e091-cbe2-775c-bc32-7bc943cb4264",
      "account": "0187e091-b47d-3cc6-a273-2b5e3cab83af",
      "employer": "Bullseye",
      "destination_type": "ach_deposit_account",
      "status": "inactive",
      "allocation_type": "amount",
      "currency": "USD",
      "allocation_value": "remainder",
      "method": "Direct deposit",
      "ach_deposit_account": {
        "account_number": "757127245584",
        "bank_name": "SW Bank",
        "routing_number": "016012008",
        "account_type": "checking"
      },
      "created_at": "2023-03-14T14:41:37.989Z",
      "updated_at": "2023-03-14T14:41:37.989Z",
      "metadata": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Query Parameters

account
string<uuid>

Filter by account ID.

user
string<uuid>

Filter by user ID.

limit
integer

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

cursor
string

The URL returned in next or previous used to retrieve another page of results.

Response

200 - application/json
next
string<uri> | null

URL for the next page of results, if available.

previous
string<uri> | null

URL for the previous page of results, if available.

results
object[]