Skip to main content
POST
Queue a payment authorization

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
authorizationId
string
required
Minimum string length: 1
railId
string
required
Minimum string length: 1
principalId
string
required

Principal represented by the authenticated actor.

Minimum string length: 1
payeePrincipalId
string
required

Principal represented by the authenticated actor.

Minimum string length: 1
marketId
string
required
Minimum string length: 1
amountMinor
integer<int64>
required
Required range: x >= 1
currency
string
required

Three-letter uppercase currency code.

Pattern: ^[A-Z]{3}$
Example:

"USD"

expiresAt
string<date-time>
required
authorityRef
string

Required delegation identifier when the actor and principal differ. Omit for self-action.

Minimum string length: 1
paymentCredential
string
write-only

Private one-time authorization material required by some rails.

Minimum string length: 1

Response

Authorization operation queued or an identical command replayed.

commandId
string
required

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

Minimum string length: 1
kind
string
required
Allowed value: "payment.authorize"
railId
string
required
authorizationId
string
required
identity
object
required
request
object
required
status
enum<string>
required
Available options:
pending,
leased,
succeeded,
failed
attempts
integer<uint32>
required
nextAttemptAt
string<date-time>
required
occurredAt
string<date-time>
required
recordedAt
string<date-time>
required
updatedAt
string<date-time>
required
leaseUntil
string<date-time>
lastError
string
rejectionCode
string
result
object