Save a third-party bank beneficiary
curl --request POST \
--url https://prod-api.stableyard.fi/v2/accounts/{accountId}/beneficiaries \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"label": "example",
"country": "PH",
"currency": "PHP",
"bankCode": "example",
"accountNumber": "example",
"beneficiaryName": "Example account"
}
'import requests
url = "https://prod-api.stableyard.fi/v2/accounts/{accountId}/beneficiaries"
payload = {
"label": "example",
"country": "PH",
"currency": "PHP",
"bankCode": "example",
"accountNumber": "example",
"beneficiaryName": "Example account"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
label: 'example',
country: 'PH',
currency: 'PHP',
bankCode: 'example',
accountNumber: 'example',
beneficiaryName: 'Example account'
})
};
fetch('https://prod-api.stableyard.fi/v2/accounts/{accountId}/beneficiaries', 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}/beneficiaries",
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([
'label' => 'example',
'country' => 'PH',
'currency' => 'PHP',
'bankCode' => 'example',
'accountNumber' => 'example',
'beneficiaryName' => 'Example account'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://prod-api.stableyard.fi/v2/accounts/{accountId}/beneficiaries"
payload := strings.NewReader("{\n \"label\": \"example\",\n \"country\": \"PH\",\n \"currency\": \"PHP\",\n \"bankCode\": \"example\",\n \"accountNumber\": \"example\",\n \"beneficiaryName\": \"Example account\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Basic <encoded-value>")
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://prod-api.stableyard.fi/v2/accounts/{accountId}/beneficiaries")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"example\",\n \"country\": \"PH\",\n \"currency\": \"PHP\",\n \"bankCode\": \"example\",\n \"accountNumber\": \"example\",\n \"beneficiaryName\": \"Example account\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.stableyard.fi/v2/accounts/{accountId}/beneficiaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"example\",\n \"country\": \"PH\",\n \"currency\": \"PHP\",\n \"bankCode\": \"example\",\n \"accountNumber\": \"example\",\n \"beneficiaryName\": \"Example account\"\n}"
response = http.request(request)
puts response.read_body{
"beneficiary": {
"id": "beneficiary_123",
"accountId": "acct_123",
"label": "example",
"country": "example",
"currency": "USD",
"bankCode": "example",
"beneficiaryName": "Example account",
"accountNumberLast4": "exam",
"status": "active",
"verificationStatus": "verify_on_payment",
"version": 1,
"createdAt": "2026-08-28T10:00:00.000Z",
"disabledAt": "2026-08-28T10:00:00.000Z"
}
}{
"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
Save a bank beneficiary
Requires v2:accounts and app external-bank capability. Supports Individual UPAs in PH/PHP and VN/VND. Saves encrypted immutable details without provider side effects; verification happens on each Payment. Retrying changed input, including sender UPA, conflicts. Disable and create a replacement to change details.
POST
/
v2
/
accounts
/
{accountId}
/
beneficiaries
Save a third-party bank beneficiary
curl --request POST \
--url https://prod-api.stableyard.fi/v2/accounts/{accountId}/beneficiaries \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"label": "example",
"country": "PH",
"currency": "PHP",
"bankCode": "example",
"accountNumber": "example",
"beneficiaryName": "Example account"
}
'import requests
url = "https://prod-api.stableyard.fi/v2/accounts/{accountId}/beneficiaries"
payload = {
"label": "example",
"country": "PH",
"currency": "PHP",
"bankCode": "example",
"accountNumber": "example",
"beneficiaryName": "Example account"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
label: 'example',
country: 'PH',
currency: 'PHP',
bankCode: 'example',
accountNumber: 'example',
beneficiaryName: 'Example account'
})
};
fetch('https://prod-api.stableyard.fi/v2/accounts/{accountId}/beneficiaries', 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}/beneficiaries",
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([
'label' => 'example',
'country' => 'PH',
'currency' => 'PHP',
'bankCode' => 'example',
'accountNumber' => 'example',
'beneficiaryName' => 'Example account'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://prod-api.stableyard.fi/v2/accounts/{accountId}/beneficiaries"
payload := strings.NewReader("{\n \"label\": \"example\",\n \"country\": \"PH\",\n \"currency\": \"PHP\",\n \"bankCode\": \"example\",\n \"accountNumber\": \"example\",\n \"beneficiaryName\": \"Example account\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Basic <encoded-value>")
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://prod-api.stableyard.fi/v2/accounts/{accountId}/beneficiaries")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"example\",\n \"country\": \"PH\",\n \"currency\": \"PHP\",\n \"bankCode\": \"example\",\n \"accountNumber\": \"example\",\n \"beneficiaryName\": \"Example account\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.stableyard.fi/v2/accounts/{accountId}/beneficiaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"example\",\n \"country\": \"PH\",\n \"currency\": \"PHP\",\n \"bankCode\": \"example\",\n \"accountNumber\": \"example\",\n \"beneficiaryName\": \"Example account\"\n}"
response = http.request(request)
puts response.read_body{
"beneficiary": {
"id": "beneficiary_123",
"accountId": "acct_123",
"label": "example",
"country": "example",
"currency": "USD",
"bankCode": "example",
"beneficiaryName": "Example account",
"accountNumberLast4": "exam",
"status": "active",
"verificationStatus": "verify_on_payment",
"version": 1,
"createdAt": "2026-08-28T10:00:00.000Z",
"disabledAt": "2026-08-28T10:00:00.000Z"
}
}{
"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"
}
}See saved beneficiaries for supported markets and the payment flow.
Authorizations
Headers
Body
application/json