Skip to content
Changelog

Report a bug

Paypal integration: operations for AI agents

Paypal connects to Type.com as an integration. This page lists the 115 operations documented for Claude and Codex in Type.com: 40 read, 59 write, 16 destructive.

About Paypal

Online payment system that allows money transfers and serves as an electronic alternative to traditional payment methods

Categories: Commerce & Payments

How to connect Paypal to Type.com

Access
Organization connection: one shared account for the workspace.
MCP
This integration is not available through Type’s MCP server. It remains available in Type.

To add the connection, follow the steps in Space connections.

Documented operations

115 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

115 operations listed.

Plans

  • Read

    List plans

    Lists billing plans.

  • Read

    Show plan details

    Shows details for a plan, by ID.

  • Write

    Create plan

    Creates a plan that defines pricing and billing cycle details for subscriptions.

  • Write

    Update plan

    Updates a plan with the CREATED or ACTIVE status. For an INACTIVE plan, you can make only status updates.

  • Write

    Activate plan

    Activates a plan, by ID.

  • Write

    Deactivate plan

    Deactivates a plan, by ID.

  • Write

    Update pricing

    Updates pricing for a plan. For example, you can update a regular billing cycle from $5 per month to $7 per month.

Subscriptions

  • Read

    Show subscription details

    Shows details for a subscription, by ID.

  • Read

    List transactions for subscription

    Lists transactions for a subscription.

  • Write

    Create subscription

    Creates a subscription.

  • Write

    Update subscription

    Updates a subscription which could be in ACTIVE or SUSPENDED status. You can override plan level default attributes by providing customised values for plan path in the patch request.

  • Write

    Revise plan or quantity of subscription

    Updates the quantity of the product or service in a subscription. You can also use this method to switch the plan and update the shippingamount, shippingaddress values for the subscription. This type of update requires the buyer's consent.

  • Write

    Suspend subscription

    Suspends the subscription.

  • Write

    Activate subscription

    Activates the subscription.

  • Write

    Capture authorized payment on subscription

    Captures an authorized payment from the subscriber on the subscription.

  • Destructive

    Cancel subscription

    Cancels the subscription.

Products

  • Read

    List products

    Lists products.

  • Read

    Show product details

    Shows details for a product, by ID.

  • Write

    Create product

    Creates a product.

  • Write

    Update product

    Updates a product, by ID. You can patch these attributes and objects: Attribute or object Operations description add, replace, remove category add, replace, remove imageurl add, replace, remove homeurl add, replace, remove

Orders

  • Read

    Show order details

    Shows details for an order, by ID. Note: For error handling and troubleshooting, see Orders v2 errors .

  • Write

    Create order

    Creates an order. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and payment processing costs. For more information about processing payments, see checkout or multiparty checkout . Note: For error handling and troubleshooting, see Orders v2 errors .

  • Write

    Update order

    Updates an order with a CREATED or APPROVED status. You cannot update an order with the COMPLETED status. To make an update, you must provide a referenceid.

  • Write

    Confirm the Order

    Payer confirms their intent to pay for the the Order with the given payment source.

  • Write

    Authorize payment for order

    Authorizes payment for an order. To successfully authorize payment for an order, the buyer must first approve the order or a valid paymentsource must be provided in the request.

  • Write

    Capture payment for order

    Captures payment for an order. To successfully capture payment for an order, the buyer must first approve the order or a valid paymentsource must be provided in the request.

  • Write

    Add tracking information for an Order.

    Adds tracking information for an Order.

Trackers

  • Read

    List tracking information

    Lists tracking information that meet search criteria. The tracking ID is required but the tracking number is optional.

  • Read

    Show tracking information

    Shows tracking information, by tracker ID, for a PayPal transaction.

  • Write

    Update or cancel tracking information for an order

    Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or objects: Attribute Op Notes items replace Using replace op for items will replace the entire items object with the value sent in request.

  • Write

    Add tracking information for PayPal transaction

    Adds tracking information for a PayPal transaction.

  • Destructive

    Update or cancel tracking information for PayPal transaction

    Updates or cancels the tracking information for a PayPal transaction, by ID. To cancel tracking information, call this method and set the status to CANCELLED. For more information, see Update or cancel tracking information .

