Wilby DocsGet Sandbox Keys

Objects

Every object the API answers with, and what each field means. Amounts are whole cents; times are ISO 8601 in UTC.

ach_authorizationagent_access_reportagent_checkagent_readinessagent_visit_reportanalytics_summaryapprovalapproval_attemptsapproval_codeapproval_linkauthorization_suggestionbank_accountconfirmation_requestcredential_bundlecustom_domaincustomercustomer_contactcustomer_overagecustomer_overage_changedashboard_linkdashboard_open_linkdisputeevidenceevidence_packagefulfillment_eventgoogle_ordersholdincremental_chargeincremental_charge_previewintegration_checkmandatemerchantnew_phone_codeorderpartner_settingspasskey_promptpasskey_resultpayment_reportpayments_pathreportscreen_sessionsigned_quotestore_agent_rulesstorefront_listingstorefront_secretstorefront_sign_instorefront_teststripe_keytest_acp_signaturetest_mandatestest_vi_credentialtrusted_issuerucp_link_clientwebhook_deliverywebhook_endpointwebsite_keywilby_signed_quote

ach_authorization

A customer's ACH debit authorization: the bank account and limits they signed for.

FieldMeaning
account_last4Last 4 digits of the bank account.
activeWhether it is in force right now.
bank_nameThe bank's name.
confirmed_withHow the customer signed this permission (Face ID, fingerprint, texted code).
created_atWhen it was created (ISO 8601, UTC).
customer_external_refYour own id for the customer.
expires_atWhen it expires (ISO 8601, UTC).
for_agent_onlyTrue when this bank authorization is only for one AI agent's orders.
idWilby's id for it (a prefix plus 20 characters, like prm_… for an order).
merchant_idsWilby's ids for the stores.
monthly_centsThe most per month.
noticeSomething to tell the customer.
objectWhat kind of object this is (order, incremental_charge, mandate…).
per_order_centsThe most per order.
railHow the money moves: card or ach.
range_centsThe allowed amount range.
revoked_atWhen it was revoked.

agent_access_report

AI agent orders allowed and refused by your agent access settings.

FieldMeaning
agentsPer-agent figures (orders, amounts, refusals) or the list of agents seen.
gateYour agent access setting at the time.
objectWhat kind of object this is (order, incremental_charge, mandate…).
period_daysHow many days the figures cover.

agent_check

A check of who an AI agent is and whether the customer approved what it did.

FieldMeaning
agentThe AI agent, by its short name (claude, chatgpt, gemini, copilot, perplexity, grok, other).
agent_nameThe agent's display name, as the customer named it or as the platform reports it.
allowedWhether it is allowed (true or false), or the list of what is allowed.
browser_signalsSigns 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_hintsWhat 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.
clueWhat gave the agent away (for example a signed request or a known platform address).
created_atWhen it was created (ISO 8601, UTC).
customer_approvalWhether and how the customer approved this themselves.
expires_atWhen it expires (ISO 8601, UTC).
hostThe website address where it happened.
idWilby's id for it (a prefix plus 20 characters, like prm_… for an order).
levelHow sure Wilby is about an AI agent: verified (signed), named_itself, likely_agent or no_sign_of_agent.
objectWhat kind of object this is (order, incremental_charge, mandate…).
order_idThe order's id (prm_…).
signed_forFor a request signed with a card network tag: browsing (agent-browser-auth) or paying (agent-payer-auth).
used_atWhen it was used.
verifiedTrue when it was verified.

agent_readiness

The Agent Readiness Check: how ready each store is for AI agents, with what to fix.

FieldMeaning
businessThe business: its name and checks, or who issued the quote.
checked_atWhen the check ran.
gradeA word for the score: ready, almost_ready or not_ready.
more_storesHow many stores weren't checked in this run.
objectWhat kind of object this is (order, incremental_charge, mandate…).
scoreA score out of 100.
storesStores, or per-store results.
stores_checkedHow many stores were checked.

agent_visit_report

AI agent visits to your website.

