Loyal Spark

Check voucher status byfor this merchant. Send one of code, voucher_code, or ID.voucher_id Requires(anyOf). aIf merchantnone agentis key;sent onlythe voucherstool issuedreturns byerror_code themissing_identifier, keyan owner'sexample, storeand arenext_action. returned.Anonymous public lookup is GET /agent-api/vouchers/status.

{"anyOf":[{"required":["code"]},{"required":["voucher_id"]},{"required":["voucher_code"]}],"properties":{"code":{"description":"Voucher code (e.g. LOYAL-XXXX-XXXX-XXXX-XXXX). One of code, voucher_code, or voucher_id is required.","type":"string"},"voucher_code":{"description":"Alias of code. One of code, voucher_code, or voucher_id is required.","type":"string"},"voucher_id":{"description":"Voucher UUIDUUID. (alternativeOne toof code), voucher_code, or voucher_id is required.","type":"string"}},"type":"object"}

Confirm thata theprepared protocolmint feeon transactionBase. forVerifies athe previousprotocol-fee mint/earnmint wasand, broadcastwhen onrecipient_tx_hash Base.is Verifiesset (or the fee receipt already contains the recipient mint), on-chainwrites andcustomer_tier_status clearsso get_token_balance leaves 0. Same hash for both fields when EIP-5792 batched the obligation.calls. UnconfirmedA feesecond obligationscall blockwith futurerecipient_tx_hash mints.still credits the customer after the fee is already settled.

 ⟨21 unchanged words⟩ :"string"},"recipient_tx_hash":{"description":"Optional transactionTransaction hash of the recipient mint to the recipient. Same as fee_tx_hash when both mints are in one transaction. Required to update GET /balance.","type":"string"}},"required": ⟨4 unchanged words⟩ 

 ⟨131 unchanged words⟩  follow-up)","type":"string"}},"required":["name","symbol"],"type":"object"}

Internal. Delete a report that is no longer relevant. Use to clean up outdated or irrelevantyou reports.submitted.

 ⟨35 unchanged words⟩ supported, then call confirm_mint_fee (or POST /agent-api/mint/confirm). with obligation_id, fee_tx_hash, and recipient_tx_hash. Unconfirmed fee obligations block future mints.

Get analytics for one of your loyalty programs

{"properties":{"token_address":{"description":"Token contract address (0x...)","type":"string"}},"required":["token_address"],"type":"object"}

 ⟨10 unchanged words⟩ :"Filter: active/completed/cancelled","type":"string"},"token_address":{"description":"Optional. When set, only offers that give or ask for this token.","type":"string"}},"type":"object"}

List your previously submitted reports.Internal. AllowsList reviewingreports pastthis reports,agent checkingsubmitted (status (new/reviewed/done)new, and identifying what stillreviewed, needsor attention.done).

 ⟨15 unchanged words⟩  to mark it as minted (status pending_mint →-> redeemed) and store the mint tx hash.

 ⟨46 unchanged words⟩ then call confirm_mint_fee (or POST /agent-api/mint/confirm) with theobligation_id, feefee_tx_hash, txand hash.recipient_tx_hash. Unconfirmed fee obligations block future mints. Prefer recipient_address ⟨11 unchanged words⟩ 

{"anyOf":[{"required":["recipient_address"]},{"required":["recipient"]}],"properties":{"amount":{"description":"Tokens  ⟨39 unchanged words⟩ 

Revoke an active gift certificate (status active →-> revoked). Only the issuing merchant can revoke. ⟨5 unchanged words⟩ 

Internal. Send a report to the developer/owner. Usemerchant's thisAgent toReports submitdashboard (SEO audits, growth ideas, data reports, anomalies, recommendations, or weekly summaries. The report will appear in thesummaries). merchant'sNot Agenta Reportsloyalty dashboard.action.

{"anyOf":[{"required":["cashback_rate"]},{"required":["points_per_dollar"]}],"properties":{"cashback_rate":{"description":"New  ⟨41 unchanged words⟩ 

Update report status to 'reviewed' or 'done'. Use 'done' when the action itemsInternal. haveSet beena completed.report Useyou 'reviewed'submitted to acknowledgereviewed aor report.done.

Mark a voucher as used (redeemedat bythe customermerchant. atSend merchantone of voucher_code or voucher_id (anyOf). Merchant-onlyIf operation.neither is sent the tool returns error_code missing_identifier and an example.

{"anyOf":[{"required":["voucher_code"]},{"required":["voucher_id"]}],"properties":{"voucher_code":{"description":"Voucher code (e.g. LOYAL-XXXX-XXXX-XXXX-XXXX). Use this OR voucher_id.","type":"string"},"voucher_id":{"description":"Voucher UUIDUUID. (alternativeUse tothis code)OR voucher_code.","type":"string"}},"type":"object"}

Create a gift / welcome certificate (UDS-style) with a unique 6-characterrandom redemption code (LOYAL-XXXXXXLOYAL-XXXX-XXXX-XXXX). Customer redeems via QR or by entering ⟨15 unchanged words⟩