Externalcallback

  • Write

    Receive updated order information via callback URL

    The documentation for this 'endpoint' is different from the other endpoints under v2 Orders. For this endpoint the role of client and server is reversed. The client sending the request is PayPal, and the server sending the response is the merchant.

Disputes

  • Read

    List disputes

    Lists disputes with a summary set of details, which shows the disputeid , reason , status , disputestate , disputelifecyclestage , disputechannel , disputeamount , createtime and updatetime fields.

  • Read

    Show dispute details

    Shows details for a dispute, by ID. Note: The fields that appear in the response depend on the access. For example, if the merchant requests shows dispute details, the customer's email ID does not appear.

  • Write

    Partially update dispute

    Partially updates a dispute, by ID. Seller can update the communicationdetail value or The partner can add the partner action information.

Disputes actions

  • Write

    Provide evidence

    Provides evidence for a dispute, by ID. A merchant can provide evidence for disputes with the WAITINGFORSELLERRESPONSE status while customers can provide evidence for disputes with the WAITINGFORBUYERRESPONSE status.

  • Write

    Appeal dispute

    Appeals a dispute, by ID. To appeal a dispute, use the appeal link in the HATEOAS links from the show dispute details response. If this link does not appear, you cannot appeal the dispute. Submit new evidence as a document or notes in the JSON request body.

  • Write

    Accept claim

    Accepts liability for a claim, by ID. When you accept liability for a claim, the dispute closes in the customer’s favor and PayPal automatically refunds money to the customer from the merchant's account.

  • Write

    Settle dispute

    Important: This method is for sandbox use only. Settles a dispute in either the customer's or merchant's favor. Merchants can make this call in the sandbox to complete end-to-end dispute resolution testing, which mimics the dispute resolution that PayPal agents normally complete.

  • Write

    Update dispute status

    Important: This method is for sandbox use only. Updates the status of a dispute, by ID, from UNDERREVIEW to either: WAITINGFORBUYERRESPONSE WAITINGFORSELLERRESPONSE This status change enables either the customer or merchant to submit evidence for the dispute.

  • Write

    Escalate dispute to claim

    Escalates the dispute, by ID, to a PayPal claim. To make this call, the stage in the dispute lifecycle must be INQUIRY.

  • Write

    Send message about dispute to other party

    Sends a message about a dispute, by ID, to the other party in the dispute. Merchants and customers can only send messages if the disputelifecyclestage value is INQUIRY. For constraints and rules regarding documents that can be attached as part of the message, see documents .

  • Write

    Make offer to resolve dispute

    Makes an offer to the other party to resolve a dispute, by ID. To make this call, the stage in the dispute lifecycle must be INQUIRY. If the customer accepts the offer, PayPal automatically makes a refund.

  • Write

    Accept offer to resolve dispute

    The customer accepts the offer from merchant to resolve a dispute, by ID. PayPal automatically refunds the amount proposed by merchant to the customer.

  • Write

    Deny offer to resolve dispute

    Denies an offer that the merchant proposes for a dispute, by ID.

  • Write

    Acknowledge returned item

    Acknowledges that the customer returned an item for a dispute, by ID. A merchant can make this request for disputes with the MERCHANDISEORSERVICENOTASDESCRIBED reason.

  • Write

    Provide supporting information for dispute

    Provides supporting information for a dispute, by ID. A merchant or buyer can make this request for disputes if they find the provide-supporting-info link in the HATEOAS links in the list disputes response.

Partner referrals

  • Read

    Show referral data

    Shows details by ID for referral data that was shared by the partner or API caller.

  • Write

    Create partner referral

    Creates a partner referral that is shared by the partner or API caller. The partner referral is used to onboard the seller, and contains the seller's personal, business, financial and operations.