FieldMeaning
agentsPer-agent figures (orders, amounts, refusals) or the list of agents seen.
daysA number of days, or the days of the week (0 = Sunday) for hours.
keptHow long it is kept.
objectWhat kind of object this is (order, incremental_charge, mandate…).

analytics_summary

Your figures for a date range.

FieldMeaning
agentsPer-agent figures (orders, amounts, refusals) or the list of agents seen.
bankBank account details for an ACH debit authorization.
customersCustomer figures.
disputesDispute figures.
estimatesEstimate accuracy figures.
fromStart date (YYYY-MM-DD) or start of the range.
incremental_chargesIncremental charge figures.
merchant_idWilby's id for the store (mer_…).
modesandbox (test) or live. In agent access: all or only.
moneyMoney figures.
objectWhat kind of object this is (order, incremental_charge, mandate…).
ordersOrder figures, or a list of orders.
shadowShadow mode results (Wilby checks without blocking).
toEnd date (YYYY-MM-DD) or end of the range.
tzAn IANA time zone, like America/New_York.
webhooksWebhook figures.

approval

Wilby's signed yes (or no) for one payment.

FieldMeaning
allowedWhether it is allowed (true or false), or the list of what is allowed.
amount_centsAn 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_idThe id of the approval Wilby gave (the signed yes for a payment).
card_indicatorsCard network values for this payment (for example the merchant-initiated and estimated-authorization indicators) to send with your processor call.
kindWhat kind it is. On an approval: authorize, capture, charge or refund. On a payment report: what happened.
objectWhat kind of object this is (order, incremental_charge, mandate…).
order_idThe order's id (prm_…).
proofThe signed proof of the decision.
reasonWhy, as a code or in words. On an incremental charge: the store's reason the customer sees.
valid_untilWhen it stops being valid.

approval_attempts

Approval results by device and what went wrong (13 months).

FieldMeaning
approvedWhether it was approved.
daysA number of days, or the days of the week (0 = Sunday) for hours.
devicesApproval results by device.
objectWhat kind of object this is (order, incremental_charge, mandate…).
problemsWhat went wrong, counted.

approval_code

A one-time approval code that was sent.

FieldMeaning
code_idThe id of a sent code. Send it back with the code the customer types.
expires_atWhen it expires (ISO 8601, UTC).
incremental_charge_idThe incremental charge's id (top_…).
objectWhat kind of object this is (order, incremental_charge, mandate…).
sent_byHow it was sent (text or email).
sent_toWhere it was sent (masked).

A link where the customer approves.

FieldMeaning
answer_byWhen the customer has to answer by; after that the request expires.
approval_urlThe page where the customer approves or declines. Open it in an in-app browser or send it by text.
incremental_charge_idThe incremental charge's id (top_…).
objectWhat kind of object this is (order, incremental_charge, mandate…).

authorization_suggestion

Wilby's suggested amount and maximum for an order.

FieldMeaning
basisWhat the suggestion is based on.
card_fundingThe card type: credit, debit or prepaid.
entered_amount_centsThe amount you entered, for comparison with the suggestion.
explanationPlain-words explanation.
historyPast values the suggestion used.
max_multipleThe suggested maximum as a multiple of the amount.
merchant_idWilby's id for the store (mer_…).
objectWhat kind of object this is (order, incremental_charge, mandate…).
preapproved_overage_pctHow far above the amount the customer lets you charge without asking (percent).
suggested_amount_centsWilby's suggested amount.
suggested_max_amount_centsWilby's suggested maximum.

bank_account

A customer's bank account and its check status.

FieldMeaning
account_last4Last 4 digits of the bank account.
bank_nameThe bank's name.
nextWhat to do next.
objectWhat kind of object this is (order, incremental_charge, mandate…).
payment_method_refYour processor's id for the customer's saved card or bank account.
reasonWhy, as a code or in words. On an incremental charge: the store's reason the customer sees.
statusWhere it stands. On an incremental charge: pending, approved, declined, expired, cancelled.
verification_idThe bank account check's id.

confirmation_request

Statements only the customer can confirm, with the link to confirm them.

