curl --request POST \
--url https://api.sandbox.services.payward.com/v1/accounts/{account_id}/funds/bank-links \
--header 'API-Key: <api-key>' \
--header 'API-Sign: <api-key>' \
--header 'API-Timestamp: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"method_id": "3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b",
"return_url": "https://partner.example.com/bank-link/return",
"external_reference": "order-abc-123"
}
'import requests
url = "https://api.sandbox.services.payward.com/v1/accounts/{account_id}/funds/bank-links"
payload = {
"method_id": "3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b",
"return_url": "https://partner.example.com/bank-link/return",
"external_reference": "order-abc-123"
}
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({
method_id: '3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b',
return_url: 'https://partner.example.com/bank-link/return',
external_reference: 'order-abc-123'
})
};
fetch('https://api.sandbox.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.sandbox.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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'method_id' => '3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b',
'return_url' => 'https://partner.example.com/bank-link/return',
'external_reference' => 'order-abc-123'
]),
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"
payload := strings.NewReader("{\n \"method_id\": \"3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b\",\n \"return_url\": \"https://partner.example.com/bank-link/return\",\n \"external_reference\": \"order-abc-123\"\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")
.header("API-Key", "<api-key>")
.header("API-Sign", "<api-key>")
.header("API-Timestamp", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"method_id\": \"3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b\",\n \"return_url\": \"https://partner.example.com/bank-link/return\",\n \"external_reference\": \"order-abc-123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.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::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 \"method_id\": \"3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b\",\n \"return_url\": \"https://partner.example.com/bank-link/return\",\n \"external_reference\": \"order-abc-123\"\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-07-02T16:00:00Z"
},
"accounts_eligibility_status": "unknown"
}
}Create bank link
Creates a Bank Link (a connection between this account and one banking institution) for a funding method that requires linking. Returns it in pending with a hosted-widget URL; send the user there to choose their institution and approve access. Each shared bank account that links successfully becomes an Account Link under this Bank Link once it activates.
To choose method_id, list deposit methods with GET /v1/accounts/{account_id}/funds/deposits/methods?asset_symbol={asset_symbol} for this account and asset. Select a method whose requirements contains bank_link and pass its id as method_id. A method this account cannot currently use is rejected with bank_link_method_not_linkable rather than creating a link that cannot complete.
Provider identifiers, access tokens, owner names, and raw bank numbers are never returned. Reference the link and its accounts only by bank_link_id and account_link_id.
curl --request POST \
--url https://api.sandbox.services.payward.com/v1/accounts/{account_id}/funds/bank-links \
--header 'API-Key: <api-key>' \
--header 'API-Sign: <api-key>' \
--header 'API-Timestamp: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"method_id": "3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b",
"return_url": "https://partner.example.com/bank-link/return",
"external_reference": "order-abc-123"
}
'import requests
url = "https://api.sandbox.services.payward.com/v1/accounts/{account_id}/funds/bank-links"
payload = {
"method_id": "3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b",
"return_url": "https://partner.example.com/bank-link/return",
"external_reference": "order-abc-123"
}
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({
method_id: '3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b',
return_url: 'https://partner.example.com/bank-link/return',
external_reference: 'order-abc-123'
})
};
fetch('https://api.sandbox.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.sandbox.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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'method_id' => '3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b',
'return_url' => 'https://partner.example.com/bank-link/return',
'external_reference' => 'order-abc-123'
]),
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"
payload := strings.NewReader("{\n \"method_id\": \"3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b\",\n \"return_url\": \"https://partner.example.com/bank-link/return\",\n \"external_reference\": \"order-abc-123\"\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")
.header("API-Key", "<api-key>")
.header("API-Sign", "<api-key>")
.header("API-Timestamp", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"method_id\": \"3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b\",\n \"return_url\": \"https://partner.example.com/bank-link/return\",\n \"external_reference\": \"order-abc-123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.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::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 \"method_id\": \"3f9a1c2e-8b7d-4e6f-9a1b-2c3d4e5f6a7b\",\n \"return_url\": \"https://partner.example.com/bank-link/return\",\n \"external_reference\": \"order-abc-123\"\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-07-02T16:00:00Z"
},
"accounts_eligibility_status": "unknown"
}
}