Approval

Schema #/components/schemas/Approval of contract 1.0.0-draft.14.

  • id Uuidrequiredread-only

    Fields of id
  • subjectType ApprovalSubjectTyperequired

  • subjectId Uuidrequired

  • subjectSummary objectrequired

    Fields of subjectSummary
    • title stringrequired

    • amount Money | null

    • recipientName string | null

      Recipient (payments, recipients) or counterparty name.

    • sourceBalanceId Uuid | null

    • sourceBalanceName string | null

    • rail Rail | null

    • itemCount integer | null

      Bulk uploads: payments in the batch.

      min 0

    • recipientMaskedIdentifier string | null

      Masked account identifier of the recipient the approver binds to (payments: the snapshot taken at submission, which the payment is sent to or refused against; recipients: the current details). Null for other subjects (security audit S-01, D-47).

  • tier integerrequired

    min 0

  • status ApprovalStatusrequiredread-only

    Fields of status
  • requiredApprovals integerrequired

    min 1

  • received integerrequiredread-only

    Approvals received so far (approved decisions).

    min 0

  • decisions array of objectrequired

    Fields of decisions
    • by Uuid

    • byName string

    • decision string

      One of: "approved", "rejected"

    • comment string | null

    • at Timestamp

  • requestedBy Uuidrequired

  • requestedByName string

  • canDecide booleanrequiredread-only

    Whether the caller is an eligible approver (not the requester unless self-approval allowed).

  • expiresAt Timestamp | null

  • createdAt Timestamprequiredread-only

    Fields of createdAt
  • policy objectread-only

    The effective policy tier the request is judged against.

    Fields of policy
    • kind ApprovalPolicyKind | null

    • source stringrequired

      snapshot: the tier captured when the request opened; policy: the current policy; default: the built-in single approval; recipient: recipient approval mode.

      One of: "snapshot", "policy", "default", "recipient"

    • tier ApprovalTierrequired

    • issues array of objectrequired

      Fields of issues
      • code stringrequired

      • message stringrequired