FieldMeaning
expires_atWhen it expires (ISO 8601, UTC).
objectWhat kind of object this is (order, incremental_charge, mandate…).
statementsStatements only the customer can confirm (for example "I am 21 or older").
urlAn address.

credential_bundle

Signed credentials (permissions) and how to check them.

FieldMeaning
formatThe format of the file or credential.
how_to_verifyHow anyone can check the signature themselves.
issuerWho issued or signed it.
jwksPublic keys (JSON Web Key Set).
mandatesSigned permissions.
objectWhat kind of object this is (order, incremental_charge, mandate…).
profileWhich profile of the standard.
verifiable_intentVerifiable Intent credentials.

custom_domain

Your own address for your agent connector (for example agents.yourbusiness.com), its DNS records and status.

FieldMeaning
activated_atWhen your own address started serving your connector.
certificateThe 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_atWhen the check ran.
connector_urlYour connector's address on your own domain (https://<host>/mcp).
created_atWhen it was created (ISO 8601, UTC).
dns_recordsThe DNS records to add for your own address: type, name, value, purpose.
hostThe website address where it happened.
idWilby's id for it (a prefix plus 20 characters, like prm_… for an order).
last_errorWhat the last check couldn't find, in plain words.
noteA note in plain words.
objectWhat kind of object this is (order, incremental_charge, mandate…).
statusWhere it stands. On an incremental charge: pending, approved, declined, expired, cancelled.
verified_atWhen Wilby first found your DNS records.

customer

A customer.

FieldMeaning
external_refYour own id for it.
objectWhat kind of object this is (order, incremental_charge, mandate…).
payment_method_savedTrue when a payment method is saved for the customer.

customer_contact

How to reach a customer for a code.

FieldMeaning
emailAn email address (shown masked when read back).
external_refYour own id for it.
kept_daysHow many days it is kept.
labelA short name shown to people.
objectWhat kind of object this is (order, incremental_charge, mandate…).

customer_overage

A customer's rule for extra charges.

FieldMeaning
approval_required_above_centsAbove this amount, the customer approves each incremental charge themselves.
choices_pctThe percent choices offered to the customer for extra charges.
confirmed_viaHow the customer confirmed (passkey, texted code, signed-in session).
customer_external_refYour own id for the customer.
has_ruleWhether the customer has chosen a rule.
objectWhat kind of object this is (order, incremental_charge, mandate…).
preapproved_overage_pctHow far above the amount the customer lets you charge without asking (percent).
recommended_pctThe choice shown as recommended.
updated_atWhen it last changed.

customer_overage_change

A request to change a customer's extra-charge rule.

FieldMeaning
approval_required_above_centsAbove this amount, the customer approves each incremental charge themselves.
confirmed_viaHow the customer confirmed (passkey, texted code, signed-in session).
expires_atWhen it expires (ISO 8601, UTC).
messagePlain words for people. On an error: what went wrong.
objectWhat kind of object this is (order, incremental_charge, mandate…).
preapproved_overage_pctHow far above the amount the customer lets you charge without asking (percent).
reasonWhy, as a code or in words. On an incremental charge: the store's reason the customer sees.
statusWhere it stands. On an incremental charge: pending, approved, declined, expired, cancelled.
urlAn address.

A link into the Dashboard.

FieldMeaning
expires_atWhen it expires (ISO 8601, UTC).
idWilby's id for it (a prefix plus 20 characters, like prm_… for an order).
merchant_idWilby's id for the store (mer_…).
objectWhat kind of object this is (order, incremental_charge, mandate…).
revokedTrue when it was revoked.
urlAn address.

A one-time link that opens the Dashboard.

FieldMeaning
can_editWhether this dashboard link can change settings (or only view).
expires_atWhen it expires (ISO 8601, UTC).
idWilby's id for it (a prefix plus 20 characters, like prm_… for an order).
merchant_idWilby's id for the store (mer_…).
objectWhat kind of object this is (order, incremental_charge, mandate…).
session_hoursHow long a session lasts (hours).
single_useTrue when the link works once.
urlAn address.

dispute

A dispute about an order.

