Skip to main content
GET
Preview a transaction's spend review
spendReview is the transaction’s review (null when it was never submitted). policy is the policy that matches the transaction as it stands now, with its custom fields: autoAction NONE means it needs the approvers in approvals (submit it with POST .../spend-review/request — unless a policy once approved it automatically: such a transaction can only be approved automatically again), APPROVE with a policy id that submitting approves it at once, DENY that submitting is refused, and APPROVE with no other field that no policy matches — it needs no review. policy is null when there is nothing to evaluate: the review is already PENDING_APPROVAL or APPROVED, or the transaction moved no money (financialImpactType NONE). A review still pending past its deadline is settled first with the approval request’s final outcome — APPROVED, or DECLINED with its declineOutcome (EXPIRED when nobody decided). The transaction’s stored custom fields are checked first: a required transaction custom field with no value is a 422 — set it with PUT .../custom-fields. The policies are never skipped: when they can’t be evaluated, the answer is a 503. On the organization’s main wallet, only organization admins can do this; on another wallet, organization admins and the users it is shared with as OWNER or USER. Use default as walletId for the main wallet, and send x-environment: LIVE for production wallets.

Headers

x-environment
enum<string>

Environment of the wallet: LIVE (production) or TEST (sandbox). When you omit it, the request runs in TEST; any other value is rejected.

Available options:
LIVE,
TEST

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization the wallet belongs to.

Format: UUID

accountId
string
required

ID of the organization's account (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$
walletId
string
required

ID of the wallet (24 hexadecimal characters), or default for the organization's main wallet.

Pattern: ^([0-9a-fA-F]{24}|default)$
transactionId
string
required

ID of the transaction (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$

Response

Successful response

Where the transaction stands with spend review, and what submitting it would do.

spendReview
object | null
required

The transaction's review, or null when it was never submitted (or its review was reset by a change of its custom fields).

policy
object | null
required

What the organization's spend-review policies say about the transaction as it stands now. null when there is nothing to evaluate: the review is PENDING_APPROVAL or APPROVED, or the transaction moved no money (financialImpactType NONE).