Follow Avox Docs on Google
Pick Avox Docs as a preferred source and Google shows these pages more often when you search for help with Avox.
Follow Avox Docs on Google
Pick Avox Docs as a preferred source and Google shows these pages more often when you search for help with Avox.
Connect Stripe and an Avox automation can make a Stripe payment page for an amount and hand its link to the next step, so it goes in the chat. From the payment's page you can check its status, refund it or cancel the link. Money goes straight to your own Stripe account; Avox never holds it.
Can: create a payment page (a Stripe Checkout page) for one item; check whether it was paid, expired or refunded; refund all or part of a paid payment; cancel an unpaid link; and hear from Stripe the moment a page changes.
Cannot:
A key starting with rk_test_ or sk_test_ connects in Test mode; rk_live_ or sk_live_ is live.
A Switchboard has one Stripe connection, so to move from test to live, use Reconnect with the live key.
Create the key in Stripe
In the Stripe Dashboard open Developers, then API keys, and click Create restricted key. Give it Checkout Sessions: Write and Refunds: Write, and copy the key.
Open Stripe in Avox
Open Apps in the sidebar, then Stripe, and click Connect. Read what Avox will be allowed to do and click Continue.
Paste the key
Paste it into Restricted key, leave Webhook signing secret empty for now and click Connect. Avox tries the key with Stripe, stores it encrypted and never shows it again, not even to you.
Check the result
A green message says Stripe is connected, with your Stripe account's name (or Live mode or Test mode). Click Open Stripe in Avox.
Stripe uses your own key, so it never shows Coming soon.
Open Apps, then Stripe. The menu (tabs on a phone) has Overview, Payments and Activity.
Copy Avox's address
On Stripe's Overview, under Instant updates, copy Avox's address for Stripe. Keep it private.
Add the endpoint in Stripe
In Stripe open Developers, then Webhooks, and add an endpoint with that address. Tick
checkout.session.completed, checkout.session.expired and charge.refunded.
Paste the signing secret
Copy the endpoint's Signing secret (it starts with whsec_). In Avox, next to Webhook signing
secret, click Add, paste it and click Save.
Avox accepts an update only with a valid signature from the last 5 minutes. Without the secret it shows a reminder (AVX-3709) and refuses every update. Each good update appears once under Webhooks, even if Stripe sends it twice.
Create a payment link. In the automation builder add Use a connected app, set What to do to
Create a payment link and With to Stripe. Fill in Amount (normal units, like 49.50),
Currency (like USD), What it's for (up to 200 characters, the customer sees it), and optionally
Your reference (up to 40 letters, numbers, - and _), Customer email and Link works for
(minutes). A Stripe page stays open from 30 minutes to 24 hours; a longer time is cut to 24 hours, and
no time means 24 hours.
The step gives later steps {{payment.url}}, {{payment.id}} and {{payment.status}}. Under If it
can't be done, choose Stop the run or Carry on with the next step. App steps cost no credits.
Answers from a submitted Flow reach the step as {{flow.<field>}} when the automation starts with Flow
submitted (see Automations with Tables and Flows).
Example only, made up for illustration: an automation starts when a customer submits a Flow about a
booking. Step 1 creates a payment link with Stripe, using the price and currency you chose and
{{flow.email}} as the customer email. Step 2 is a Text reply saying "Here is your payment link"
followed by {{payment.url}}.
Check, refund and cancel. Open Payments, then a payment. Buttons: Copy payment link, Open payment link, Open in Stripe, Check status now, Refund and Cancel link (the last three need Manage connected apps). Statuses are Pending, Paid, Partly refunded, Refunded, Expired and Cancelled.
Nothing is taken twice. Give each link its own reference: Stripe then never makes two pages for the same reference, even if the step runs again. Without a reference, Avox does not repeat a failed create by itself, but running the automation twice makes two pages. Avox never repeats a refund or cancel on its own, and reads the payment from Stripe first, so only what is really left can be refunded.
Stripe can be slow, busy or refuse a request. The rest of your account keeps working.
Before you try a refund or cancel again, click Open in Stripe and look at the payment's refunds. If the refund is already listed, do not repeat it; then click Check status now in Avox. A refund that timed out may still have gone through at Stripe.
On the Overview click Disconnect. Avox first shows what uses Stripe: those steps stop until you connect again (AVX-3708). Avox deletes the key it saved and keeps the log for your retention period. In Stripe, also delete the restricted key and Avox's webhook endpoint. Payments already made are not affected.
AVX-3686: copy the key again, whole and without spaces, and check it has Checkout Sessions: Write and Refunds: Write. If the log entry names a missing permission, add it to the key in Stripe.
Check the endpoint in Stripe uses the exact address on the Overview, has the three events ticked, and that the signing secret in Avox matches. Click Check status now to ask Stripe directly.
Yes. A test key connects in Test mode. When you are ready, click Reconnect and paste the live key.
Last updated