FieldMeaning
checksThe individual checks, each with a status and what to fix.
created_atWhen it was created (ISO 8601, UTC).
evidence_submitted_atWhen dispute evidence was sent to the processor.
idWilby's id for it (a prefix plus 20 characters, like prm_… for an order).
noteA note in plain words.
objectWhat kind of object this is (order, incremental_charge, mandate…).
opened_byWho opened the dispute: the customer, the store or the processor.
orderThe order.
order_idThe order's id (prm_…).
outcomeHow it ended.
partner_mustWhat you need to do next.
processor_dispute_idThe dispute's id at the processor.
processor_statusThe status at the processor.
reasonWhy, as a code or in words. On an incremental charge: the store's reason the customer sees.
refund_centsAn amount to refund, in cents. On a dispute: how much was refunded.
resolved_atWhen it was settled.
resolved_byWho settled it.
sourceWhere it came from.
whyWhy, in words.

evidence

One piece of evidence.

FieldMeaning
idWilby's id for it (a prefix plus 20 characters, like prm_… for an order).
labelA short name shown to people.
objectWhat kind of object this is (order, incremental_charge, mandate…).
sha256SHA-256 fingerprint.
typeWhat kind it is.

evidence_package

The dispute evidence package for an order.

FieldMeaning
agent_didThe agent's decentralized identifier, when the agent signed with one.
allowedWhether it is allowed (true or false), or the list of what is allowed.
findingThe result, as a code.
finding_textThe result in words.
generated_atWhen it was put together.
how_to_useHow to use this.
modesandbox (test) or live. In agent access: all or only.
objectWhat kind of object this is (order, incremental_charge, mandate…).
reportedWhat was reported.
resolutionHow it was settled.
summaryA short, screen-ready summary.
verificationHow to verify it.

fulfillment_event

A shipment or delivery step.

FieldMeaning
carrierThe shipping company.
descriptionPlain text describing it. On an order: what was ordered.
idWilby's id for it (a prefix plus 20 characters, like prm_… for an order).
line_itemsThe items, each with a name, quantity and amount.
objectWhat kind of object this is (order, incremental_charge, mandate…).
occurred_atWhen it happened.
order_idThe order's id (prm_…).
tracking_numberThe shipment's tracking number.
tracking_urlThe tracking page (https).
typeWhat kind it is.

google_orders

Your Google order updates setting.

FieldMeaning
google_partner_idYour Google partner id.
key_last4The last 4 characters of a saved key.
noteA note in plain words.
objectWhat kind of object this is (order, incremental_charge, mandate…).
savedTrue when it is saved.
saved_atWhen it was saved.

hold

The answer to the one-call hold (POST /v1/orders/{id}/hold).

FieldMeaning
approval_idThe id of the approval Wilby gave (the signed yes for a payment).
objectWhat kind of object this is (order, incremental_charge, mandate…).
paymentA payment: its amount, status and processor reference.

incremental_charge

A request to charge more than the order's amount, and the customer's answer.

FieldMeaning
decided_viaHow 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).
idWilby's id for it (a prefix plus 20 characters, like prm_… for an order).
objectWhat kind of object this is (order, incremental_charge, mandate…).
orderThe order.
statusWhere it stands. On an incremental charge: pending, approved, declined, expired, cancelled.

incremental_charge_preview

What would happen if you asked for this incremental charge.

FieldMeaning
amount_centsAn 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_centsAbove this amount, the customer approves each incremental charge themselves.
decisionWhat would happen: approved by the customer's rule, or the customer must approve.
max_amount_centsThe most that may be charged for the order without asking the customer again.
new_total_centsThe order total after this incremental charge.
objectWhat kind of object this is (order, incremental_charge, mandate…).
order_idThe order's id (prm_…).
pending_incremental_charge_idThe incremental charge already waiting for the customer, if any.
room_centsHow much is left before the customer has to approve.
ruleThe customer's rule that applied.
stageWhere the order is: created, confirmed, authorized, captured, cancelled, expired, disputed.

integration_check

What's done and what's left before going live.

