List bank links - Payward Developer Documentation

cURL

curl -X GET "https://api.services.payward.com/v1/accounts/AA23N84GGQN4WE6I/funds/bank-links?page_size=20" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN"

import requests

url = "https://api.services.payward.com/v1/accounts/{account_id}/funds/bank-links"

headers = {
    "API-Key": "<api-key>",
    "API-Sign": "<api-key>",
    "API-Nonce": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'API-Key': '<api-key>', 'API-Sign': '<api-key>', 'API-Nonce': '<api-key>'}
};

fetch('https://api.services.payward.com/v1/accounts/{account_id}/funds/bank-links', 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.services.payward.com/v1/accounts/{account_id}/funds/bank-links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "API-Key: <api-key>",
    "API-Nonce: <api-key>",
    "API-Sign: <api-key>"
  ],
]);

$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.services.payward.com/v1/accounts/{account_id}/funds/bank-links"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("API-Key", "<api-key>")
	req.Header.Add("API-Sign", "<api-key>")
	req.Header.Add("API-Nonce", "<api-key>")

	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.services.payward.com/v1/accounts/{account_id}/funds/bank-links")
  .header("API-Key", "<api-key>")
  .header("API-Sign", "<api-key>")
  .header("API-Nonce", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.services.payward.com/v1/accounts/{account_id}/funds/bank-links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["API-Key"] = '<api-key>'
request["API-Sign"] = '<api-key>'
request["API-Nonce"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "next_page_token": "AY7dRHuBXSgoe0mDHt-iFALROW46EGdvk_trgja31Vwr7H4",
  "data": [
    {
      "bank_link_id": "bal_5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
      "method_id": "3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b",
      "status": "linked",
      "accounts_eligibility_status": "eligible",
      "linked_at": "2026-07-27T12:04:11Z",
      "institution": {
        "name": "Pacific Trust Bank"
      },
      "account_links": [
        {
          "account_link_id": "al_7c2b8d19-4e35-4a71-b0c6-1d8f5e9a2b34",
          "account_last4": "4242",
          "status": "active",
          "eligibility_status": "eligible",
          "eligible_rails": [
            "ach",
            "rtp"
          ]
        }
      ]
    }
  ]
}

GET

accounts

{account_id}

funds

bank-links

cURL

curl -X GET "https://api.services.payward.com/v1/accounts/AA23N84GGQN4WE6I/funds/bank-links?page_size=20" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN"

import requests

url = "https://api.services.payward.com/v1/accounts/{account_id}/funds/bank-links"

headers = {
    "API-Key": "<api-key>",
    "API-Sign": "<api-key>",
    "API-Nonce": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'API-Key': '<api-key>', 'API-Sign': '<api-key>', 'API-Nonce': '<api-key>'}
};

fetch('https://api.services.payward.com/v1/accounts/{account_id}/funds/bank-links', 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.services.payward.com/v1/accounts/{account_id}/funds/bank-links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "API-Key: <api-key>",
    "API-Nonce: <api-key>",
    "API-Sign: <api-key>"
  ],
]);

$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.services.payward.com/v1/accounts/{account_id}/funds/bank-links"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("API-Key", "<api-key>")
	req.Header.Add("API-Sign", "<api-key>")
	req.Header.Add("API-Nonce", "<api-key>")

	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.services.payward.com/v1/accounts/{account_id}/funds/bank-links")
  .header("API-Key", "<api-key>")
  .header("API-Sign", "<api-key>")
  .header("API-Nonce", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.services.payward.com/v1/accounts/{account_id}/funds/bank-links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["API-Key"] = '<api-key>'
request["API-Sign"] = '<api-key>'
request["API-Nonce"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "next_page_token": "AY7dRHuBXSgoe0mDHt-iFALROW46EGdvk_trgja31Vwr7H4",
  "data": [
    {
      "bank_link_id": "bal_5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
      "method_id": "3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b",
      "status": "linked",
      "accounts_eligibility_status": "eligible",
      "linked_at": "2026-07-27T12:04:11Z",
      "institution": {
        "name": "Pacific Trust Bank"
      },
      "account_links": [
        {
          "account_link_id": "al_7c2b8d19-4e35-4a71-b0c6-1d8f5e9a2b34",
          "account_last4": "4242",
          "status": "active",
          "eligibility_status": "eligible",
          "eligible_rails": [
            "ach",
            "rtp"
          ]
        }
      ]
    }
  ]
}

Authorizations

API-Key

string

header

required

Your public API key. Identifies the partner making the request.

API-Sign

string

header

required

HMAC signature over the request, computed with your private key.

API-Nonce

string

header

required

Monotonically increasing nonce included in the request signature.

Path Parameters

account_id

string

required

Public identifier of the account whose links to list.

Required string length: 14 - 42

Query Parameters

page_size

integer<int32>

default:20

Maximum number of results to return. Defaults to 20 if omitted; max 25.

Required range: 1 <= x <= 25

page_token

string

Opaque page token returned by a previous response. Omit to start from the first page. When present, the token is scoped to this endpoint, the account and the requesting principal, carries the page size, and causes any valid page_size value to be ignored.

Required string length: 1 - 256

Response

Successful response

data

Bank link · object[]

Bank Links for the account, ordered by link time descending.

Show child attributes

next_page_token

string

Opaque token for the next page of results. Absent if there are no more results.

Required string length: 1 - 256

⌘I