curl --request POST \
--url https://{host}/v1/payee-rails \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'X-Ambient-Actor: <api-key>' \
--header 'X-Ambient-Timestamp: <api-key>' \
--data '
{
"commandId": "<string>",
"principalId": "<string>",
"railId": "<string>",
"credentialTarget": "<string>",
"privateReference": "<string>",
"authorityRef": "<string>"
}
'import requests
url = "https://{host}/v1/payee-rails"
payload = {
"commandId": "<string>",
"principalId": "<string>",
"railId": "<string>",
"credentialTarget": "<string>",
"privateReference": "<string>",
"authorityRef": "<string>"
}
headers = {
"X-Ambient-Actor": "<api-key>",
"X-Ambient-Timestamp": "<api-key>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Ambient-Actor': '<api-key>',
'X-Ambient-Timestamp': '<api-key>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
commandId: '<string>',
principalId: '<string>',
railId: '<string>',
credentialTarget: '<string>',
privateReference: '<string>',
authorityRef: '<string>'
})
};
fetch('https://{host}/v1/payee-rails', 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://{host}/v1/payee-rails",
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([
'commandId' => '<string>',
'principalId' => '<string>',
'railId' => '<string>',
'credentialTarget' => '<string>',
'privateReference' => '<string>',
'authorityRef' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"X-Ambient-Actor: <api-key>",
"X-Ambient-Timestamp: <api-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://{host}/v1/payee-rails"
payload := strings.NewReader("{\n \"commandId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"railId\": \"<string>\",\n \"credentialTarget\": \"<string>\",\n \"privateReference\": \"<string>\",\n \"authorityRef\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Ambient-Actor", "<api-key>")
req.Header.Add("X-Ambient-Timestamp", "<api-key>")
req.Header.Add("Authorization", "<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://{host}/v1/payee-rails")
.header("X-Ambient-Actor", "<api-key>")
.header("X-Ambient-Timestamp", "<api-key>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"commandId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"railId\": \"<string>\",\n \"credentialTarget\": \"<string>\",\n \"privateReference\": \"<string>\",\n \"authorityRef\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/payee-rails")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Ambient-Actor"] = '<api-key>'
request["X-Ambient-Timestamp"] = '<api-key>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"commandId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"railId\": \"<string>\",\n \"credentialTarget\": \"<string>\",\n \"privateReference\": \"<string>\",\n \"authorityRef\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"payeePrincipalId": "<string>",
"railId": "<string>",
"credentialType": "<string>",
"credentialTarget": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "request authentication failed"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}Self-service payee registration (new bindings temporarily blocked)
New self-service bindings are temporarily rejected with
payee_rail_onboarding_required until principal-bound Connect
onboarding can establish account ownership. Existing identical
commands may replay. The private adapter reference is never returned.
curl --request POST \
--url https://{host}/v1/payee-rails \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'X-Ambient-Actor: <api-key>' \
--header 'X-Ambient-Timestamp: <api-key>' \
--data '
{
"commandId": "<string>",
"principalId": "<string>",
"railId": "<string>",
"credentialTarget": "<string>",
"privateReference": "<string>",
"authorityRef": "<string>"
}
'import requests
url = "https://{host}/v1/payee-rails"
payload = {
"commandId": "<string>",
"principalId": "<string>",
"railId": "<string>",
"credentialTarget": "<string>",
"privateReference": "<string>",
"authorityRef": "<string>"
}
headers = {
"X-Ambient-Actor": "<api-key>",
"X-Ambient-Timestamp": "<api-key>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Ambient-Actor': '<api-key>',
'X-Ambient-Timestamp': '<api-key>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
commandId: '<string>',
principalId: '<string>',
railId: '<string>',
credentialTarget: '<string>',
privateReference: '<string>',
authorityRef: '<string>'
})
};
fetch('https://{host}/v1/payee-rails', 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://{host}/v1/payee-rails",
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([
'commandId' => '<string>',
'principalId' => '<string>',
'railId' => '<string>',
'credentialTarget' => '<string>',
'privateReference' => '<string>',
'authorityRef' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"X-Ambient-Actor: <api-key>",
"X-Ambient-Timestamp: <api-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://{host}/v1/payee-rails"
payload := strings.NewReader("{\n \"commandId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"railId\": \"<string>\",\n \"credentialTarget\": \"<string>\",\n \"privateReference\": \"<string>\",\n \"authorityRef\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Ambient-Actor", "<api-key>")
req.Header.Add("X-Ambient-Timestamp", "<api-key>")
req.Header.Add("Authorization", "<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://{host}/v1/payee-rails")
.header("X-Ambient-Actor", "<api-key>")
.header("X-Ambient-Timestamp", "<api-key>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"commandId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"railId\": \"<string>\",\n \"credentialTarget\": \"<string>\",\n \"privateReference\": \"<string>\",\n \"authorityRef\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/payee-rails")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Ambient-Actor"] = '<api-key>'
request["X-Ambient-Timestamp"] = '<api-key>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"commandId\": \"<string>\",\n \"principalId\": \"<string>\",\n \"railId\": \"<string>\",\n \"credentialTarget\": \"<string>\",\n \"privateReference\": \"<string>\",\n \"authorityRef\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"payeePrincipalId": "<string>",
"railId": "<string>",
"credentialType": "<string>",
"credentialTarget": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "request authentication failed"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}Authorizations
Provisioned actor identifier.
Current Unix timestamp in seconds, within the configured clock-skew window.
Ambient-HMAC followed by a space and the unpadded base64url HMAC-SHA256 signature. See Authentication and authority for the canonical input.
Body
Actor-scoped idempotency key. Retry the identical command with the same value.
1Principal represented by the authenticated actor.
11Public target participants use when obtaining rail-specific authorization material.
1Private adapter routing reference. It is never returned to participants.
1Required delegation identifier when the actor and principal differ. Omit for self-action.
1Response
An existing identical self-service command replayed; new bindings are currently rejected.