FieldMeaning
checked_atWhen the check ran.
doneTrue when it's finished (for an approval: the customer said yes).
groupsItems grouped by area.
modesandbox (test) or live. In agent access: all or only.
objectWhat kind of object this is (order, incremental_charge, mandate…).
pathWhich way to integrate, or a path.
ready_for_liveTrue when everything needed for live is done.
totalThe total.
variable_amountWhether your final price can change after checkout (default false).

mandate

A customer's permission for an AI agent: limits, stores and dates.

FieldMeaning
ach_authorization_idThe ACH debit authorization this order is paid under (bank payments).
activeWhether it is in force right now.
agent_nameThe agent's display name, as the customer named it or as the platform reports it.
ask_every_timeTrue when the customer approves every order themselves (no amount is preapproved).
budget_periodWhether the customer's budget is per month or for the whole permission.
confirmed_withHow the customer signed this permission (Face ID, fingerprint, texted code).
created_atWhen it was created (ISO 8601, UTC).
customer_external_refYour own id for the customer.
expires_atWhen it expires (ISO 8601, UTC).
idWilby's id for it (a prefix plus 20 characters, like prm_… for an order).
max_ordersThe most orders allowed under the permission.
monthly_centsThe most per month.
not_beforeNot valid before this time.
objectWhat kind of object this is (order, incremental_charge, mandate…).
pause_reasonWhy it is paused.
pausedTrue when it is paused.
paused_atWhen it was paused.
pays_byHow orders under this permission are paid (card or bank).
per_order_centsThe most per order.
revoked_atWhen it was revoked.
sourceWhere it came from.
store_idsThe stores allowed.
tips_count_toward_limitsWhether tips count toward the AI agent's limits (the customer chooses; default true).

merchant

A store.

FieldMeaning
createdTrue when this call created it, false when it already existed.
external_refYour own id for it.
idWilby's id for it (a prefix plus 20 characters, like prm_… for an order).
nameA name.
objectWhat kind of object this is (order, incremental_charge, mandate…).
processorThe payment processor (stripe, square, braintree, adyen, paypal).

new_phone_code

A code sent to set up a passkey on a new device.

FieldMeaning
code_idThe id of a sent code. Send it back with the code the customer types.
expires_atWhen it expires (ISO 8601, UTC).
incremental_charge_idThe incremental charge's id (top_…).
objectWhat kind of object this is (order, incremental_charge, mandate…).
sent_byHow it was sent (text or email).
sent_toWhere it was sent (masked).

order

An order.

