Objects
Every object the API answers with, and what each field means. Amounts are whole cents; times are ISO 8601 in UTC.
ach_authorization
A customer's ACH debit authorization: the bank account and limits they signed for.
| Field | Meaning |
|---|---|
account_last4 | Last 4 digits of the bank account. |
active | Whether it is in force right now. |
bank_name | The bank's name. |
confirmed_with | How the customer signed this permission (Face ID, fingerprint, texted code). |
created_at | When it was created (ISO 8601, UTC). |
customer_external_ref | Your own id for the customer. |
expires_at | When it expires (ISO 8601, UTC). |
for_agent_only | True when this bank authorization is only for one AI agent's orders. |
id | Wilby's id for it (a prefix plus 20 characters, like prm_… for an order). |
merchant_ids | Wilby's ids for the stores. |
monthly_cents | The most per month. |
notice | Something to tell the customer. |
object | What kind of object this is (order, incremental_charge, mandate…). |
per_order_cents | The most per order. |
rail | How the money moves: card or ach. |
range_cents | The allowed amount range. |
revoked_at | When it was revoked. |
agent_access_report
AI agent orders allowed and refused by your agent access settings.
| Field | Meaning |
|---|---|
agents | Per-agent figures (orders, amounts, refusals) or the list of agents seen. |
gate | Your agent access setting at the time. |
object | What kind of object this is (order, incremental_charge, mandate…). |
period_days | How many days the figures cover. |
agent_check
A check of who an AI agent is and whether the customer approved what it did.
| Field | Meaning |
|---|---|
agent | The AI agent, by its short name (claude, chatgpt, gemini, copilot, perplexity, grok, other). |
agent_name | The agent's display name, as the customer named it or as the platform reports it. |
allowed | Whether it is allowed (true or false), or the list of what is allowed. |
browser_signals | Signs of an AI agent working inside the customer's own browser, from /agent-signals.js on the checkout page. In a request: the wilby_signals summary (counts and yes/no markers only). In an answer: sent and found (each with id, label and strength: strong or weak). Never makes a check "verified". |
buyer_hints | What a verified agent relayed about its buyer in the Forwarded header: country, time_zone, locale. Read only when the signature checks out; the buyer's IP address is never read or kept. |
clue | What gave the agent away (for example a signed request or a known platform address). |
created_at | When it was created (ISO 8601, UTC). |
customer_approval | Whether and how the customer approved this themselves. |
expires_at | When it expires (ISO 8601, UTC). |
host | The website address where it happened. |
id | Wilby's id for it (a prefix plus 20 characters, like prm_… for an order). |
level | How sure Wilby is about an AI agent: verified (signed), named_itself, likely_agent or no_sign_of_agent. |
object | What kind of object this is (order, incremental_charge, mandate…). |
order_id | The order's id (prm_…). |
signed_for | For a request signed with a card network tag: browsing (agent-browser-auth) or paying (agent-payer-auth). |
used_at | When it was used. |
verified | True when it was verified. |
agent_readiness
The Agent Readiness Check: how ready each store is for AI agents, with what to fix.
| Field | Meaning |
|---|---|
business | The business: its name and checks, or who issued the quote. |
checked_at | When the check ran. |
grade | A word for the score: ready, almost_ready or not_ready. |
more_stores | How many stores weren't checked in this run. |
object | What kind of object this is (order, incremental_charge, mandate…). |
score | A score out of 100. |
stores | Stores, or per-store results. |
stores_checked | How many stores were checked. |
agent_visit_report
AI agent visits to your website.
| Field | Meaning |
|---|---|
agents | Per-agent figures (orders, amounts, refusals) or the list of agents seen. |
days | A number of days, or the days of the week (0 = Sunday) for hours. |
kept | How long it is kept. |
object | What kind of object this is (order, incremental_charge, mandate…). |
analytics_summary
Your figures for a date range.
| Field | Meaning |
|---|---|
agents | Per-agent figures (orders, amounts, refusals) or the list of agents seen. |
bank | Bank account details for an ACH debit authorization. |
customers | Customer figures. |
disputes | Dispute figures. |
estimates | Estimate accuracy figures. |
from | Start date (YYYY-MM-DD) or start of the range. |
incremental_charges | Incremental charge figures. |
merchant_id | Wilby's id for the store (mer_…). |
mode | sandbox (test) or live. In agent access: all or only. |
money | Money figures. |
object | What kind of object this is (order, incremental_charge, mandate…). |
orders | Order figures, or a list of orders. |
shadow | Shadow mode results (Wilby checks without blocking). |
to | End date (YYYY-MM-DD) or end of the range. |
tz | An IANA time zone, like America/New_York. |
webhooks | Webhook figures. |
approval
Wilby's signed yes (or no) for one payment.
| Field | Meaning |
|---|---|
allowed | Whether it is allowed (true or false), or the list of what is allowed. |
amount_cents | An amount in cents (US dollars). On an order: the price, or the estimate when the price can change. On a payment or refund: that payment's amount. |
approval_id | The id of the approval Wilby gave (the signed yes for a payment). |
card_indicators | Card network values for this payment (for example the merchant-initiated and estimated-authorization indicators) to send with your processor call. |
kind | What kind it is. On an approval: authorize, capture, charge or refund. On a payment report: what happened. |
object | What kind of object this is (order, incremental_charge, mandate…). |
order_id | The order's id (prm_…). |
proof | The signed proof of the decision. |
reason | Why, as a code or in words. On an incremental charge: the store's reason the customer sees. |
valid_until | When it stops being valid. |
approval_attempts
Approval results by device and what went wrong (13 months).
| Field | Meaning |
|---|---|
approved | Whether it was approved. |
days | A number of days, or the days of the week (0 = Sunday) for hours. |
devices | Approval results by device. |
object | What kind of object this is (order, incremental_charge, mandate…). |
problems | What went wrong, counted. |
approval_code
A one-time approval code that was sent.
| Field | Meaning |
|---|---|
code_id | The id of a sent code. Send it back with the code the customer types. |
expires_at | When it expires (ISO 8601, UTC). |
incremental_charge_id | The incremental charge's id (top_…). |
object | What kind of object this is (order, incremental_charge, mandate…). |
sent_by | How it was sent (text or email). |
sent_to | Where it was sent (masked). |
approval_link
A link where the customer approves.
| Field | Meaning |
|---|---|
answer_by | When the customer has to answer by; after that the request expires. |
approval_url | The page where the customer approves or declines. Open it in an in-app browser or send it by text. |
incremental_charge_id | The incremental charge's id (top_…). |
object | What kind of object this is (order, incremental_charge, mandate…). |
authorization_suggestion
Wilby's suggested amount and maximum for an order.
| Field | Meaning |
|---|---|
basis | What the suggestion is based on. |
card_funding | The card type: credit, debit or prepaid. |
entered_amount_cents | The amount you entered, for comparison with the suggestion. |
explanation | Plain-words explanation. |
history | Past values the suggestion used. |
max_multiple | The suggested maximum as a multiple of the amount. |
merchant_id | Wilby's id for the store (mer_…). |
object | What kind of object this is (order, incremental_charge, mandate…). |
preapproved_overage_pct | How far above the amount the customer lets you charge without asking (percent). |
suggested_amount_cents | Wilby's suggested amount. |
suggested_max_amount_cents | Wilby's suggested maximum. |
bank_account
A customer's bank account and its check status.
| Field | Meaning |
|---|---|
account_last4 | Last 4 digits of the bank account. |
bank_name | The bank's name. |
next | What to do next. |
object | What kind of object this is (order, incremental_charge, mandate…). |
payment_method_ref | Your processor's id for the customer's saved card or bank account. |
reason | Why, as a code or in words. On an incremental charge: the store's reason the customer sees. |
status | Where it stands. On an incremental charge: pending, approved, declined, expired, cancelled. |
verification_id | The bank account check's id. |
confirmation_request
Statements only the customer can confirm, with the link to confirm them.
| Field | Meaning |
|---|---|
expires_at | When it expires (ISO 8601, UTC). |
object | What kind of object this is (order, incremental_charge, mandate…). |
statements | Statements only the customer can confirm (for example "I am 21 or older"). |
url | An address. |
credential_bundle
Signed credentials (permissions) and how to check them.
| Field | Meaning |
|---|---|
format | The format of the file or credential. |
how_to_verify | How anyone can check the signature themselves. |
issuer | Who issued or signed it. |
jwks | Public keys (JSON Web Key Set). |
mandates | Signed permissions. |
object | What kind of object this is (order, incremental_charge, mandate…). |
profile | Which profile of the standard. |
verifiable_intent | Verifiable Intent credentials. |
custom_domain
Your own address for your agent connector (for example agents.yourbusiness.com), its DNS records and status.
| Field | Meaning |
|---|---|
activated_at | When your own address started serving your connector. |
certificate | The security certificate for your own address: waiting_for_dns, requested or Cloudflare's status while it's being made (for example pending_validation), then active. On /v1/keys: proof that a signing key is Wilby's. body (canonical JSON naming the key and its use, records or mandates) is signed with a root key that never leaves Google's hardware; check signature (ECDSA P-256 with SHA-256, DER, base64url) with root_public_key_pem. |
checked_at | When the check ran. |
connector_url | Your connector's address on your own domain (https://<host>/mcp). |
created_at | When it was created (ISO 8601, UTC). |
dns_records | The DNS records to add for your own address: type, name, value, purpose. |
host | The website address where it happened. |
id | Wilby's id for it (a prefix plus 20 characters, like prm_… for an order). |
last_error | What the last check couldn't find, in plain words. |
note | A note in plain words. |
object | What kind of object this is (order, incremental_charge, mandate…). |
status | Where it stands. On an incremental charge: pending, approved, declined, expired, cancelled. |
verified_at | When Wilby first found your DNS records. |
customer
A customer.
| Field | Meaning |
|---|---|
external_ref | Your own id for it. |
object | What kind of object this is (order, incremental_charge, mandate…). |
payment_method_saved | True when a payment method is saved for the customer. |
customer_contact
How to reach a customer for a code.
| Field | Meaning |
|---|---|
email | An email address (shown masked when read back). |
external_ref | Your own id for it. |
kept_days | How many days it is kept. |
label | A short name shown to people. |
object | What kind of object this is (order, incremental_charge, mandate…). |
customer_overage
A customer's rule for extra charges.
| Field | Meaning |
|---|---|
approval_required_above_cents | Above this amount, the customer approves each incremental charge themselves. |
choices_pct | The percent choices offered to the customer for extra charges. |
confirmed_via | How the customer confirmed (passkey, texted code, signed-in session). |
customer_external_ref | Your own id for the customer. |
has_rule | Whether the customer has chosen a rule. |
object | What kind of object this is (order, incremental_charge, mandate…). |
preapproved_overage_pct | How far above the amount the customer lets you charge without asking (percent). |
recommended_pct | The choice shown as recommended. |
updated_at | When it last changed. |
customer_overage_change
A request to change a customer's extra-charge rule.
| Field | Meaning |
|---|---|
approval_required_above_cents | Above this amount, the customer approves each incremental charge themselves. |
confirmed_via | How the customer confirmed (passkey, texted code, signed-in session). |
expires_at | When it expires (ISO 8601, UTC). |
message | Plain words for people. On an error: what went wrong. |
object | What kind of object this is (order, incremental_charge, mandate…). |
preapproved_overage_pct | How far above the amount the customer lets you charge without asking (percent). |
reason | Why, as a code or in words. On an incremental charge: the store's reason the customer sees. |
status | Where it stands. On an incremental charge: pending, approved, declined, expired, cancelled. |
url | An address. |
dashboard_link
A link into the Dashboard.
| Field | Meaning |
|---|---|
expires_at | When it expires (ISO 8601, UTC). |
id | Wilby's id for it (a prefix plus 20 characters, like prm_… for an order). |
merchant_id | Wilby's id for the store (mer_…). |
object | What kind of object this is (order, incremental_charge, mandate…). |
revoked | True when it was revoked. |
url | An address. |
dashboard_open_link
A one-time link that opens the Dashboard.
| Field | Meaning |
|---|---|
can_edit | Whether this dashboard link can change settings (or only view). |
expires_at | When it expires (ISO 8601, UTC). |
id | Wilby's id for it (a prefix plus 20 characters, like prm_… for an order). |
merchant_id | Wilby's id for the store (mer_…). |
object | What kind of object this is (order, incremental_charge, mandate…). |
session_hours | How long a session lasts (hours). |
single_use | True when the link works once. |
url | An address. |
dispute
A dispute about an order.
| Field | Meaning |
|---|---|
checks | The individual checks, each with a status and what to fix. |
created_at | When it was created (ISO 8601, UTC). |
evidence_submitted_at | When dispute evidence was sent to the processor. |
id | Wilby's id for it (a prefix plus 20 characters, like prm_… for an order). |
note | A note in plain words. |
object | What kind of object this is (order, incremental_charge, mandate…). |
opened_by | Who opened the dispute: the customer, the store or the processor. |
order | The order. |
order_id | The order's id (prm_…). |
outcome | How it ended. |
partner_must | What you need to do next. |
processor_dispute_id | The dispute's id at the processor. |
processor_status | The status at the processor. |
reason | Why, as a code or in words. On an incremental charge: the store's reason the customer sees. |
refund_cents | An amount to refund, in cents. On a dispute: how much was refunded. |
resolved_at | When it was settled. |
resolved_by | Who settled it. |
source | Where it came from. |
why | Why, in words. |
evidence
One piece of evidence.
| Field | Meaning |
|---|---|
id | Wilby's id for it (a prefix plus 20 characters, like prm_… for an order). |
label | A short name shown to people. |
object | What kind of object this is (order, incremental_charge, mandate…). |
sha256 | SHA-256 fingerprint. |
type | What kind it is. |
evidence_package
The dispute evidence package for an order.
| Field | Meaning |
|---|---|
agent_did | The agent's decentralized identifier, when the agent signed with one. |
allowed | Whether it is allowed (true or false), or the list of what is allowed. |
finding | The result, as a code. |
finding_text | The result in words. |
generated_at | When it was put together. |
how_to_use | How to use this. |
mode | sandbox (test) or live. In agent access: all or only. |
object | What kind of object this is (order, incremental_charge, mandate…). |
reported | What was reported. |
resolution | How it was settled. |
summary | A short, screen-ready summary. |
verification | How to verify it. |
fulfillment_event
A shipment or delivery step.
| Field | Meaning |
|---|---|
carrier | The shipping company. |
description | Plain text describing it. On an order: what was ordered. |
id | Wilby's id for it (a prefix plus 20 characters, like prm_… for an order). |
line_items | The items, each with a name, quantity and amount. |
object | What kind of object this is (order, incremental_charge, mandate…). |
occurred_at | When it happened. |
order_id | The order's id (prm_…). |
tracking_number | The shipment's tracking number. |
tracking_url | The tracking page (https). |
type | What kind it is. |
google_orders
Your Google order updates setting.
| Field | Meaning |
|---|---|
google_partner_id | Your Google partner id. |
key_last4 | The last 4 characters of a saved key. |
note | A note in plain words. |
object | What kind of object this is (order, incremental_charge, mandate…). |
saved | True when it is saved. |
saved_at | When it was saved. |
hold
The answer to the one-call hold (POST /v1/orders/{id}/hold).
| Field | Meaning |
|---|---|
approval_id | The id of the approval Wilby gave (the signed yes for a payment). |
object | What kind of object this is (order, incremental_charge, mandate…). |
payment | A payment: its amount, status and processor reference. |
incremental_charge
A request to charge more than the order's amount, and the customer's answer.
| Field | Meaning |
|---|---|
decided_via | How the customer decided: passkey (on Wilby's page or in your app), in_page_passkey (on your website), one_time_code, or their rule (within their limits). |
id | Wilby's id for it (a prefix plus 20 characters, like prm_… for an order). |
object | What kind of object this is (order, incremental_charge, mandate…). |
order | The order. |
status | Where it stands. On an incremental charge: pending, approved, declined, expired, cancelled. |
incremental_charge_preview
What would happen if you asked for this incremental charge.
| Field | Meaning |
|---|---|
amount_cents | An amount in cents (US dollars). On an order: the price, or the estimate when the price can change. On a payment or refund: that payment's amount. |
approval_required_above_cents | Above this amount, the customer approves each incremental charge themselves. |
decision | What would happen: approved by the customer's rule, or the customer must approve. |
max_amount_cents | The most that may be charged for the order without asking the customer again. |
new_total_cents | The order total after this incremental charge. |
object | What kind of object this is (order, incremental_charge, mandate…). |
order_id | The order's id (prm_…). |
pending_incremental_charge_id | The incremental charge already waiting for the customer, if any. |
room_cents | How much is left before the customer has to approve. |
rule | The customer's rule that applied. |
stage | Where the order is: created, confirmed, authorized, captured, cancelled, expired, disputed. |
integration_check
What's done and what's left before going live.
| Field | Meaning |
|---|---|
checked_at | When the check ran. |
done | True when it's finished (for an approval: the customer said yes). |
groups | Items grouped by area. |
mode | sandbox (test) or live. In agent access: all or only. |
object | What kind of object this is (order, incremental_charge, mandate…). |
path | Which way to integrate, or a path. |
ready_for_live | True when everything needed for live is done. |
total | The total. |
variable_amount | Whether your final price can change after checkout (default false). |
mandate
A customer's permission for an AI agent: limits, stores and dates.
| Field | Meaning |
|---|---|
ach_authorization_id | The ACH debit authorization this order is paid under (bank payments). |
active | Whether it is in force right now. |
agent_name | The agent's display name, as the customer named it or as the platform reports it. |
ask_every_time | True when the customer approves every order themselves (no amount is preapproved). |
budget_period | Whether the customer's budget is per month or for the whole permission. |
confirmed_with | How the customer signed this permission (Face ID, fingerprint, texted code). |
created_at | When it was created (ISO 8601, UTC). |
customer_external_ref | Your own id for the customer. |
expires_at | When it expires (ISO 8601, UTC). |
id | Wilby's id for it (a prefix plus 20 characters, like prm_… for an order). |
max_orders | The most orders allowed under the permission. |
monthly_cents | The most per month. |
not_before | Not valid before this time. |
object | What kind of object this is (order, incremental_charge, mandate…). |
pause_reason | Why it is paused. |
paused | True when it is paused. |
paused_at | When it was paused. |
pays_by | How orders under this permission are paid (card or bank). |
per_order_cents | The most per order. |
revoked_at | When it was revoked. |
source | Where it came from. |
store_ids | The stores allowed. |
tips_count_toward_limits | Whether tips count toward the AI agent's limits (the customer chooses; default true). |
merchant
A store.
| Field | Meaning |
|---|---|
created | True when this call created it, false when it already existed. |
external_ref | Your own id for it. |
id | Wilby's id for it (a prefix plus 20 characters, like prm_… for an order). |
name | A name. |
object | What kind of object this is (order, incremental_charge, mandate…). |
processor | The payment processor (stripe, square, braintree, adyen, paypal). |
new_phone_code
A code sent to set up a passkey on a new device.
| Field | Meaning |
|---|---|
code_id | The id of a sent code. Send it back with the code the customer types. |
expires_at | When it expires (ISO 8601, UTC). |
incremental_charge_id | The incremental charge's id (top_…). |
object | What kind of object this is (order, incremental_charge, mandate…). |
sent_by | How it was sent (text or email). |
sent_to | Where it was sent (masked). |
order
An order.
| Field | Meaning |
|---|---|
ach_authorization_id | The ACH debit authorization this order is paid under (bank payments). |
agent_check | The agent check for this order (who the agent was and how sure Wilby is), when one was made. |
agent_identity | What Wilby could verify about the agent that placed the order (signed request, known platform). |
agent_mandates | Signed permissions an outside agent platform sent with the order (AP2 or Verifiable Intent): checkout, payment and the customer's open permissions. |
amount_cents | An amount in cents (US dollars). On an order: the price, or the estimate when the price can change. On a payment or refund: that payment's amount. |
authorized_at | When the money was authorized (held) or charged. |
cancelled_at | When it was cancelled. |
capture_cents | The final amount captured for the order. |
captured_at | When the final amount was captured. |
captured_cents | How much has been captured so far. |
confirmed_at | When the store confirmed the order. |
created_at | When it was created (ISO 8601, UTC). |
currency | The currency (USD). |
customer_approval | Whether and how the customer approved this themselves. |
customer_id | Wilby's id for the customer. |
display_ref | Your order number as customers know it (shown on Wilby's pages). |
expires_at | When it expires (ISO 8601, UTC). |
external_ref | Your own id for it. |
funding_method | How the order was paid: hold (authorized, captured later), charge (paid at once) or bank_debit. |
held_cents | How much is held (authorized, not yet captured). |
id | Wilby's id for it (a prefix plus 20 characters, like prm_… for an order). |
mandate_id | The customer's permission (mandate) this order was placed under. |
max_amount_cents | The most that may be charged for the order without asking the customer again. |
merchant_id | Wilby's id for the store (mer_…). |
mode | sandbox (test) or live. In agent access: all or only. |
object | What kind of object this is (order, incremental_charge, mandate…). |
order_type | Your kind of order (your own word). |
owed_cents | How much the customer still owes on the order. |
paid_cents | How much has been paid. |
pending_cents | How much is still in progress (a bank debit not yet cleared). |
pricing_terms | Your pricing terms for the order (your own keys), shown to the customer. |
processor | The payment processor (stripe, square, braintree, adyen, paypal). |
purpose | What the order is for, in plain words. |
rail | How the money moves: card or ach. |
refund_due_cents | A refund owed to the customer that is waiting (for example for a bank debit to clear first). |
refunded_cents | How much has been refunded so far. |
reviewer | True on calls and orders from the directory reviewer's test account (listing.reviewer_customer_ref): use test payments, send no store texts. Wilby cancels reviewer orders after 30 minutes. |
service_paid_cents | How much was paid for the order itself, without tips. |
spec_version | The version of the order format. |
stage | Where the order is: created, confirmed, authorized, captured, cancelled, expired, disputed. |
tip_cents | The tip, in cents. |
partner_settings
Your settings.
| Field | Meaning |
|---|---|
agent_access | Which AI agents may order from you: mode all or only, allowed, blocked, verified_only. |
agent_rules | Your own rules for AI agent orders, stricter than the customer's: max_order_cents, always_approval_required_above_cents, hours. |
apps | Your iOS and Android apps, so customers can approve inside your app. |
branding | Your look on customer pages: display_name, accent_color, secondary_color, logo_data_uri, show_secured_by. |
embed_origins | Your websites that may show the Dashboard inside your own dashboard (up to 5 https origins). |
first_setup_code | Before a customer's first passkey, a one-time code proves it's them (default true). |
google_orders | Google order updates: whether your key is saved. |
listing | What AI app directories ask for: one_liner, long_description, privacy_url, support, docs_url, example_prompts, reviewer_customer_ref, reviewer_steps. |
object | What kind of object this is (order, incremental_charge, mandate…). |
passkey_websites | Which of your websites can show the Face ID prompt themselves (in_page) and which use Wilby's window (wilby_window). |
recommended_pct | The choice shown as recommended. |
return_url | Where Wilby's pages send the customer when they are done (https, or your app's own link). |
rule_choices_pct | The percent choices offered to customers for extra charges (1 to 4). |
screen_origins | Your websites where Wilby's ready-made screens run (up to 10 https origins). |
storefront | Your Agent Storefront: enabled, slug, name, description, login_url, api_url, answers, extras, times_path. |
stripe_key | Your Stripe restricted key (saved, never shown again). |
ucp | Google's agent checkout (UCP): enabled, require_signatures, share_saved_addresses, prefer_mcp, public_base_url, version, terms_url, website_url, google_pay. |
variable_amount | Whether your final price can change after checkout (default false). |
website_agents | AI agents on your own website: likely (record_only or ask_customer). |
wording | Your own lines on customer pages (keys like extra_title; null goes back to Wilby's default). |
passkey_prompt
A Face ID / Touch ID / fingerprint prompt to show the customer.
| Field | Meaning |
|---|---|
amount_cents | An amount in cents (US dollars). On an order: the price, or the estimate when the price can change. On a payment or refund: that payment's amount. |
ceremony_id | The id of a Face ID / Touch ID / fingerprint prompt. Send it back when finishing. |
code_approval_available | True when the customer can approve with a texted code here. |
device | The customer's device: kind (iphone, android, mac, windows…), lock (Face ID, Touch ID, fingerprint, Windows Hello) and name. |
incremental_charge_id | The incremental charge's id (top_…). |
kind | What kind it is. On an approval: authorize, capture, charge or refund. On a payment report: what happened. |
likely_on_another_device | True when the customer's passkey is probably on another device (offer to set up this one, or a code). |
new_phone_available | True when the customer can set up a passkey on this device with a texted code. |
object | What kind of object this is (order, incremental_charge, mandate…). |
options | The prompt options to pass to the browser's WebAuthn call, or a service's options. |
rp_id | The passkey's website (relying party id). |
passkey_result
The result of a Face ID / Touch ID / fingerprint prompt.
| Field | Meaning |
|---|---|
decided_via | How the customer decided: passkey (on Wilby's page or in your app), in_page_passkey (on your website), one_time_code, or their rule (within their limits). |
done | True when it's finished (for an approval: the customer said yes). |
incremental_charge_id | The incremental charge's id (top_…). |
next | What to do next. |
object | What kind of object this is (order, incremental_charge, mandate…). |
order | The order. |
status | Where it stands. On an incremental charge: pending, approved, declined, expired, cancelled. |
payment_report
Wilby's answer to a payment you reported.
| Field | Meaning |
|---|---|
approval_problem | Why the reported payment didn't match an approval, when it didn't. |
approved | Whether it was approved. |
object | What kind of object this is (order, incremental_charge, mandate…). |
order | The order. |
payment_id | The payment's id (pay_…). |
shadow_verdict | What Wilby would have decided in shadow mode. |
payments_path
Which way payments run for you.
| Field | Meaning |
|---|---|
applies_to | What this applies to. |
object | What kind of object this is (order, incremental_charge, mandate…). |
path | Which way to integrate, or a path. |
report
An acknowledgment.
| Field | Meaning |
|---|---|
object | What kind of object this is (order, incremental_charge, mandate…). |
ok | True when it worked. |
screen_session
A screen pass for Wilby's ready-made screens on your website.
| Field | Meaning |
|---|---|
client_secret | A secret shown once. For a screen pass: hand it to your page (never your API key). |
customer_external_ref | Your own id for the customer. |
expires_at | When it expires (ISO 8601, UTC). |
id | Wilby's id for it (a prefix plus 20 characters, like prm_… for an order). |
object | What kind of object this is (order, incremental_charge, mandate…). |
order_id | The order's id (prm_…). |
signed_quote
A signed price quote and whether its signature checks out.
| Field | Meaning |
|---|---|
algorithm | The signature algorithm (Ed25519 for Wilby's signatures). |
document | The signed document itself (exactly what was signed). |
document_sha256 | SHA-256 of the signed document. |
how_to_verify | How anyone can check the signature themselves. |
key_id | Which signing key signed it (look it up at /v1/keys). |
mode | sandbox (test) or live. In agent access: all or only. |
object | What kind of object this is (order, incremental_charge, mandate…). |
signature | The signature. |
status | Where it stands. On an incremental charge: pending, approved, declined, expired, cancelled. |
summary | A short, screen-ready summary. |
valid_signature | True when the signature checks out. |
verify_url | A page anyone can open to check it. |
store_agent_rules
Your AI agent rules for one store.
| Field | Meaning |
|---|---|
applies | Which rules apply here. |
merchant_id | Wilby's id for the store (mer_…). |
object | What kind of object this is (order, incremental_charge, mandate…). |
store | The store. |
storefront_listing
Listing materials and checklist for AI app directories.
| Field | Meaning |
|---|---|
checked_at | When the check ran. |
done | True when it's finished (for an approval: the customer said yes). |
groups | Items grouped by area. |
materials | Ready-to-copy listing text. |
mode | sandbox (test) or live. In agent access: all or only. |
object | What kind of object this is (order, incremental_charge, mandate…). |
total | The total. |
storefront_secret
Your storefront signing secret (shown once).
| Field | Meaning |
|---|---|
note | A note in plain words. |
object | What kind of object this is (order, incremental_charge, mandate…). |
secret | A secret shown once. Keep it on your server. |
storefront_sign_in
A customer sign-in from your login page.
| Field | Meaning |
|---|---|
continue_url | Where to send the customer next. |
expires_at | When it expires (ISO 8601, UTC). |
object | What kind of object this is (order, incremental_charge, mandate…). |
purpose | What the order is for, in plain words. |
repeated | True when the same sign-in was sent again (for example a double click): a fresh continue_url for the same customer. |
request_id | The sign-in request's id (oar_… or csi_…). |
storefront_test
The Full Storefront Test: each step an AI agent takes against one store, what happened and what to fix.
| Field | Meaning |
|---|---|
checked_at | When the check ran. |
directory_rules_checked | When the directory rules were last checked against the AI app directories' published rules. |
failures | How many steps need fixing. |
object | What kind of object this is (order, incremental_charge, mandate…). |
passed | How many steps passed. |
result | The overall result: ready, mostly_ready or fix_needed. |
steps | Each step: id, label, status (pass, warn, fail, skipped), detail (what happened), fix (what to do) and source (contract, ai_misread or directory). |
store_name | The store's name. |
store_ref | Your id for the store. |
warnings | How many steps could be improved. |
stripe_key
Your saved Stripe key.
| Field | Meaning |
|---|---|
kind | What kind it is. On an approval: authorize, capture, charge or refund. On a payment report: what happened. |
last4 | The last 4 digits or characters. |
note | A note in plain words. |
object | What kind of object this is (order, incremental_charge, mandate…). |
permissions_needed | What your key still needs permission to do. |
saved | True when it is saved. |
saved_at | When it was saved. |
test_acp_signature
Test tools: a signed test request.
| Field | Meaning |
|---|---|
issuer | Who issued or signed it. |
note | A note in plain words. |
object | What kind of object this is (order, incremental_charge, mandate…). |
platform_kid | The agent platform's key id. |
signature | The signature. |
timestamp | When it was signed. |
test_mandates
Test tools: signed test permissions.
| Field | Meaning |
|---|---|
issuer | Who issued or signed it. |
note | A note in plain words. |
object | What kind of object this is (order, incremental_charge, mandate…). |
open_checkout_mandate | Test tools: a signed open checkout permission. |
open_payment_mandate | Test tools: a signed open payment permission. |
test_vi_credential
Test tools: a test Verifiable Intent credential.
| Field | Meaning |
|---|---|
issuer | Who issued or signed it. |
l1 | Test tools: the issuer layer of a Verifiable Intent credential. |
note | A note in plain words. |
object | What kind of object this is (order, incremental_charge, mandate…). |
trusted_issuer
An issuer whose signed permissions you trust.
| Field | Meaning |
|---|---|
enabled | Whether it is turned on. |
enabled_at | When it was turned on. |
format | The format of the file or credential. |
id | Wilby's id for it (a prefix plus 20 characters, like prm_… for an order). |
kid | Key id. |
name | A name. |
note | A note in plain words. |
object | What kind of object this is (order, incremental_charge, mandate…). |
public_jwk | A public key (JWK). |
test_issuer | True for a test issuer (sandbox only). |
ucp_link_client
A platform registered for account linking.
| Field | Meaning |
|---|---|
agent | The AI agent, by its short name (claude, chatgpt, gemini, copilot, perplexity, grok, other). |
auth_method | How the platform signs in to Wilby's account linking: client_secret_basic or private_key_jwt. |
client_id | The platform's client id for account linking. |
client_secret | A secret shown once. For a screen pass: hand it to your page (never your API key). |
disabled | True when it was turned off. |
jwks_uri | The https address where the platform publishes its public keys. |
links_ended | How many sign-in links were ended when it was turned off. |
name | A name. |
note | A note in plain words. |
object | What kind of object this is (order, incremental_charge, mandate…). |
redirect_uris | The platform's return addresses for account linking (https). |
webhook_delivery
One webhook delivery.
| Field | Meaning |
|---|---|
id | Wilby's id for it (a prefix plus 20 characters, like prm_… for an order). |
object | What kind of object this is (order, incremental_charge, mandate…). |
queued | True when it is queued to send. |
status | Where it stands. On an incremental charge: pending, approved, declined, expired, cancelled. |
webhook_endpoint
A webhook endpoint.
| Field | Meaning |
|---|---|
created_at | When it was created (ISO 8601, UTC). |
deleted | True when it was deleted. |
description | Plain text describing it. On an order: what was ordered. |
enabled | Whether it is turned on. |
events | Webhook event types to send (order.*, incremental_charge.approved…), or * for all. |
id | Wilby's id for it (a prefix plus 20 characters, like prm_… for an order). |
last_failure_at | When the last delivery failed. |
last_success_at | When the last delivery succeeded. |
mode | sandbox (test) or live. In agent access: all or only. |
object | What kind of object this is (order, incremental_charge, mandate…). |
previous_secret_valid_until | During a secret rotation: when the old secret stops working. |
secret | A secret shown once. Keep it on your server. |
secret_note | About the secret. |
url | An address. |
website_key
A key for AI agent checks on your website.
| Field | Meaning |
|---|---|
created_at | When it was created (ISO 8601, UTC). |
id | Wilby's id for it (a prefix plus 20 characters, like prm_… for an order). |
key | A key shown once (save it now), or a public key id. |
key_prefix | The start of a key, to tell keys apart. |
last_used_at | When it was last used. |
mode | sandbox (test) or live. In agent access: all or only. |
name | A name. |
note | A note in plain words. |
object | What kind of object this is (order, incremental_charge, mandate…). |
revoked_at | When it was revoked. |
wilby_signed_quote
The document inside a signed quote.
| Field | Meaning |
|---|---|
amount_cents | An amount in cents (US dollars). On an order: the price, or the estimate when the price can change. On a payment or refund: that payment's amount. |
business | The business: its name and checks, or who issued the quote. |
currency | The currency (USD). |
delivery | The delivery time or details. |
expires_at | When it expires (ISO 8601, UTC). |
issued_at | When it was issued. |
lines | A quote's labeled lines (name, amount_cents, kind: item, fee, discount, tip, credit, tax, minimum, delivery; estimated). |
object | What kind of object this is (order, incremental_charge, mandate…). |
pickup | Older name for a quote's one time (shown as "Pickup"). Use times for your own time names. |
quote_id | The quote's id. |
store_ref | Your id for the store. |
summary | A short, screen-ready summary. |
times | The order's times with your own names: [{"name": "Pickup", "when": "Thu, Nov 19, 8–10 AM"}]. Shown while the order is active, hidden once it ends. |
up_to_without_asking_cents | The most that can be charged without asking the customer again. |
v | The format version. |