PayPal setup guide

Agents read payments, invoices and accounts. Anything that moves money is tier 4: a person always approves it.

Ways to connect

Company admins connect apps, on the Integrations page in Everdeck: open PayPal, choose one of the ways below, follow its steps and fill in its fields. Everdeck checks what you enter before it saves anything, and asks you to confirm it’s you (your second factor) before you type any secret. How connecting works.

Your PayPal REST app (client ID and secret)

Your OAuth app.

This way uses the client ID and secret of an OAuth app you create for PayPal. There’s no sign-in page: Everdeck asks PayPal for a token with them.

1. Sign in to https://developer.paypal.com with your PayPal Business account and open Apps & Credentials. Switch to Live (or Sandbox to test).
2. Click Create App, name it (for example Everdeck), choose Merchant and create it.
3. Open the app and, under its features, keep Invoicing on and tick Transaction search (and Customer disputes if it is listed). Save. New features reach only new access tokens, which PayPal can cache for up to 9 hours. Balances need their own reporting permission; if Get balances reports NOT_AUTHORIZED, ask PayPal to enable balance reporting for the app.
4. Copy the Client ID and Secret into the form and pick the same environment.
5. You don't need to add a webhook: live updates from PayPal (starting work when a payment is captured or refunded, a dispute opens or an invoice is paid) aren't available yet, so leave the webhook ID empty.

Field	What to enter
PayPal environment	Choice: Live, Sandbox.
Webhook ID (optional, not used yet)	Text. Live updates from PayPal aren't available yet; leave this empty.

Disconnecting deletes the access token Everdeck saved for this connection. The OAuth app's client ID and secret stay saved under OAuth apps in Everdeck and keep working at PayPal until you delete the app or rotate its secret there.

What agents can do

An agent uses an action only when its charter grants it, on the agent’s Tools tab, where you choose whether each one runs by itself (Auto), asks first or never runs. Each action has a risk tier: tier 3 actions, which customers or the public see, ask first unless you choose otherwise, and tier 4 actions (money, deleting things, access) always need a person. How tools and tiers work.

Actions marked Reads outside content return things people outside your company may have written. Agents treat what they read as information, never as instructions, and their riskier actions later in the same session need approval.

• Search transactionsTier 0 · ReadReads outside contentpaypal_search_transactions

  List account activity (payments, refunds, fees, transfers) in a window of at most 31 days, newest data up to 3 hours behind, going back 3 years. Filter by transaction id, status (S completed, P pending, D denied, V reversed), currency or amount range. For a PayPal Checkout payment the transaction id is the capture id used by refund_payment.

• Get balancesTier 0 · ReadReads outside contentpaypal_get_balances

  Get the PayPal account's total, available and withheld balance in each currency (refreshed up to 3 hours late).

• Refund a paymentTier 4 · Money or irreversibleReads outside contentpaypal_refund_payment

  Refund a captured payment in full, or partly with amount and currency. The buyer gets the money back and sees note_to_payer in their history and email.

• Search invoicesTier 0 · ReadReads outside contentpaypal_search_invoices

  Find PayPal invoices by recipient email or business name, invoice number, status (DRAFT, SENT, SCHEDULED, PAID, MARKED_AS_PAID, CANCELLED, REFUNDED, PARTIALLY_PAID, PARTIALLY_REFUNDED, MARKED_AS_REFUNDED, UNPAID, PAYMENT_PENDING, AUTO_CANCELLED, PAID_EXTERNAL, REFUNDED_EXTERNAL, SHARED) or due-date range. Returns totals and amount due.

• Read an invoiceTier 0 · ReadReads outside contentpaypal_get_invoice

  Read one invoice with recipient, lines, amounts, payments, refunds and the payer link (detail.metadata.recipient_view_url).

• Draft an invoiceTier 2 · ReversibleReads outside contentpaypal_create_draft_invoice

  Create a draft PayPal invoice for a recipient email with line items. Nothing is sent until send_invoice. Amounts are decimal strings in the invoice currency.

• Send an invoiceTier 4 · Money or irreversibleReads outside contentpaypal_send_invoice

  Send a draft invoice to its recipient by PayPal email (or schedule it when the invoice date is in the future). After sending, the customer can pay it online.

• Send a payment reminderTier 3 · ExternalReads outside contentpaypal_remind_invoice

  Email the recipient a reminder about an unpaid sent invoice, using PayPal's standard reminder text. PayPal lets an API caller send only 2 reminders a day.

• Record an offline paymentTier 4 · Money or irreversiblepaypal_record_invoice_payment

  Mark an invoice paid (or partly paid) for money received outside PayPal, such as a bank transfer or cash. This changes the invoice status only; no money moves.

• List disputesTier 0 · ReadReads outside contentpaypal_list_disputes

  List customer disputes and claims, newest first, created since start_time (within 180 days) or for one transaction. dispute_state REQUIRED_ACTION means you must respond, usually before seller_response_due_date.

• Read a disputeTier 0 · ReadReads outside contentpaypal_get_dispute

  Read one dispute: reason, amount, stage, deadlines, disputed transactions, messages exchanged, offers and the actions currently allowed (links with rel such as send_message, provide_evidence or accept_claim).

• Message the buyer about a disputeTier 3 · ExternalReads outside contentpaypal_send_dispute_message

  Send a message to the buyer in a dispute that is still in the INQUIRY stage (get_dispute shows a send_message link), for example shipment tracking or an offer to help. The buyer sees it in PayPal's Resolution Center.

Testing, problems and disconnecting

Everdeck checks the connection when you save it. On the connection’s page in Integrations, Test checks it again at any time.

If PayPal later refuses the connection, for example because a key was deleted or a sign-in expired, the connection shows Needs attention on the Integrations page and the people who manage connections are told. Agents can’t use it until a company admin fixes it with Edit.

To stop agents using PayPal, open the connection and select Disconnect. Agents stop using it at once and its saved credentials are deleted. What else happens depends on how it was connected: each way above says.