Get on-ramp requirements

Discover on-ramp bank account options

curl --request GET \
  --url https://prod-api.stableyard.fi/v2/accounts/{accountId}/onramp-bank-account-requirements \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://prod-api.stableyard.fi/v2/accounts/{accountId}/onramp-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}/onramp-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}/onramp-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}/onramp-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}/onramp-bank-account-requirements")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.stableyard.fi/v2/accounts/{accountId}/onramp-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

{
  "accountId": "acct_123",
  "recipientOnFile": true,
  "available": true,
  "unavailableReason": null,
  "supportedDestinations": [
    {
      "chainId": 42161,
      "networkName": "Arbitrum One",
      "assetCodes": [
        "USDC"
      ]
    }
  ],
  "recipientTypes": [
    "individual"
  ],
  "rails": [
    {
      "rail": "ach",
      "country": "US",
      "currency": "USD"
    }
  ],
  "destinations": [
    {
      "connectedWalletId": "wallet_123",
      "chainId": 42161,
      "address": "0x1111111111111111111111111111111111111111",
      "label": null,
      "assetCodes": [
        "USDC"
      ]
    }
  ]
}

{
  "error": {
    "code": "bad_request",
    "message": "The request is invalid"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication is required"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "The credential does not allow this operation"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "The resource was not found"
  }
}

{
  "error": {
    "code": "idempotency_conflict",
    "message": "The Idempotency-Key was already used with a different request"
  }
}

{
  "error": {
    "code": "chain_config_missing",
    "message": "The requested network is not configured for this environment"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests"
  }
}

GET

accounts

{accountId}

onramp-bank-account-requirements

Discover on-ramp bank account options

curl --request GET \
  --url https://prod-api.stableyard.fi/v2/accounts/{accountId}/onramp-bank-account-requirements \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://prod-api.stableyard.fi/v2/accounts/{accountId}/onramp-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}/onramp-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}/onramp-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}/onramp-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}/onramp-bank-account-requirements")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.stableyard.fi/v2/accounts/{accountId}/onramp-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

{
  "accountId": "acct_123",
  "recipientOnFile": true,
  "available": true,
  "unavailableReason": null,
  "supportedDestinations": [
    {
      "chainId": 42161,
      "networkName": "Arbitrum One",
      "assetCodes": [
        "USDC"
      ]
    }
  ],
  "recipientTypes": [
    "individual"
  ],
  "rails": [
    {
      "rail": "ach",
      "country": "US",
      "currency": "USD"
    }
  ],
  "destinations": [
    {
      "connectedWalletId": "wallet_123",
      "chainId": 42161,
      "address": "0x1111111111111111111111111111111111111111",
      "label": null,
      "assetCodes": [
        "USDC"
      ]
    }
  ]
}

{
  "error": {
    "code": "bad_request",
    "message": "The request is invalid"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication is required"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "The credential does not allow this operation"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "The resource was not found"
  }
}

{
  "error": {
    "code": "idempotency_conflict",
    "message": "The Idempotency-Key was already used with a different request"
  }
}

{
  "error": {
    "code": "chain_config_missing",
    "message": "The requested network is not configured for this environment"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests"
  }
}

Read supportedDestinations and destinations for this environment. When no rail or eligible wallet is available, available is false and unavailableReason says why. Any other failure returns a normal HTTP error; do not treat it as unavailable. Issuance separately requires the account’s bank_onramp approval. recipientOnFile reports whether a verified recipient name and address can be reused. When true, omit recipientType, recipientName and recipientAddress together at issuance. Otherwise, supply all three. This flag does not grant bank access or replace capability approval.

Authorizations

Authorization

string

header

required

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

Stableyard-Version

enum<string>

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

accountId

string

required

Canonical account id returned by the Accounts API.

Example:

"acct_123"

Response

On-ramp bank account requirements

accountId

string

required

Example:

"acct_123"

recipientOnFile

boolean

required

True when a verified name and address is on file, so the funding account can be created without recipient details.

available

boolean

required

True only when at least one rail is available and at least one connected wallet is on a supported destination.

unavailableReason

enum<string> | null

required

Why the flow cannot be started, or null when it can.

Available options:

onramp_route_not_configured,

no_eligible_destination,

null

supportedDestinations

object[]

required

Supported delivery chains and assets, including when this UPA has no eligible wallet. Listing does not grant rail access or approval.

Show child attributes

recipientTypes

enum<string>[]

required

Available options:

individual,

business

rails

object[]

required

Rails available in this environment. One rail can be available while another is not.

Show child attributes

destinations

object[]

required

Connected wallets on a supported destination chain, with the asset codes supported on that chain.

Show child attributes

Introduction

Onboarding

Accounts

Money movement

Activity

Vaults

Client & checkout

Platform

Get on-ramp requirements

Authorizations

Headers

Path Parameters

Response