FieldMeaning
ach_authorization_idThe ACH debit authorization this order is paid under (bank payments).
agent_checkThe agent check for this order (who the agent was and how sure Wilby is), when one was made.
agent_identityWhat Wilby could verify about the agent that placed the order (signed request, known platform).
agent_mandatesSigned permissions an outside agent platform sent with the order (AP2 or Verifiable Intent): checkout, payment and the customer's open permissions.
amount_centsAn 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_atWhen the money was authorized (held) or charged.
cancelled_atWhen it was cancelled.
capture_centsThe final amount captured for the order.
captured_atWhen the final amount was captured.
captured_centsHow much has been captured so far.
confirmed_atWhen the store confirmed the order.
created_atWhen it was created (ISO 8601, UTC).
currencyThe currency (USD).
customer_approvalWhether and how the customer approved this themselves.
customer_idWilby's id for the customer.
display_refYour order number as customers know it (shown on Wilby's pages).
expires_atWhen it expires (ISO 8601, UTC).
external_refYour own id for it.
funding_methodHow the order was paid: hold (authorized, captured later), charge (paid at once) or bank_debit.
held_centsHow much is held (authorized, not yet captured).
idWilby's id for it (a prefix plus 20 characters, like prm_… for an order).
mandate_idThe customer's permission (mandate) this order was placed under.
max_amount_centsThe most that may be charged for the order without asking the customer again.
merchant_idWilby's id for the store (mer_…).
modesandbox (test) or live. In agent access: all or only.
objectWhat kind of object this is (order, incremental_charge, mandate…).
order_typeYour kind of order (your own word).
owed_centsHow much the customer still owes on the order.
paid_centsHow much has been paid.
pending_centsHow much is still in progress (a bank debit not yet cleared).
pricing_termsYour pricing terms for the order (your own keys), shown to the customer.
processorThe payment processor (stripe, square, braintree, adyen, paypal).
purposeWhat the order is for, in plain words.
railHow the money moves: card or ach.
refund_due_centsA refund owed to the customer that is waiting (for example for a bank debit to clear first).
refunded_centsHow much has been refunded so far.
reviewerTrue 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_centsHow much was paid for the order itself, without tips.
spec_versionThe version of the order format.
stageWhere the order is: created, confirmed, authorized, captured, cancelled, expired, disputed.
tip_centsThe tip, in cents.

partner_settings

Your settings.

FieldMeaning
agent_accessWhich AI agents may order from you: mode all or only, allowed, blocked, verified_only.
agent_rulesYour own rules for AI agent orders, stricter than the customer's: max_order_cents, always_approval_required_above_cents, hours.
appsYour iOS and Android apps, so customers can approve inside your app.
brandingYour look on customer pages: display_name, accent_color, secondary_color, logo_data_uri, show_secured_by.
embed_originsYour websites that may show the Dashboard inside your own dashboard (up to 5 https origins).
first_setup_codeBefore a customer's first passkey, a one-time code proves it's them (default true).
google_ordersGoogle order updates: whether your key is saved.
listingWhat AI app directories ask for: one_liner, long_description, privacy_url, support, docs_url, example_prompts, reviewer_customer_ref, reviewer_steps.
objectWhat kind of object this is (order, incremental_charge, mandate…).
passkey_websitesWhich of your websites can show the Face ID prompt themselves (in_page) and which use Wilby's window (wilby_window).
recommended_pctThe choice shown as recommended.
return_urlWhere Wilby's pages send the customer when they are done (https, or your app's own link).
rule_choices_pctThe percent choices offered to customers for extra charges (1 to 4).
screen_originsYour websites where Wilby's ready-made screens run (up to 10 https origins).
storefrontYour Agent Storefront: enabled, slug, name, description, login_url, api_url, answers, extras, times_path.
stripe_keyYour Stripe restricted key (saved, never shown again).
ucpGoogle's agent checkout (UCP): enabled, require_signatures, share_saved_addresses, prefer_mcp, public_base_url, version, terms_url, website_url, google_pay.
variable_amountWhether your final price can change after checkout (default false).
website_agentsAI agents on your own website: likely (record_only or ask_customer).
wordingYour 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.

FieldMeaning
amount_centsAn 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_idThe id of a Face ID / Touch ID / fingerprint prompt. Send it back when finishing.
code_approval_availableTrue when the customer can approve with a texted code here.
deviceThe customer's device: kind (iphone, android, mac, windows…), lock (Face ID, Touch ID, fingerprint, Windows Hello) and name.
incremental_charge_idThe incremental charge's id (top_…).
kindWhat kind it is. On an approval: authorize, capture, charge or refund. On a payment report: what happened.
likely_on_another_deviceTrue when the customer's passkey is probably on another device (offer to set up this one, or a code).
new_phone_availableTrue when the customer can set up a passkey on this device with a texted code.
objectWhat kind of object this is (order, incremental_charge, mandate…).
optionsThe prompt options to pass to the browser's WebAuthn call, or a service's options.
rp_idThe passkey's website (relying party id).

passkey_result

The result of a Face ID / Touch ID / fingerprint prompt.

FieldMeaning
decided_viaHow 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).
doneTrue when it's finished (for an approval: the customer said yes).
incremental_charge_idThe incremental charge's id (top_…).
nextWhat to do next.
objectWhat kind of object this is (order, incremental_charge, mandate…).
orderThe order.
statusWhere it stands. On an incremental charge: pending, approved, declined, expired, cancelled.

payment_report

Wilby's answer to a payment you reported.

FieldMeaning
approval_problemWhy the reported payment didn't match an approval, when it didn't.
approvedWhether it was approved.
objectWhat kind of object this is (order, incremental_charge, mandate…).
orderThe order.
payment_idThe payment's id (pay_…).
shadow_verdictWhat Wilby would have decided in shadow mode.

payments_path

