Skip to content
← Public packages

@kentcdodds/paypal

PayPal helpers for invoices, sending invoices, transactions, and reimbursements.

README.md

37 lines · 1.5 KB · Markdown

@kentcdodds/paypal

Intent

PayPal helpers for invoice lookup, creating and sending invoices, transaction reporting, and reimbursement matching in Kody workflows.

What it does

  • List, get, search, and summarize PayPal invoices
  • Create a draft invoice, or create-and-send (send: true)
  • Send an existing draft invoice to the recipient
  • Search transaction reporting over a date range (chunked when longer than 31 days) for reimbursements or incoming payments
  • Read-only smoke test that samples recent invoices without mutating PayPal

Prerequisites / setup

  1. Save user secrets paypalClientId and paypalClientSecret (OAuth client-credentials via oauthClientCredentials). Do not paste values in chat.
  2. Approve hosts api-m.paypal.com (live) and api-m.sandbox.paypal.com if you use sandbox.
  3. Defaults to live PayPal; pass environment: 'sandbox' per call for sandbox.
  4. Approve this package to use those secrets if prompted.
  5. Agents: see AGENTS.md for import paths and smoke checks.

OpenAPI surface (scaffolded; package injects a fresh bearer per call): invoicing_v2 (invoices_list|get|search|create|send) and reporting_transactions_v1 (search_get, balances_get).

Done when

  • paypalClientId / paypalClientSecret are saved; PayPal hosts and package secret access are approved
  • Read-only smoke test returns ok: true with a small invoice sample
  • Create/send are only run after explicit user approval (they mutate PayPal)