`requestPurchaseApproval`

Request Purchase Approval

Show the user one exact order and ask them to approve it.

write

Arguments

agentLabelstringoptionalHow you are named to the user on the card, in their words (e.g. "Ora", "shopping assistant"). Defaults to Ora.
currencystringrequiredISO currency code the total is priced in (e.g. USD).
deliveryEstimatestringrequiredWhen the merchant says it arrives, in the merchant's own words (e.g. "arrives Tue, Sep 9").
itemstringrequiredWhat is being bought, named as the user would.
maskedDestinationstringrequiredWhere it ships, ALREADY MASKED (e.g. "home address ending 4821"). Never a full street address.
merchantstringrequiredWho is selling it.
merchantOriginstringrequiredThe verified HTTPS origin of the merchant page, with no path.
paymentMethodstringrequiredThe card or account as the user would recognize it (e.g. "Visa ending 4242"). Never a number or a token.
purchaseIdstringrequiredYour own id for this purchase, the same one you reserved the spend against. One purchase, one approval.
quantityintegerrequiredHow many.
recurringCommitmentstringoptionalSay plainly what repeats and how often if saying yes signs the user up for a repeating charge (e.g. "$29.99 every month until cancelled"). Leave out for a one-time purchase.
returnTermsstringrequiredWhat happens if the user sends it back, in plain words (e.g. "free returns within 30 days").
totalnumberrequiredThe FULL total the user would pay, counting tax, shipping and fees, in whole currency units.
variantstringoptionalThe specific version being bought (e.g. "Medium, navy"). Leave out only when the item has no variants.

Returns

Give every field honestly and completely, because the approval is bound to this exact version of the order: change the seller, the item, the quantity, the price, the delivery estimate, the address,…

Declared limits

currency: minimum length 3
currency: maximum length 3
quantity: greater than 0
quantity: maximum 9007199254740991
total: greater than 0

Ask for it

The Cloud routes these requests to this verb.

order it
buy that one
get me the blue one in medium
yes find me that and order it

Pair it with

The verbs that finish the job.