Which way payments run for you.

FieldMeaning
applies_toWhat this applies to.
objectWhat kind of object this is (order, incremental_charge, mandate…).
pathWhich way to integrate, or a path.

report

An acknowledgment.

FieldMeaning
objectWhat kind of object this is (order, incremental_charge, mandate…).
okTrue when it worked.

screen_session

A screen pass for Wilby's ready-made screens on your website.

FieldMeaning
client_secretA secret shown once. For a screen pass: hand it to your page (never your API key).
customer_external_refYour own id for the customer.
expires_atWhen it expires (ISO 8601, UTC).
idWilby's id for it (a prefix plus 20 characters, like prm_… for an order).
objectWhat kind of object this is (order, incremental_charge, mandate…).
order_idThe order's id (prm_…).

signed_quote

A signed price quote and whether its signature checks out.

FieldMeaning
algorithmThe signature algorithm (Ed25519 for Wilby's signatures).
documentThe signed document itself (exactly what was signed).
document_sha256SHA-256 of the signed document.
how_to_verifyHow anyone can check the signature themselves.
key_idWhich signing key signed it (look it up at /v1/keys).
modesandbox (test) or live. In agent access: all or only.
objectWhat kind of object this is (order, incremental_charge, mandate…).
signatureThe signature.
statusWhere it stands. On an incremental charge: pending, approved, declined, expired, cancelled.
summaryA short, screen-ready summary.
valid_signatureTrue when the signature checks out.
verify_urlA page anyone can open to check it.

store_agent_rules

Your AI agent rules for one store.

FieldMeaning
appliesWhich rules apply here.
merchant_idWilby's id for the store (mer_…).
objectWhat kind of object this is (order, incremental_charge, mandate…).
storeThe store.

storefront_listing

Listing materials and checklist for AI app directories.

FieldMeaning
checked_atWhen the check ran.
doneTrue when it's finished (for an approval: the customer said yes).
groupsItems grouped by area.
materialsReady-to-copy listing text.
modesandbox (test) or live. In agent access: all or only.
objectWhat kind of object this is (order, incremental_charge, mandate…).
totalThe total.

storefront_secret

Your storefront signing secret (shown once).

FieldMeaning
noteA note in plain words.
objectWhat kind of object this is (order, incremental_charge, mandate…).
secretA secret shown once. Keep it on your server.

storefront_sign_in

A customer sign-in from your login page.

FieldMeaning
continue_urlWhere to send the customer next.
expires_atWhen it expires (ISO 8601, UTC).
objectWhat kind of object this is (order, incremental_charge, mandate…).
purposeWhat the order is for, in plain words.
repeatedTrue when the same sign-in was sent again (for example a double click): a fresh continue_url for the same customer.
request_idThe 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.

FieldMeaning
checked_atWhen the check ran.
directory_rules_checkedWhen the directory rules were last checked against the AI app directories' published rules.
failuresHow many steps need fixing.
objectWhat kind of object this is (order, incremental_charge, mandate…).
passedHow many steps passed.
resultThe overall result: ready, mostly_ready or fix_needed.
stepsEach step: id, label, status (pass, warn, fail, skipped), detail (what happened), fix (what to do) and source (contract, ai_misread or directory).
store_nameThe store's name.
store_refYour id for the store.
warningsHow many steps could be improved.

stripe_key

Your saved Stripe key.

FieldMeaning
kindWhat kind it is. On an approval: authorize, capture, charge or refund. On a payment report: what happened.
last4The last 4 digits or characters.
noteA note in plain words.
objectWhat kind of object this is (order, incremental_charge, mandate…).
permissions_neededWhat your key still needs permission to do.
savedTrue when it is saved.
saved_atWhen it was saved.

test_acp_signature

Test tools: a signed test request.

FieldMeaning
issuerWho issued or signed it.
noteA note in plain words.
objectWhat kind of object this is (order, incremental_charge, mandate…).
platform_kidThe agent platform's key id.
signatureThe signature.
timestampWhen it was signed.

test_mandates

Test tools: signed test permissions.

FieldMeaning
issuerWho issued or signed it.
noteA note in plain words.
objectWhat kind of object this is (order, incremental_charge, mandate…).
open_checkout_mandateTest tools: a signed open checkout permission.
open_payment_mandateTest tools: a signed open payment permission.

test_vi_credential

Test tools: a test Verifiable Intent credential.

FieldMeaning
issuerWho issued or signed it.
l1Test tools: the issuer layer of a Verifiable Intent credential.
noteA note in plain words.
objectWhat kind of object this is (order, incremental_charge, mandate…).

trusted_issuer

An issuer whose signed permissions you trust.

FieldMeaning
enabledWhether it is turned on.
enabled_atWhen it was turned on.
formatThe format of the file or credential.
idWilby's id for it (a prefix plus 20 characters, like prm_… for an order).
kidKey id.
nameA name.
noteA note in plain words.
objectWhat kind of object this is (order, incremental_charge, mandate…).
public_jwkA public key (JWK).
test_issuerTrue for a test issuer (sandbox only).

A platform registered for account linking.

FieldMeaning
agentThe AI agent, by its short name (claude, chatgpt, gemini, copilot, perplexity, grok, other).
auth_methodHow the platform signs in to Wilby's account linking: client_secret_basic or private_key_jwt.
client_idThe platform's client id for account linking.
client_secretA secret shown once. For a screen pass: hand it to your page (never your API key).
disabledTrue when it was turned off.
jwks_uriThe https address where the platform publishes its public keys.
links_endedHow many sign-in links were ended when it was turned off.
nameA name.
noteA note in plain words.
objectWhat kind of object this is (order, incremental_charge, mandate…).
redirect_urisThe platform's return addresses for account linking (https).

webhook_delivery

One webhook delivery.

FieldMeaning
idWilby's id for it (a prefix plus 20 characters, like prm_… for an order).
objectWhat kind of object this is (order, incremental_charge, mandate…).
queuedTrue when it is queued to send.
statusWhere it stands. On an incremental charge: pending, approved, declined, expired, cancelled.

webhook_endpoint

A webhook endpoint.

FieldMeaning
created_atWhen it was created (ISO 8601, UTC).
deletedTrue when it was deleted.
descriptionPlain text describing it. On an order: what was ordered.
enabledWhether it is turned on.
eventsWebhook event types to send (order.*, incremental_charge.approved…), or * for all.
idWilby's id for it (a prefix plus 20 characters, like prm_… for an order).
last_failure_atWhen the last delivery failed.
last_success_atWhen the last delivery succeeded.
modesandbox (test) or live. In agent access: all or only.
objectWhat kind of object this is (order, incremental_charge, mandate…).
previous_secret_valid_untilDuring a secret rotation: when the old secret stops working.
secretA secret shown once. Keep it on your server.
secret_noteAbout the secret.
urlAn address.

website_key

A key for AI agent checks on your website.

FieldMeaning
created_atWhen it was created (ISO 8601, UTC).
idWilby's id for it (a prefix plus 20 characters, like prm_… for an order).
keyA key shown once (save it now), or a public key id.
key_prefixThe start of a key, to tell keys apart.
last_used_atWhen it was last used.
modesandbox (test) or live. In agent access: all or only.
nameA name.
noteA note in plain words.
objectWhat kind of object this is (order, incremental_charge, mandate…).
revoked_atWhen it was revoked.

wilby_signed_quote

The document inside a signed quote.

FieldMeaning
amount_centsAn 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.
businessThe business: its name and checks, or who issued the quote.
currencyThe currency (USD).
deliveryThe delivery time or details.
expires_atWhen it expires (ISO 8601, UTC).
issued_atWhen it was issued.
linesA quote's labeled lines (name, amount_cents, kind: item, fee, discount, tip, credit, tax, minimum, delivery; estimated).
objectWhat kind of object this is (order, incremental_charge, mandate…).
pickupOlder name for a quote's one time (shown as "Pickup"). Use times for your own time names.
quote_idThe quote's id.
store_refYour id for the store.
summaryA short, screen-ready summary.
timesThe 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_centsThe most that can be charged without asking the customer again.
vThe format version.