curl --request GET \
--url "https://api.stablepay.co/api/v1/recipient/requirements?type=<TYPE>" \
--header "Authorization: Bearer <API_KEY>" \
--header "X-StablePay-Timestamp: <TIMESTAMP>" \
--header "X-StablePay-Nonce: <NONCE>" \
--header "X-StablePay-Signature: <SIGNATURE>"
const response = await fetch("https://api.stablepay.co/api/v1/recipient/requirements?type=<TYPE>", {
method: "GET",
headers: {
"Authorization": "Bearer <API_KEY>",
"X-StablePay-Timestamp": "<TIMESTAMP>",
"X-StablePay-Nonce": "<NONCE>",
"X-StablePay-Signature": "<SIGNATURE>"
}
});
console.log(await response.json());
{
"recipient_requirements": {
"type": "fiat_account",
"currency": "USD",
"fields": [
{
"field": "account_holder_name",
"required": true,
"type": "string",
"max_length": 140,
"description": "Account holder name",
"example": "John Smith"
},
{
"field": "account_number",
"required": true,
"type": "string",
"pattern": "^[0-9]{6,17}$",
"description": "Local account number",
"example": "012345678901"
}
]
}
}
Global Accounts API
Retrieve recipient field rules
Retrieve recipient field rules
GET
/
api
/
v1
/
recipient
/
requirements
curl --request GET \
--url "https://api.stablepay.co/api/v1/recipient/requirements?type=<TYPE>" \
--header "Authorization: Bearer <API_KEY>" \
--header "X-StablePay-Timestamp: <TIMESTAMP>" \
--header "X-StablePay-Nonce: <NONCE>" \
--header "X-StablePay-Signature: <SIGNATURE>"
const response = await fetch("https://api.stablepay.co/api/v1/recipient/requirements?type=<TYPE>", {
method: "GET",
headers: {
"Authorization": "Bearer <API_KEY>",
"X-StablePay-Timestamp": "<TIMESTAMP>",
"X-StablePay-Nonce": "<NONCE>",
"X-StablePay-Signature": "<SIGNATURE>"
}
});
console.log(await response.json());
{
"recipient_requirements": {
"type": "fiat_account",
"currency": "USD",
"fields": [
{
"field": "account_holder_name",
"required": true,
"type": "string",
"max_length": 140,
"description": "Account holder name",
"example": "John Smith"
},
{
"field": "account_number",
"required": true,
"type": "string",
"pattern": "^[0-9]{6,17}$",
"description": "Local account number",
"example": "012345678901"
}
]
}
}
See authentication, signing, data conventions, and errors. Regenerate the timestamp, nonce, and signature on every retry.
GET /recipient/requirements Returns required and format rules for each details field, used to render forms.
Request headers
string
required
Bearer API Key.
string
required
Unix seconds, within five minutes of server time.
string
required
Unique per request, 16–64 characters.
string
required
Lowercase hexadecimal HMAC-SHA256 signature for the exact request body.
Request parameters
string
10 digits; omit for merchant apps, required for service-provider apps
string
required
stablecoin_address or fiat_accountstring
Required when type=
fiat_accountResponse
object
required
Requirements object
string
required
Recipient type
string
Fiat currency the rules apply to
array
required
Field rule list
string
required
Field name in details
boolean
required
Whether required
string
required
string or integer
integer
Max length
string
Regex constraint
string
required
Description
string
Example value
Status and errors
404 unsupported currency.curl --request GET \
--url "https://api.stablepay.co/api/v1/recipient/requirements?type=<TYPE>" \
--header "Authorization: Bearer <API_KEY>" \
--header "X-StablePay-Timestamp: <TIMESTAMP>" \
--header "X-StablePay-Nonce: <NONCE>" \
--header "X-StablePay-Signature: <SIGNATURE>"
const response = await fetch("https://api.stablepay.co/api/v1/recipient/requirements?type=<TYPE>", {
method: "GET",
headers: {
"Authorization": "Bearer <API_KEY>",
"X-StablePay-Timestamp": "<TIMESTAMP>",
"X-StablePay-Nonce": "<NONCE>",
"X-StablePay-Signature": "<SIGNATURE>"
}
});
console.log(await response.json());
{
"recipient_requirements": {
"type": "fiat_account",
"currency": "USD",
"fields": [
{
"field": "account_holder_name",
"required": true,
"type": "string",
"max_length": 140,
"description": "Account holder name",
"example": "John Smith"
},
{
"field": "account_number",
"required": true,
"type": "string",
"pattern": "^[0-9]{6,17}$",
"description": "Local account number",
"example": "012345678901"
}
]
}
}
Last modified on October 29, 2026
Was this page helpful?
