Skip to main content
POST
Register a payee rail through the bootstrap operator

Authorizations

X-Ambient-Actor
string
header
required

Provisioned actor identifier.

X-Ambient-Timestamp
string
header
required

Current Unix timestamp in seconds, within the configured clock-skew window.

Authorization
string
header
required

Ambient-HMAC followed by a space and the unpadded base64url HMAC-SHA256 signature. See Authentication and authority for the canonical input.

Body

application/json
commandId
string
required

Actor-scoped idempotency key. Retry the identical command with the same value.

Minimum string length: 1
payeePrincipalId
string
required

Principal represented by the authenticated actor.

Minimum string length: 1
railId
string
required
Minimum string length: 1
credentialTarget
string
required
Minimum string length: 1
privateReference
string
required
write-only
Minimum string length: 1

Response

Payee rail registration created or an identical command replayed.

payeePrincipalId
string
required

Principal represented by the authenticated actor.

Minimum string length: 1
railId
string
required
credentialType
string
required
credentialTarget
string
required
createdAt
string<date-time>
required