Invoices

  • Read

    List invoices

    Lists invoices. To filter the invoices that appear in the response, you can specify one or more optional query parameters.

  • Read

    Show invoice details

    Shows details for an invoice, by ID.

  • Write

    Create draft invoice

    Creates a draft invoice. To move the invoice from a draft to payable state, you must send the invoice . In the JSON request body, include invoice details including merchant information. The invoice object must include an items array.

  • Write

    Send invoice

    Sends or schedules an invoice, by ID, to be sent to a customer. The action depends on the invoice issue date: If the invoice issue date is current or in the past, sends the invoice immediately.

  • Write

    Send invoice reminder

    Sends a reminder to the payer about an invoice, by ID. In the JSON request body, include a notification object that defines the subject of the reminder and other details. Notes: API caller can send only 2 reminders in a day. .

  • Write

    Record payment for invoice

    Records a payment for the invoice. If no payment is due, the invoice is marked as PAID. Otherwise, the invoice is marked as PARTIALLY PAID.

  • Write

    Record refund for invoice

    Records a refund for the invoice. If all payments are refunded, the invoice is marked as REFUNDED. Otherwise, the invoice is marked as PARTIALLY REFUNDED.

  • Write

    Generate QR code

    Generates a QR code for an invoice, by ID. The QR code is a PNG image in Base64-encoded format that corresponds to the invoice ID. You can generate a QR code for an invoice and add it to a paper or PDF invoice.

  • Write

    Generate invoice number

    Generates the next invoice number that is available to the merchant. The next invoice number uses the prefix and suffix from the last invoice number and increments the number by one. For example, the next invoice number after INVOICE-1234 is INVOICE-1235.

  • Destructive

    Cancel sent invoice

    Cancels a sent invoice, by ID, and, optionally, sends a notification about the cancellation to the payer, merchant, and CC: emails.

  • Destructive

    Delete external payment

    Deletes an external payment, by invoice ID and transaction ID.

  • Destructive

    Delete external refund

    Deletes an external refund, by invoice ID and transaction ID.

  • Destructive

    Fully update invoice

    Fully updates an invoice, by ID. In the JSON request body, include a complete invoice object. This call does not support partial updates. Notes: API caller can change/modify recipient only 2 times in 72 hours. .

  • Destructive

    Delete invoice

    Deletes a draft or scheduled invoice, by ID. Deletes invoices in the draft or scheduled state only. For invoices that have already been sent, you can cancel the invoice . After you delete a draft or scheduled invoice, you can no longer use it or show its details.

Search invoices

  • Read

    Search for invoices

    Searches for and lists invoices that match search criteria. If you pass multiple criteria, the response lists invoices that match all criteria.

Templates

  • Read

    List templates

    Lists merchant-created templates with associated details. The associated details include the emails, addresses, and phone numbers from the user's PayPal profile. The user can select which values to show in the business information section of their template.

  • Read

    Show template details

    Shows details for a template, by ID.

  • Write

    Create template

    Creates an invoice template. You can use details from this template to create an invoice. You can create up to 50 templates. Note: Every merchant starts with three PayPal system templates that are optimized for the unit type billed.

  • Destructive

    Fully update template

    Fully updates a template, by ID. In the JSON request body, include a complete template object. This call does not support partial updates.

  • Destructive

    Delete template

    Deletes a template, by ID.

Connections

  • Read

    List Connections.

    Lists connections to accounting platforms per merchant.

Invoice connection details

  • Read

    List Connection Status for an Invoice.

    Lists connections to accounting platforms per invoice.

Webhooks

  • Read

    List webhooks

    Lists webhooks for an app.

  • Read

    Show webhook details

    Shows details for a webhook, by ID.

  • Read

    List event subscriptions for webhook

    Lists event subscriptions for a webhook, by ID.

  • Write

    Create webhook

    Subscribes your webhook listener to events.

  • Write

    Update webhook

    Updates a webhook to replace webhook fields with new values. Supports only the replace operation. Pass a jsonpatch object with replace operation and path, which is /url for a URL or /eventtypes for events. The value is either the URL or a list of events.

  • Destructive

    Delete webhook

    Deletes a webhook, by ID.

Webhooks lookup

  • Read

    List webhook lookups

    Lists webhook lookups.

  • Read

    Show webhook lookup details

    Shows details for a webhook lookup, by ID.

  • Write

    Create webhook lookup

    Creates a webhook lookup. A webhook lookup ties the API caller's REST API app to the subject account (or, if no subject is specified, to the API caller's account).

  • Destructive

    Delete webhook lookup

    Deletes a webhook lookup, by ID.

Verify webhook signature

  • Write

    Verify webhook signature

    Verifies a webhook signature.

Webhooks event types

  • Read

    List available events

    Lists available events to which any webhook can subscribe. For a list of supported events, see Webhook event names.

