Get country-specific bank fields and linking availability
curl --request GET \
--url https://prod-api.stableyard.fi/v2/accounts/{accountId}/bank-account-requirements \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://prod-api.stableyard.fi/v2/accounts/{accountId}/bank-account-requirements"
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://prod-api.stableyard.fi/v2/accounts/{accountId}/bank-account-requirements', 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://prod-api.stableyard.fi/v2/accounts/{accountId}/bank-account-requirements",
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://prod-api.stableyard.fi/v2/accounts/{accountId}/bank-account-requirements"
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://prod-api.stableyard.fi/v2/accounts/{accountId}/bank-account-requirements")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.stableyard.fi/v2/accounts/{accountId}/bank-account-requirements")
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{
"version": 1,
"accountId": "acct_123",
"countries": [
{
"country": "PH",
"name": "Philippines",
"currency": "PHP",
"implementation": "supported",
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"country": {
"type": "string",
"const": "PH"
},
"currency": {
"type": "string",
"const": "PHP"
},
"accountHolderName": {
"type": "string",
"title": "Recipient name",
"minLength": 1,
"maxLength": 160
},
"beneficiaryType": {
"type": "string",
"title": "Beneficiary type",
"enum": [
"individual",
"business"
],
"default": "individual"
},
"bankName": {
"type": "string",
"title": "Bank name",
"minLength": 1,
"maxLength": 160
},
"bankCode": {
"type": "string",
"title": "Bank code",
"minLength": 1,
"maxLength": 64,
"pattern": "^[A-Za-z0-9_-]+$",
"x-bank-directory": true
},
"accountNumber": {
"type": "string",
"title": "Account number",
"minLength": 4,
"maxLength": 34,
"pattern": "^[0-9]{4,34}$",
"writeOnly": true,
"x-normalize": "digits"
},
"rail": {
"type": "string",
"const": "bank_transfer",
"default": "bank_transfer"
}
},
"required": [
"country",
"currency",
"accountHolderName",
"bankName",
"bankCode",
"accountNumber"
]
},
"alternatives": [
{
"id": "gcash",
"label": "GCash mobile number",
"fields": {
"identifier": {
"type": "string",
"title": "GCash mobile number",
"minLength": 1,
"maxLength": 160,
"writeOnly": true
}
},
"resourceType": "payment_rail_identifier",
"available": false
},
{
"id": "maya",
"label": "Maya mobile number",
"fields": {
"identifier": {
"type": "string",
"title": "Maya mobile number",
"minLength": 1,
"maxLength": 160,
"writeOnly": true
}
},
"resourceType": "payment_rail_identifier",
"available": false
}
],
"available": true,
"unavailableReason": null
}
]
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}Bank accounts
Get bank account requirements by country
Read each country’s bank account fields and whether linking is available there.
GET
/
v2
/
accounts
/
{accountId}
/
bank-account-requirements
Get country-specific bank fields and linking availability
curl --request GET \
--url https://prod-api.stableyard.fi/v2/accounts/{accountId}/bank-account-requirements \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://prod-api.stableyard.fi/v2/accounts/{accountId}/bank-account-requirements"
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://prod-api.stableyard.fi/v2/accounts/{accountId}/bank-account-requirements', 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://prod-api.stableyard.fi/v2/accounts/{accountId}/bank-account-requirements",
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://prod-api.stableyard.fi/v2/accounts/{accountId}/bank-account-requirements"
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://prod-api.stableyard.fi/v2/accounts/{accountId}/bank-account-requirements")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.stableyard.fi/v2/accounts/{accountId}/bank-account-requirements")
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{
"version": 1,
"accountId": "acct_123",
"countries": [
{
"country": "PH",
"name": "Philippines",
"currency": "PHP",
"implementation": "supported",
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"country": {
"type": "string",
"const": "PH"
},
"currency": {
"type": "string",
"const": "PHP"
},
"accountHolderName": {
"type": "string",
"title": "Recipient name",
"minLength": 1,
"maxLength": 160
},
"beneficiaryType": {
"type": "string",
"title": "Beneficiary type",
"enum": [
"individual",
"business"
],
"default": "individual"
},
"bankName": {
"type": "string",
"title": "Bank name",
"minLength": 1,
"maxLength": 160
},
"bankCode": {
"type": "string",
"title": "Bank code",
"minLength": 1,
"maxLength": 64,
"pattern": "^[A-Za-z0-9_-]+$",
"x-bank-directory": true
},
"accountNumber": {
"type": "string",
"title": "Account number",
"minLength": 4,
"maxLength": 34,
"pattern": "^[0-9]{4,34}$",
"writeOnly": true,
"x-normalize": "digits"
},
"rail": {
"type": "string",
"const": "bank_transfer",
"default": "bank_transfer"
}
},
"required": [
"country",
"currency",
"accountHolderName",
"bankName",
"bankCode",
"accountNumber"
]
},
"alternatives": [
{
"id": "gcash",
"label": "GCash mobile number",
"fields": {
"identifier": {
"type": "string",
"title": "GCash mobile number",
"minLength": 1,
"maxLength": 160,
"writeOnly": true
}
},
"resourceType": "payment_rail_identifier",
"available": false
},
{
"id": "maya",
"label": "Maya mobile number",
"fields": {
"identifier": {
"type": "string",
"title": "Maya mobile number",
"minLength": 1,
"maxLength": 160,
"writeOnly": true
}
},
"resourceType": "payment_rail_identifier",
"available": false
}
],
"available": true,
"unavailableReason": null
}
]
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}{
"error": {
"code": "bad_request",
"message": "The request is invalid",
"details": "example"
}
}Returns one entry per country with its currency,
implementation (supported or planned), available flag, unavailableReason, and a strict JSON Schema for the bank fields. The field schemas are the same ones server validation uses. Use the actual country code, not EU or AU as a bloc identifier.
Availability requires an implemented adapter, configured storage with a recent successful KMS write probe for every implemented country, and an enabled route for your app. Probe results are cached for up to 30 seconds, so a link can still fail if availability changes in between. Planned bank and shortcut-identifier profiles never enable money movement.
Then link the bank account. See Off-ramps.Authorizations
HTTP Basic auth. Username is the Stableyard app ID. Password is the app secret. The optional Stableyard-Version request header must match the environment pin.
Headers
Optional contract-version assertion. Omit it to use the app environment's pinned version. A different supported version is accepted only after that environment is explicitly migrated.
Available options:
2026-09-09 Path Parameters
Canonical account id returned by the Accounts API.
Example:
"acct_123"