Skip to content

by Startups.Studio

Order.screen

POST /{namespace}/orders/{order}/screen

Screen scores an Order’s payment before it is charged and allows, authenticates, holds or blocks it by the Startup’s risk Policy.

Noun: Order
Mode: do
Event: Order.screened

You, to your agent

Screen the latest order.

curl -X POST https://api.sb/quietcopy.com/orders/order_1/screen \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const { outcome, risk, rule, order } = await $.Order.screen({ order: 'order_1' })

npx startup-builder do Order.screen --json '{"order":"order_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Order.screen({ order: 'order_1' })"
  }
}

Inputs

Input	Type	Required	Description
`order`	Order	required	The placed Order whose payment is screened.

Outputs

Output	Type	Required	Description
`outcome`	`string`	required	`allow` charges, `authenticate` asks the buyer to confirm with their card issuer, `review` waits for an Approval, `block` cancels.
`risk`	`number`	required	The payment’s risk score from 0 to 99, as Stripe scored it.
`rule`	`string`		The risk Policy rule that decided the outcome, when one did.
`order`	Order	required	The Order screened.

Effects

Emits Order.screened.
Performed by the Risk Analyst.
Two-way: it runs at once, in the try, send and do modes.
An Order held for review opens an Approval for the Risk Analyst and is not charged until approved.
A blocked Order is canceled and never charged.
An early fraud warning stops fulfillment at once and, at or below the dispute fee, proposes a refund that waits its window.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Order.screen

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Order.revise

Previous Page

Order.start

Next Page