Reconnect bank link
curl --request POST \
--url https://api.sandbox.services.payward.com/v1/accounts/{account_id}/funds/bank-links/{bank_link_id}/reconnect \
--header 'API-Key: <api-key>' \
--header 'API-Sign: <api-key>' \
--header 'API-Timestamp: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"return_url": "https://partner.example.com/bank-link/return"
}
'import requests
url = "https://api.sandbox.services.payward.com/v1/accounts/{account_id}/funds/bank-links/{bank_link_id}/reconnect"
payload = { "return_url": "https://partner.example.com/bank-link/return" }
headers = {
"API-Key": "<api-key>",
"API-Sign": "<api-key>",
"API-Timestamp": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'API-Key': '<api-key>',
'API-Sign': '<api-key>',
'API-Timestamp': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({return_url: 'https://partner.example.com/bank-link/return'})
};
fetch('https://api.sandbox.services.payward.com/v1/accounts/{account_id}/funds/bank-links/{bank_link_id}/reconnect', 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.services.payward.com/v1/accounts/{account_id}/funds/bank-links/{bank_link_id}/reconnect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'return_url' => 'https://partner.example.com/bank-link/return'
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"API-Sign: <api-key>",
"API-Timestamp: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.services.payward.com/v1/accounts/{account_id}/funds/bank-links/{bank_link_id}/reconnect"
payload := strings.NewReader("{\n \"return_url\": \"https://partner.example.com/bank-link/return\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("API-Key", "<api-key>")
req.Header.Add("API-Sign", "<api-key>")
req.Header.Add("API-Timestamp", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.services.payward.com/v1/accounts/{account_id}/funds/bank-links/{bank_link_id}/reconnect")
.header("API-Key", "<api-key>")
.header("API-Sign", "<api-key>")
.header("API-Timestamp", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"return_url\": \"https://partner.example.com/bank-link/return\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.services.payward.com/v1/accounts/{account_id}/funds/bank-links/{bank_link_id}/reconnect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["API-Key"] = '<api-key>'
request["API-Sign"] = '<api-key>'
request["API-Timestamp"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"return_url\": \"https://partner.example.com/bank-link/return\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"bank_link_id": "bal_5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
"method_id": "3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b",
"status": "pending",
"next_action": {
"type": "hosted_link",
"widget_url": "https://bank-link.services.payward.com/link/bal_5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
"expires_at": "2026-08-19T11:45:00Z"
},
"accounts_eligibility_status": "unknown"
}
}Bank links
Reconnect bank link
Reconnects a Bank Link whose provider connection expired or was revoked. Returns it in pending with a fresh hosted-widget URL; the user re-authorizes through the provider, and a stored credential is never reused.
Completing the reconnect reconciles the account set. Accounts the user shares again keep their account_link_id. Newly shared accounts that link successfully appear as new Account Links. Accounts no longer shared become removed, which drops them from get and list. An account_link_id is therefore stable but revocable, not permanent.
POST
/
v1
/
accounts
/
{account_id}
/
funds
/
bank-links
/
{bank_link_id}
/
reconnect
Reconnect bank link
curl --request POST \
--url https://api.sandbox.services.payward.com/v1/accounts/{account_id}/funds/bank-links/{bank_link_id}/reconnect \
--header 'API-Key: <api-key>' \
--header 'API-Sign: <api-key>' \
--header 'API-Timestamp: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"return_url": "https://partner.example.com/bank-link/return"
}
'import requests
url = "https://api.sandbox.services.payward.com/v1/accounts/{account_id}/funds/bank-links/{bank_link_id}/reconnect"
payload = { "return_url": "https://partner.example.com/bank-link/return" }
headers = {
"API-Key": "<api-key>",
"API-Sign": "<api-key>",
"API-Timestamp": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'API-Key': '<api-key>',
'API-Sign': '<api-key>',
'API-Timestamp': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({return_url: 'https://partner.example.com/bank-link/return'})
};
fetch('https://api.sandbox.services.payward.com/v1/accounts/{account_id}/funds/bank-links/{bank_link_id}/reconnect', 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.services.payward.com/v1/accounts/{account_id}/funds/bank-links/{bank_link_id}/reconnect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'return_url' => 'https://partner.example.com/bank-link/return'
]),
CURLOPT_HTTPHEADER => [
"API-Key: <api-key>",
"API-Sign: <api-key>",
"API-Timestamp: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.services.payward.com/v1/accounts/{account_id}/funds/bank-links/{bank_link_id}/reconnect"
payload := strings.NewReader("{\n \"return_url\": \"https://partner.example.com/bank-link/return\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("API-Key", "<api-key>")
req.Header.Add("API-Sign", "<api-key>")
req.Header.Add("API-Timestamp", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.services.payward.com/v1/accounts/{account_id}/funds/bank-links/{bank_link_id}/reconnect")
.header("API-Key", "<api-key>")
.header("API-Sign", "<api-key>")
.header("API-Timestamp", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"return_url\": \"https://partner.example.com/bank-link/return\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.services.payward.com/v1/accounts/{account_id}/funds/bank-links/{bank_link_id}/reconnect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["API-Key"] = '<api-key>'
request["API-Sign"] = '<api-key>'
request["API-Timestamp"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"return_url\": \"https://partner.example.com/bank-link/return\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"bank_link_id": "bal_5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
"method_id": "3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b",
"status": "pending",
"next_action": {
"type": "hosted_link",
"widget_url": "https://bank-link.services.payward.com/link/bal_5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b",
"expires_at": "2026-08-19T11:45:00Z"
},
"accounts_eligibility_status": "unknown"
}
}Authorizations
Path Parameters
Body
application/json