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 PayPal and an Avox automation can make a PayPal payment request 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 request. Money goes straight to your own PayPal account; Avox never holds it.
Can: create a PayPal payment request (a PayPal invoice) for one item; check whether it was paid, cancelled or refunded; refund all or part of a paid request; cancel an unpaid one; and hear from PayPal the moment a request is paid or cancelled.
Cannot:
Get the credentials
In the PayPal Developer Dashboard open Apps & Credentials, choose Live (or Sandbox), open or create your app and copy its Client ID and Secret.
Open PayPal in Avox
Open Apps in the sidebar, then PayPal, and click Connect. Read what Avox will be allowed to do and click Continue.
Paste the details
Paste the Client ID and Secret and pick the matching Environment: Live or Sandbox (testing). Leave Webhook ID empty for now and click Connect. Avox signs in to PayPal with them, stores them encrypted and never shows the secret again, not even to you.
Check the result
A green message says PayPal is connected.
PayPal uses your own credentials, so it never shows Coming soon. To move from sandbox to live, use Reconnect with the live details.
Open Apps, then PayPal. The menu has Overview, Payments and Activity.
Copy Avox's address
On PayPal's Overview, under Instant updates, copy Avox's address for PayPal. Keep it private.
Add the webhook in PayPal
In your PayPal app add a webhook with that address, in the same environment. Tick
INVOICING.INVOICE.PAID, INVOICING.INVOICE.CANCELLED and PAYMENT.CAPTURE.REFUNDED. PayPal then shows a
Webhook ID.
Paste the Webhook ID
In Avox, next to Webhook ID, click Add, paste it and click Save.
Avox checks every update with PayPal using that ID. Without it Avox shows a reminder (AVX-3709) and refuses every update. Paid and cancelled updates change the status at once; a refund update is noted on the payment, and Check status now shows its new status.
Create a payment request. In the automation builder add Use a connected app, set What to do to
Create a payment link and With to PayPal. Fill in Amount (normal units, like 49.50),
Currency (like USD), What it's for (up to 200 characters, used as the invoice note and item
name), and optionally Your reference (up to 40 letters, numbers, - and _), Customer name and
Customer email. With an email, PayPal also emails the request; without one, Avox only gives you the
link.
The step gives {{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 PayPal, 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 request"
followed by {{payment.url}}.
Check, refund and cancel. Open Payments, then a payment. Buttons: Copy payment link, Open payment link, Open in PayPal, Check status now, Refund and Cancel link (the last three need Manage connected apps). Statuses are Pending, Paid, Partly paid, Partly refunded, Refunded and Cancelled.
Nothing is taken twice. Every try at making a request carries the same repeat key, so PayPal does not make a second request for one failed try. Avox never repeats a refund or cancel on its own, and reads the request from PayPal first, so only what is really left can be refunded. Running an automation twice still makes two requests.
PayPal can be slow, busy or refuse a request. The rest of your account keeps working.
Before you try again, click Open in PayPal and look at the invoice. For a refund, if it is already listed, do not repeat it; then click Check status now in Avox. A refund that timed out may still have gone through. If a step failed while sending, look in the In PayPal list: Avox makes the request first and sends it second, so a draft invoice can be left. Delete or send it in PayPal.
On the Overview click Disconnect. Avox first shows what uses PayPal: those steps stop until you connect again (AVX-3708). Avox deletes the credentials it saved and keeps the log. In PayPal you can also delete the app or Avox's webhook. Avox does not cancel requests it already sent, so cancel any you want closed first.
Yes. Use the Sandbox Client ID and Secret, pick Sandbox (testing), and add the webhook in the sandbox app. When you are ready, click Reconnect with your live details.
AVX-3686: copy the Client ID and Secret again, whole and without spaces, and check the Environment matches where you copied them.
Check the webhook in your PayPal app uses the exact address on the Overview, has the three events ticked, and that the Webhook ID in Avox matches. Click Check status now to ask PayPal directly.
Last updated