Webhooks events

  • Read

    List event notifications

    Lists webhooks event notifications. Use query parameters to filter the response.

  • Read

    Show event notification details

    Shows details for a webhooks event notification, by ID.

  • Write

    Resend event notification

    Resends a webhook event notification, by ID. Any pending notifications are not resent.

Simulate event

  • Write

    Simulate webhook event

    Simulates a webhook event. In the JSON request body, specify a sample payload. You need to subscribe to the following webhook events for Pay upon Invoice: Event Trigger PAYMENT.CAPTURE.COMPLETED A payment capture completes. PAYMENT.CAPTURE.DENIED A payment capture is denied.

Web profiles

  • Read

    List web experience profiles

    Lists the latest 20 web experience profiles for a merchant or subject. To show details for these or additional profiles, you can show web experience profile details by ID.

  • Read

    Show web experience profile details by ID

    Shows details for a web experience profile, by ID.

  • Write

    Create web experience profile

    Creates a web experience profile. In the JSON request body, specify the profile name and details.

  • Write

    Partially update web experience profile

    Partially-updates a web experience profile, by ID. In the JSON request body, specify a patch object, the path of the profile location to update, and a new value.

  • Destructive

    Update web experience profile

    Updates a web experience profile, by ID. In the JSON request body, specify the profile details. If your request omits any profile parameters, any previously set values for those parameters are removed.

  • Destructive

    Delete web experience profile

    Deletes a web experience profile, by ID.

Authorizations

  • Read

    Show details for authorized payment

    Shows details for an authorized payment, by ID.

  • Write

    Capture authorized payment

    Captures an authorized payment, by ID.

  • Write

    Reauthorize authorized payment

    Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor period expires.

  • Destructive

    Void authorized payment

    Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been fully captured.

Captures

  • Read

    Show captured payment details

    Shows details for a captured payment, by ID.

  • Write

    Refund captured payment

    Refunds a captured payment, by ID. For a full refund, include an empty payload in the JSON request body. For a partial refund, include an amount object in the JSON request body.

Find eligible methods

  • Read

    Find a list of eligible payment methods.

    Get a list of eligible payment methods based on the input parameters provided.

Refunds

  • Read

    Show refund details

    Shows details for a refund, by ID.

Payouts

  • Read

    Show payout batch details

    Shows the latest status of a batch payout. Includes the transaction status and other data for individual payout items.

  • Write

    Create batch payout

    Creates a batch payout. In the JSON request body, pass a senderbatchheader and an items array. The senderbatchheader defines how to handle the payout. The items array defines the payout items. You can make payouts to one or more recipients.

Payouts item

  • Read

    Show payout item details

    Shows details for a payout item, by ID. A payoutitemid helps you identify denied payments. If a payment is denied, you can use the payoutitemid to identify the payment even if it lacks a transactionid .

  • Destructive

    Cancel unclaimed payout item

    Cancels an unclaimed payout item, by ID. If no one claims the unclaimed item within 30 days, the API automatically returns the funds to the sender. Use this call to cancel the unclaimed item before the automatic 30-day refund.

Transactions

  • Read

    List transactions

    Lists transactions. Specify one or more query parameters to filter the transaction that appear in the response. Notes: If you specify one or more optional query parameters, the endingbalance response field is empty.

Balances

  • Read

    List all balances

    List all balances. Specify date time to list balances for that time that appear in the response. Notes: It takes a maximum of three hours for balances to appear in the list balances call. This call lists balances upto the previous three years.

Trackers batch

  • Write

    Add tracking information for multiple PayPal transactions

    Deprecation notice: Adding tracking details for an order through /v1/shipping/trackers-batch is deprecated as its a legacy way of integration. Use the new Orders v2 API to share tracking details with PayPal.

Payment tokens

  • Read

    List all payment tokens

    Returns all payment tokens for a customer.

  • Read

    Retrieve a payment token

    Returns a readable representation of vaulted payment source associated with the payment token id.

  • Write

    Create payment token for a given payment source

    Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer.

  • Destructive

    Delete payment token

    Delete the payment token associated with the payment token id.

Setup tokens

  • Read

    Retrieve a setup token

    Returns a readable representation of temporarily vaulted payment source associated with the setup token id.

  • Write

    Create a setup token

    Creates a Setup Token from the given payment source and adds it to the Vault of the associated customer.

See How connections work for access and permissions, or browse all integrations.