{"openapi":"3.1.0","info":{"title":"PayPal API (Bowmark)","version":"e833508f87ff","description":"PayPal's public, signed-out surfaces: the published consumer and merchant fee schedules, the fee on one concrete personal (friends-and-family) transaction, the spread PayPal adds on a currency conversion, Pay Later instalment plans, PayPal.Me handle lookup, Help Center search and articles, the binding policy documents, PayPal Shopping cashback offers, and live service status. Ten functions callable today — estimateFee, getFees, getCurrencyConversionQuote, getPolicyDocument, estimatePayLaterPlan, searchHelp, getHelpArticle, searchShoppingOffers, getPayPalMeProfile, getServiceStatus. Crypto prices are not offered by the site's public page, and invoice reads are blocked on a real invoice id nobody here holds.\n\nEvery function Bowmark has for PayPal (paypal.com) as one HTTP call. Each runs on Bowmark's infrastructure with the same billing, rules and response envelope as `POST /v1/run`. The whole API: https://api.bowmark.ai/openapi.json. Guide: https://bowmark.ai/docs/api.","contact":{"email":"support@bowmark.ai","url":"https://bowmark.ai/docs/api"}},"servers":[{"url":"https://api.bowmark.ai"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/v1/sites/paypal/estimateFee":{"post":{"operationId":"estimateFee","summary":"Computes what PayPal charges to send a PERSONAL (friends-and-family) payment — domestic or cross-border (the domestic fee for the funding source plus the international fee), by funding source — off Pa","description":"Computes what PayPal charges to send a PERSONAL (friends-and-family) payment — domestic or cross-border (the domestic fee for the funding source plus the international fee), by funding source — off PayPal's own published fee schedule, e.g. estimateFee({ amount: 100, currency: \"USD\", crossBorder: false, fundingSource: \"card\" }) -> { fee: 3.2, net: 96.8, citations: [...] }. Personal sends only; for what a SELLER pays on a goods-and-services sale read getFees({ audience: \"merchant\" }).\n\nCalls `bowmark.providers.paypal.estimateFee`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PaypalFeeEstimate>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/PaypalEstimateFeeArgs","description":"TypeScript: `PaypalEstimateFeeArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/paypal/getFees":{"post":{"operationId":"getFees","summary":"Reads PayPal's published fee schedule for one audience / country pair and returns every fee table on the page — every row, every published feeDataKey, with documentId-level citations — so a caller can","description":"Reads PayPal's published fee schedule for one audience / country pair and returns every fee table on the page — every row, every published feeDataKey, with documentId-level citations — so a caller can inspect the schedule itself rather than asking about one amount. audience \"consumer\" (personal sends) or \"merchant\" (what a seller pays to RECEIVE goods-and-services payments — e.g. getFees({ audience: \"merchant\" }) -> FEETB16 \"PayPal Checkout 3.49% + fixed fee\", FEETB18 fixed fee by currency (0.49 USD), FEETB91 +1.50% international, plus invoicing, donation and charity rates). country \"us\" only today.\n\nCalls `bowmark.providers.paypal.getFees`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PaypalFeeSchedule>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/PaypalGetFeesArgs","description":"TypeScript: `PaypalGetFeesArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/paypal/getCurrencyConversionQuote":{"post":{"operationId":"getCurrencyConversionQuote","summary":"Reads PayPal's published currency-conversion spread — the half of its fee it DOES disclose — off the same fees page (FEETB26, 4.00% for goodsOrServices/personal/payouts, 3.00% for \"other\"), e.g.","description":"Reads PayPal's published currency-conversion spread — the half of its fee it DOES disclose — off the same fees page (FEETB26, 4.00% for goodsOrServices/personal/payouts, 3.00% for \"other\"), e.g. getCurrencyConversionQuote({ kind: \"goodsOrServices\" }) -> { kind: \"goodsOrServices\", paypalSpread: 0.04, citations: { paypal: { documentId: \"FEETB26\", feeDataKey: \"4.00%\", internalName: \"...\" } } }. PayPal does NOT publish the wholesale base rate, so this function returns only the spread; combining it with a base rate from another provider (e.g. bowmark.providers.oanda.convertCurrency) is the capability tier's job, not a single provider's. consumer / us only today.\n\nCalls `bowmark.providers.paypal.getCurrencyConversionQuote`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PaypalCurrencyConversionQuote>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/PaypalGetCurrencyConversionQuoteArgs","description":"TypeScript: `PaypalGetCurrencyConversionQuoteArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/paypal/getPolicyDocument":{"post":{"operationId":"getPolicyDocument","summary":"Reads one of PayPal's binding policy documents from the legal hub — the User Agreement, Seller Protection terms, privacy statement, balance terms, or cryptocurrency terms — as structured sections rath","description":"Reads one of PayPal's binding policy documents from the legal hub — the User Agreement, Seller Protection terms, privacy statement, balance terms, or cryptocurrency terms — as structured sections rather than a wall of prose, e.g. getPolicyDocument({ documentKey: \"user-agreement\" }) -> { documentKey: \"user-agreement\", title: \"User Agreement\", lastModified: \"2026-...\", sections: [...] }. Returns the document key (enumerated), title, last-modified date, and a sections tree with subsections and content.\n\nCalls `bowmark.providers.paypal.getPolicyDocument`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PaypalPolicyDocument>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"documentKey":{"$ref":"#/components/schemas/PaypalPolicyDocumentKey"}},"required":["documentKey"],"additionalProperties":true,"description":"TypeScript: `{ documentKey: PaypalPolicyDocumentKey }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/paypal/estimatePayLaterPlan":{"post":{"operationId":"estimatePayLaterPlan","summary":"Reads PayPal's published Pay Later terms — Pay in 4 (four interest-free instalments due every two weeks) and Pay Monthly (variable APR range and term lengths) — off the marketing page at /us/digital-w","description":"Reads PayPal's published Pay Later terms — Pay in 4 (four interest-free instalments due every two weeks) and Pay Monthly (variable APR range and term lengths) — off the marketing page at /us/digital-wallet/ways-to-pay/buy-now-pay-later. Returns the standard published terms; caller supplies the amount separately to calculate actual instalments.\n\nCalls `bowmark.providers.paypal.estimatePayLaterPlan`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PaypalPayLaterPlan>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/PaypalEstimatePayLaterPlanArgs","description":"TypeScript: `PaypalEstimatePayLaterPlanArgs`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/paypal/searchHelp":{"post":{"operationId":"searchHelp","summary":"Searches PayPal's Help Center and returns the matching articles — id, title, excerpt and PayPal's own rank — for a real question like \"why is my payment on hold\", e.g.","description":"Searches PayPal's Help Center and returns the matching articles — id, title, excerpt and PayPal's own rank — for a real question like \"why is my payment on hold\", e.g. searchHelp({ query: \"payment on hold\" }) -> { results: [{ articleId: \"HELP129\", title: \"How can I release my payment(s) on hold?\", excerpt: \"...\", rank: 1 }, ...] }. PayPal answers EVERY query with a non-empty, ranked list — an unmatched query falls back to a fixed set of popular articles rather than an empty array, so a caller should judge relevance from the titles/excerpts rather than from whether `results` is empty. Pass an article's `articleId` to getHelpArticle for the full text.\n\nCalls `bowmark.providers.paypal.searchHelp`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PaypalHelpSearchResults>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"query":{"type":"string"}},"required":["query"],"additionalProperties":true,"description":"TypeScript: `{ query: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/paypal/getHelpArticle":{"post":{"operationId":"getHelpArticle","summary":"Reads one PayPal help article in full by the `articleId` a searchHelp result returned, e.g.","description":"Reads one PayPal help article in full by the `articleId` a searchHelp result returned, e.g. getHelpArticle({ articleId: \"HELP101\" }) -> { articleId: \"HELP101\", title: \"How do I issue a refund?\", topicId: \"help_refunds_personal\", topicName: \"Refunds\", content: \"<section>...</section>\", excerpt: \"...\", sourceUrl: \"https://www.paypal.com/us/cshelp/article/help101\" }. `content` is the full article body as PayPal publishes it (HTML with its own headings, lists and links) rather than the snippet searchHelp carries. Throws if the id does not resolve to a real article — PayPal's own help centre answers that case with an empty-content page rather than a 404.\n\nCalls `bowmark.providers.paypal.getHelpArticle`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PaypalHelpArticle>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"articleId":{"type":"string"}},"required":["articleId"],"additionalProperties":true,"description":"TypeScript: `{ articleId: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/paypal/searchShoppingOffers":{"post":{"operationId":"searchShoppingOffers","summary":"Lists PayPal Shopping's current cashback offers — the merchant, the reward text (e.g.","description":"Lists PayPal Shopping's current cashback offers — the merchant, the reward text (e.g. \"5% back\"), the description and tags — filtered to one merchant when given, e.g. searchShoppingOffers({ merchant: \"Sony\" }) -> { merchant: \"Sony\", offers: [{ merchant: \"Sony\", reward: \"5% back\", description: \"...\", tags: [\"Online only\"], storeIds: [...], campaignId: \"297143\", detailsUrl: \"https://paypal.com/shopping/offer-details?campaignId=297143\" }] }. PayPal's public explore feed is ONE browsable collection today, not a merchant-indexed search — this function walks it and filters client-side, so a merchant with no current offer answers an empty `offers` array rather than an error.\n\nCalls `bowmark.providers.paypal.searchShoppingOffers`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PaypalShoppingOffersResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"merchant":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ merchant?: string }`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/paypal/getPayPalMeProfile":{"post":{"operationId":"getPayPalMeProfile","summary":"Resolves a PayPal.Me handle or link to the public profile behind it — display name, location, profile photo and which social links the owner has published — so a person can check that a paypal.me link","description":"Resolves a PayPal.Me handle or link to the public profile behind it — display name, location, profile photo and which social links the owner has published — so a person can check that a paypal.me link they were sent belongs to who they think before paying it, e.g. getPayPalMeProfile({ handle: \"LeeDread\" }) -> { handle: \"LeeDread\", found: true, displayName: \"El Phillips\", location: \"Panama City, Provincia de Panamá\", profilePhotoUrl: \"https://pics.paypal.com/...\", primaryCurrencyCode: \"USD\", intent: \"PERSONAL\", socials: { instagram: null, facebook: null, twitter: null, website: null } }. A handle that is not a live PayPal.Me profile answers found: false rather than throwing. Accepts a bare handle or a full paypal.me/paypal.com URL.\n\nCalls `bowmark.providers.paypal.getPayPalMeProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PaypalMeProfile>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"handle":{"type":"string"}},"required":["handle"],"additionalProperties":true,"description":"TypeScript: `{ handle: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/paypal/getServiceStatus":{"post":{"operationId":"getServiceStatus","summary":"Answers \"is PayPal down right now?\" off PayPal's own status page (paypal-status.com) — every product and API component across PayPal, Venmo, Braintree, Xoom and Hyperwallet with its live production an","description":"Answers \"is PayPal down right now?\" off PayPal's own status page (paypal-status.com) — every product and API component across PayPal, Venmo, Braintree, Xoom and Hyperwallet with its live production and sandbox status, plus the ones that are not Operational, e.g. getServiceStatus({ component: \"Venmo\" }) -> { allOperational: true, degraded: [], components: [{ id: 41, name: \"Venmo\", parent: null, brand: \"Venmo\", category: \"product\", production: \"Operational\", sandbox: null }, ...] }. `component` filters by name, parent or brand, case-insensitive.\n\nCalls `bowmark.providers.paypal.getServiceStatus`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<PaypalServiceStatus>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"component":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ component?: string }`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}},"PaypalConversionKind":{"anyOf":[{"const":"goodsOrServices"},{"const":"personal"},{"const":"payouts"},{"const":"other"}]},"PaypalEstimateFeeArgs":{"type":"object","properties":{"amount":{"type":"number"},"currency":{"type":"string"},"crossBorder":{"type":"boolean"},"fundingSource":{"anyOf":[{"const":"balance"},{"const":"bank"},{"const":"card"},{"const":"amexSend"}]}},"required":["amount","currency","crossBorder","fundingSource"],"additionalProperties":true},"PaypalEstimatePayLaterPlanArgs":{"type":"object","properties":{"amount":{"type":"number"}},"additionalProperties":true},"PaypalGetCurrencyConversionQuoteArgs":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/PaypalConversionKind"},"audience":{"const":"consumer"},"country":{"type":"string"}},"additionalProperties":true},"PaypalGetFeesArgs":{"type":"object","properties":{"audience":{"anyOf":[{"const":"consumer"},{"const":"merchant"}]},"country":{"type":"string"}},"additionalProperties":true},"PaypalPolicyDocumentKey":{"anyOf":[{"const":"user-agreement"},{"const":"seller-protection"},{"const":"privacy"},{"const":"balance-terms"},{"const":"cryptocurrency-terms"}]}}}}