PayPal
Connect with PayPal to manage payments and transactions.
Authentication
This connector uses Token-based authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 114 actions:
| Action | Purpose | Parameters |
|---|---|---|
| billing_subscriptions/post_v1_billing_plans | Creates a plan that defines pricing and billing cycle details for subscriptions. | Prefer (string) PayPal-Request-Id (string) data: { . product_id (string) . name (string) . status (string) . description (string) . billing_cycles . payment_preferences . taxes . quantity_supported (boolean) } (object) required |
| billing_subscriptions/get_v1_billing_plans | Lists billing plans. | Prefer (string) product_id (string) page_size (integer) page (integer) total_required (boolean) |
| billing_subscriptions/get_v1_billing_plans_by_id | Shows details for a plan, by ID. | id (string) |
| billing_subscriptions/patch_v1_billing_plans_by_id | Updates a CREATED or ACTIVE plan. INACTIVE plans can only update status. Patchable fields: description, payment preferences, taxes, setup fees, and name. | id (string) data (undefined) required |
| billing_subscriptions/post_v1_billing_plans_by_id_activate | Activates a plan, by ID. | id (string) |
| billing_subscriptions/post_v1_billing_plans_by_id_deactivate | Deactivates a plan, by ID. | id (string) |
| billing_subscriptions/post_v1_billing_plans_by_id_update_pricing_schemes | Updates pricing for a plan. For example, you can update a regular billing cycle from $5 per month to $7 per month. | id (string) data: { . pricing_schemes } (object) required |
| billing_subscriptions/post_v1_billing_subscriptions | Creates a subscription. | Prefer (string) PayPal-Request-Id (string) data: { . plan_id (string) . start_time . quantity (string) . shipping_amount . subscriber . auto_renewal (boolean) . application_context . custom_id (string) . plan . merchant_inventory } (object) required |
| billing_subscriptions/get_v1_billing_subscriptions_by_id | Shows details for a subscription, by ID. | id (string) fields (string) |
| billing_subscriptions/patch_v1_billing_subscriptions_by_id | Updates a subscription which could be in codeACTIVE/code or codeSUSPENDED/code status. You can override plan level default attributes by providing customised values for plan path in the patch request.br / ul liYou cannot update attributes that have already completed Example - trial cycles can’t be updated if completed./li liOnce overridden, changes to plan resource will not impact subscription./li liAny price update will not impact billing cycles within next 10 days Applicable only for subscript | id (string) data (undefined) required |
| billing_subscriptions/post_v1_billing_subscriptions_by_id_revise | Updates the quantity of the product or service in a subscription. You can also use this method to switch the plan and update the shipping_amount, shipping_address values for the subscription. This type of update requires the buyer's consent. | id (string) data: { . plan_id (string) . quantity (string) . shipping_amount . shipping_address . application_context (object) . plan } (object) required |
| billing_subscriptions/post_v1_billing_subscriptions_by_id_suspend | Suspends the subscription. | id (string) data: { . reason (string) } (object) required |
| billing_subscriptions/post_v1_billing_subscriptions_by_id_cancel | Cancels the subscription. | id (string) data: { . reason (string) } (object) required |
| billing_subscriptions/post_v1_billing_subscriptions_by_id_activate | Activates the subscription. | id (string) data: { . reason (string) } (object) required |
| billing_subscriptions/post_v1_billing_subscriptions_by_id_capture | Captures an authorized payment from the subscriber on the subscription. | id (string) PayPal-Request-Id (string) data: { . note (string) . capture_type (string) . amount } (object) required |
| billing_subscriptions/get_v1_billing_subscriptions_by_id_transactions | Lists transactions for a subscription. | id (string) start_time (string) required end_time (string) required |
| catalogs_products/post_v1_catalogs_products | Creates a product. | Prefer (string) PayPal-Request-Id (string) data: { . id (string) . name (string) . description (string) . type (string) . category . image_url (string) . home_url (string) } (object) required |
| catalogs_products/get_v1_catalogs_products | Lists products. | page_size (integer) page (integer) total_required (boolean) |
| catalogs_products/get_v1_catalogs_products_by_product_id | Shows details for a product, by ID. | product_id (string) |
| catalogs_products/patch_v1_catalogs_products_by_product_id | Updates product by ID. Patchable fields: description, category, image_url, home_url. Operations: add, replace, remove. | product_id (string) data (array) required |
| checkout_orders/post_v2_checkout_orders | Creates an order. Merchants can add Level 2 and 3 data to reduce risk and processing costs. | PayPal-Request-Id (string) PayPal-Partner-Attribution-Id (string) PayPal-Client-Metadata-Id (string) Prefer (string) PayPal-Auth-Assertion (string) data: { . intent . payer . purchase_units . payment_source . application_context } (object) required |
| checkout_orders/get_v2_checkout_orders_by_id | Shows order details by ID. | id (string) PayPal-Auth-Assertion (string) fields (string) |
| checkout_orders/patch_v2_checkout_orders_by_id | Updates CREATED or APPROVED orders. Cannot update COMPLETED orders. Requires reference_id. Patchable fields include intent, payer, purchase_units, shipping, amounts, items, payment_instruction, and supplementary_data. | id (string) PayPal-Auth-Assertion (string) data (undefined) required |
| checkout_orders/post_v2_checkout_orders_by_id_confirm_payment_source | Payer confirms their intent to pay for the the Order with the given payment source. | id (string) PayPal-Client-Metadata-Id (string) PayPal-Auth-Assertion (string) Prefer (string) data (undefined) required |
| checkout_orders/post_v2_checkout_orders_by_id_authorize | Authorizes payment for an order. Buyer must approve order or provide valid payment_source. | id (string) PayPal-Request-Id (string) Prefer (string) PayPal-Client-Metadata-Id (string) PayPal-Auth-Assertion (string) data: { . payment_source (object) } (object) required |
| checkout_orders/post_v2_checkout_orders_by_id_capture | Captures payment for an order. Buyer must approve order or provide valid payment_source. | id (string) PayPal-Request-Id (string) Prefer (string) PayPal-Client-Metadata-Id (string) PayPal-Auth-Assertion (string) data: { . payment_source (object) } (object) required |
| checkout_orders/post_v2_checkout_orders_by_id_track | Adds tracking information for an Order. | id (string) PayPal-Auth-Assertion (string) data: { . tracking_number (string) . carrier . carrier_name_other (string) . capture_id (string) . notify_payer (boolean) . items } (object) required |
| checkout_orders/patch_v2_checkout_orders_by_id_trackers_by_tracker_id | Updates or cancels order tracking information by ID. Updatable fields: items replace, notify_payer replace/add, status replace - CANCELLED only. | id (string) tracker_id (string) PayPal-Auth-Assertion (string) data (array) required |
| checkout_orders/post_v2_checkout_orders_order_update_callback | 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. In the request, PayPal will send the buyer's redacted shipping address and selected shipping option to the callback URL defined the create order request. The response from the merchant will update the Orders resource. | data: { . id (string) . shipping_address (object) . shipping_option (object) . purchase_units } (object) required |
| customer_disputes/get_v1_customer_disputes | Lists disputes with a summary set of details, which shows the codedispute_id/code, codereason/code, codestatus/code, codedispute_state/code, codedispute_life_cycle_stage/code, codedispute_channel/code, codedispute_amount/code, codecreate_time/code and codeupdate_time/code fields.br/br/To filter the disputes in the response, specify one or more optional query parameters. To limit the number of disputes in the response, specify the codepage_size/code query parameter.br/br/To list multiple disputes | start_time (string) disputed_transaction_id (string) page_size (integer) next_page_token (string) dispute_state (string) update_time_before (string) update_time_after (string) |
| customer_disputes/get_v1_customer_disputes_by_id | Shows details for a dispute, by ID.blockquotestrongNote:/strong 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./blockquote | id (string) |
| customer_disputes/patch_v1_customer_disputes_by_id | Partially updates a dispute, by ID. Seller can update the communication_detail value or The partner can add the partner action information. | id (string) data (array) required |
| customer_disputes/post_v1_customer_disputes_by_id_provide_evidence | Provides evidence for a dispute, by ID. A merchant can provide evidence for disputes with the codeWAITING_FOR_SELLER_RESPONSE/code status while customers can provide evidence for disputes with the codeWAITING_FOR_BUYER_RESPONSE/code status. Evidence can be a proof of delivery or proof of refund document or notes, which can include logs. A proof of delivery document includes a tracking number while a proof of refund document includes a refund ID. For other evidence type, notes and documents can b | id (string) |
| customer_disputes/post_v1_customer_disputes_by_id_appeal | Appeals a dispute, by ID. To appeal a dispute, use the codeappeal/code link in the a href='/docs/api/reference/api-responses/ hateoas-links/'HATEOAS links/a 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. For constraints and rules regarding documents, see a href='/docs/integration/direct/customer-disputes/integration-guide/ documents'documents/a.br/To make this request, speci | id (string) |
| customer_disputes/post_v1_customer_disputes_by_id_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. Allowed accept_claim_type values for the request is available in dispute details a href='/docs/api/customer-disputes/v1/ definition-allowed_response_options'allowed response options/a object. | id (string) |
| customer_disputes/post_v1_customer_disputes_by_id_adjudicate | blockquotestrongImportant:/strong This method is for sandbox use only./blockquote 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. To make this call, the dispute codestatus/code must be codeUNDER_REVIEW/code and codeadjudicate/code link should be available in the a href='/docs/api/customer-disputes/v1/ disputes_ge | id (string) data: { . adjudication_outcome (string) } (object) required |
| customer_disputes/post_v1_customer_disputes_by_id_require_evidence | blockquotestrongImportant:/strong This method is for sandbox use only./blockquote Updates the status of a dispute, by ID, from codeUNDER_REVIEW/code to either:ullicodeWAITING_FOR_BUYER_RESPONSE/code/lilicodeWAITING_FOR_SELLER_RESPONSE/code/li/ulThis status change enables either the customer or merchant to submit evidence for the dispute. To make this call, the dispute codestatus/code must be codeUNDER_REVIEW/code and coderequire-evidence/code link should be available in the a href='/docs/api/cu | id (string) data: { . action (string) } (object) required |
| customer_disputes/post_v1_customer_disputes_by_id_escalate | Escalates the dispute, by ID, to a PayPal claim. To make this call, the stage in the dispute lifecycle must be INQUIRY. | id (string) data: { . note (string) . buyer_escalation_reason } (object) required |
| customer_disputes/post_v1_customer_disputes_by_id_send_message | Sends a message about a dispute, by ID, to the other party in the dispute. Merchants and customers can only send messages if the dispute_life_cycle_stage value is INQUIRY. For constraints and rules regarding documents that can be attached as part of the message, see a href='/docs/integration/direct/customer-disputes/integration-guide/ documents'documents/a. To send a message, use the codesend-message/code link in the a href='/docs/api/reference/api-responses/ hateoas-links/'HATEOAS links/a of th | id (string) |
| customer_disputes/post_v1_customer_disputes_by_id_make_offer | 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. Allowed offer_type values for the request is available in dispute details a href='/docs/api/customer-disputes/v1/ definition-allowed_response_options'allowed response options/a object. | id (string) data: { . note (string) . offer_amount . return_shipping_address . invoice_id (string) . offer_type } (object) required |
| customer_disputes/post_v1_customer_disputes_by_id_accept_offer | The customer accepts the offer from merchant to resolve a dispute, by ID. PayPal automatically refunds the amount proposed by merchant to the customer. | id (string) data: { . note (string) } (object) required |
| customer_disputes/post_v1_customer_disputes_by_id_deny_offer | Denies an offer that the merchant proposes for a dispute, by ID. | id (string) data: { . note (string) } (object) required |
| customer_disputes/post_v1_customer_disputes_by_id_acknowledge_return_item | Acknowledges that the customer returned an item for a dispute, by ID. A merchant can make this request for disputes with the MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED reason. Allowed acknowledgement_type values for the request is available in dispute details a href='/docs/api/customer-disputes/v1/ definition-allowed_response_options'allowed response options/a object. For constraints and rules regarding documents, see a href='/docs/integration/direct/customer-disputes/integration-guide/ documents'd | id (string) |
| customer_disputes/post_v1_customer_disputes_by_id_provide_supporting_info | 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. The party can provide the supporting information to PayPal to defend themselves only when the dispute_life_cycle_stage is CHARGEBACK, PRE_ARBITRATION, or ARBITRATION. They can provide a note that describes their part with details or upload any supporting documents to support their side. For c | id (string) |
| customer_partner_referrals/post_v2_customer_partner_referrals | 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. | data (object) required |
| customer_partner_referrals/get_v2_customer_partner_referrals_by_partner_referral_id | Shows details by ID for referral data that was shared by the partner or API caller. | partner_referral_id (string) |
| invoicing/post_v2_invoicing_invoices | Creates a draft invoice. To move the invoice from a draft to payable state, you must a href=' invoices_send'send the invoice/a.br/br/In the JSON request body, include invoice details including merchant information. The codeinvoice/code object must include an codeitems/code array.blockquotestrongNote:/strong The merchant that you specify in an invoice must have a PayPal account in good standing./blockquote. | data: { . id (string) . parent_id (string) . status . detail . invoicer . primary_recipients . additional_recipients . items . configuration . amount . due_amount . gratuity . payments . refunds . links } (object) required |
| invoicing/get_v2_invoicing_invoices | Lists invoices. To filter the invoices that appear in the response, you can specify one or more optional query parameters. | page (integer) page_size (integer) total_required (boolean) fields (string) |
| invoicing/post_v2_invoicing_invoices_by_invoice_id_send | Sends or schedules an invoice, by ID, to be sent to a customer. The action depends on the invoice issue date:ulliIf the invoice issue date is current or in the past, sends the invoice immediately./liliIf the invoice issue date is in the future, schedules the invoice to be sent on that date./li/ulTo suppress the merchant's email notification, set the send_to_invoicer body parameter to false. To send the invoice through a share link and not through PayPal, set the codesend_to_recipient/code parame | invoice_id (string) data: { . subject (string) . note (string) . send_to_invoicer (boolean) . send_to_recipient (boolean) . additional_recipients } (object) required |
| invoicing/post_v2_invoicing_invoices_by_invoice_id_remind | 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. blockquotestrongNotes:/strongulliAPI caller can send only 2 reminders in a day./li/ul/blockquote. | invoice_id (string) data: { . subject (string) . note (string) . send_to_invoicer (boolean) . send_to_recipient (boolean) . additional_recipients } (object) required |
| invoicing/post_v2_invoicing_invoices_by_invoice_id_cancel | Cancels a sent invoice, by ID, and, optionally, sends a notification about the cancellation to the payer, merchant, and CC: emails. | invoice_id (string) data: { . subject (string) . note (string) . send_to_invoicer (boolean) . send_to_recipient (boolean) . additional_recipients } (object) required |
| invoicing/post_v2_invoicing_invoices_by_invoice_id_payments | 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. | invoice_id (string) data: { . type . payment_id (string) . payment_date . method . note (string) . amount . shipping_info } (object) required |
| invoicing/delete_v2_invoicing_invoices_by_invoice_id_payments_by_transaction_id | Deletes an external payment, by invoice ID and transaction ID. | invoice_id (string) transaction_id (string) |
| invoicing/post_v2_invoicing_invoices_by_invoice_id_refunds | 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. | invoice_id (string) data: { . type . refund_id (string) . refund_date . amount . method } (object) required |
| invoicing/delete_v2_invoicing_invoices_by_invoice_id_refunds_by_transaction_id | Deletes an external refund, by invoice ID and transaction ID. | invoice_id (string) transaction_id (string) |
| invoicing/post_v2_invoicing_invoices_by_invoice_id_generate_qr_code | Generates a QR code for an invoice, by ID. The QR code is a PNG image in a href='https://www.base64encode.org/'Base64-encoded/a 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. When customers use their mobile devices to scan the QR code, they are redirected to the PayPal mobile payment flow where they can view the invoice and pay online with PayPal or a credit card. Before you get a QR code, you must a href=' invoices_crea | invoice_id (string) data: { . width (integer) . height (integer) . action (string) } (object) required |
| invoicing/post_v2_invoicing_generate_next_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. | data: { . fetch_id (boolean) } (object) required |
| invoicing/get_v2_invoicing_invoices_by_invoice_id | Shows details for an invoice, by ID. | invoice_id (string) |
| invoicing/put_v2_invoicing_invoices_by_invoice_id | Fully updates an invoice, by ID. In the JSON request body, include a complete invoice object. This call does not support partial updates. blockquotestrongNotes:/strongulliAPI caller can change/modify recipient only 2 times in 72 hours./li/ul/blockquote. | invoice_id (string) send_to_recipient (boolean) send_to_invoicer (boolean) data: { . id (string) . parent_id (string) . status . detail . invoicer . primary_recipients . additional_recipients . items . configuration . amount . due_amount . gratuity . payments . refunds . links } (object) required |
| invoicing/delete_v2_invoicing_invoices_by_invoice_id | 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 a href='/docs/api/invoicing/v2/ invoices_cancel'cancel the invoice/a. After you delete a draft or scheduled invoice, you can no longer use it or show its details. However, you can reuse its invoice number. | invoice_id (string) |
| invoicing/post_v2_invoicing_search_invoices | Searches for and lists invoices that match search criteria. If you pass multiple criteria, the response lists invoices that match all criteria. | page (integer) page_size (integer) total_required (boolean) data: { . recipient_email (string) . recipient_first_name (string) . recipient_last_name (string) . recipient_business_name (string) . invoice_number (string) . status . reference (string) . currency_code . memo (string) . total_amount_range . invoice_date_range . due_date_range . payment_date_range . creation_date_range . archived (boolean) . fields } (object) required |
| invoicing/get_v2_invoicing_templates | Lists merchant-created templates with associated details. The associated details include the emails, addresses, and phone numbers from the user's PayPal profile.br/The user can select which values to show in the business information section of their template. | fields (string) page (integer) page_size (integer) |
| invoicing/post_v2_invoicing_templates | Creates an invoice template. You can use details from this template to create an invoice. You can create up to 50 templates.blockquotestrongNote:/strong Every merchant starts with three PayPal system templates that are optimized for the unit type billed. The template includes Quantity, Hours, and Amount./blockquote | data: { . id (string) . name (string) . default_template (boolean) . template_info . settings . unit_of_measure . standard_template (boolean) . links } (object) required |
| invoicing/get_v2_invoicing_templates_by_template_id | Shows details for a template, by ID. | template_id (string) |
| invoicing/put_v2_invoicing_templates_by_template_id | Fully updates a template, by ID. In the JSON request body, include a complete template object. This call does not support partial updates. | template_id (string) data: { . id (string) . name (string) . default_template (boolean) . template_info . settings . unit_of_measure . standard_template (boolean) . links } (object) required |
| invoicing/delete_v2_invoicing_templates_by_template_id | Deletes a template, by ID. | template_id (string) |
| invoicing/get_v2_invoicing_accounting_sync_merchant_connections | Lists connections to accounting platforms per merchant. | No parameters |
| invoicing/get_v2_invoicing_accounting_sync_invoices_by_id_connections | Lists connections to accounting platforms per invoice. | id (string) |
| notifications_webhooks/post_v1_notifications_webhooks | Subscribes your webhook listener to events. | data: { . id (string) . url (string) . event_types . links } (object) required |
| notifications_webhooks/get_v1_notifications_webhooks | Lists webhooks for an app. | anchor_type (string) |
| notifications_webhooks/get_v1_notifications_webhooks_by_webhook_id | Shows details for a webhook, by ID. | webhook_id (string) |
| notifications_webhooks/patch_v1_notifications_webhooks_by_webhook_id | Updates a webhook to replace webhook fields with new values. Supports only the replace operation. Pass a json_patch object with replace operation and path, which is /url for a URL or /event_types for events. The value is either the URL or a list of events. | webhook_id (string) data (array) required |
| notifications_webhooks/delete_v1_notifications_webhooks_by_webhook_id | Deletes a webhook, by ID. | webhook_id (string) |
| notifications_webhooks/get_v1_notifications_webhooks_by_webhook_id_event_types | Lists event subscriptions for a webhook, by ID. | webhook_id (string) |
| notifications_webhooks/post_v1_notifications_webhooks_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. If a webhook event is generated for an event that is tied to the account but not to a particular REST API app for example, payments initiated with the NVP/SOAP APIs or through the user interface on PayPal.com, those webhook events will treated as if they were intended for the REST API app registered in the webhook lookup instead. Webhoo | No parameters |
| notifications_webhooks/get_v1_notifications_webhooks_lookup | Lists webhook lookups. | No parameters |
| notifications_webhooks/get_v1_notifications_webhooks_lookup_by_webhook_lookup_id | Shows details for a webhook lookup, by ID. | webhook_lookup_id (string) |
| notifications_webhooks/delete_v1_notifications_webhooks_lookup_by_webhook_lookup_id | Deletes a webhook lookup, by ID. | webhook_lookup_id (string) |
| notifications_webhooks/post_v1_notifications_verify_webhook_signature | Verifies a webhook signature. | data: { . auth_algo (string) . cert_url (string) . transmission_id (string) . transmission_sig (string) . transmission_time (string) . webhook_id (string) . webhook_event } (object) required |
| notifications_webhooks/get_v1_notifications_webhooks_event_types | Lists available events to which any webhook can subscribe. For a list of supported events, see Webhook event names/docs/api/notifications/webhooks/event-names/. | No parameters |
| notifications_webhooks/get_v1_notifications_webhooks_events | Lists webhooks event notifications. Use query parameters to filter the response. | page_size (integer) start_time (string) end_time (string) transaction_id (string) event_type (string) |
| notifications_webhooks/get_v1_notifications_webhooks_events_by_event_id | Shows details for a webhooks event notification, by ID. | event_id (string) |
| notifications_webhooks/post_v1_notifications_webhooks_events_by_event_id_resend | Resends a webhook event notification, by ID. Any pending notifications are not resent. | event_id (string) data: { . webhook_ids } (object) required |
| notifications_webhooks/post_v1_notifications_simulate_event | Simulates a webhook event. In the JSON request body, specify a sample payload.brYou need to subscribe to the following webhook events for Pay upon Invoice:brtabletheadtrthEvent/ththTrigger/th/tr/theadtbodytrtdcodePAYMENT.CAPTURE.COMPLETED/code/tdtdA payment capture completes./td/trtrtdcodePAYMENT.CAPTURE.DENIED/code/tdtdA payment capture is denied./td/trtrtdcodeCHECKOUT.PAYMENT-APPROVAL.REVERSED/code/tdtdPayPal reverses a payment capture./td/tr/tbody/table | data: { . webhook_id (string) . url (string) . event_type (string) . resource_version (string) } (object) required |
| payment_experience_web_experience_profiles/post_v1_payment_experience_web_profiles | Creates a web experience profile. In the JSON request body, specify the profile name and details. | PayPal-Request-Id (string) required data (undefined) required |
| payment_experience_web_experience_profiles/get_v1_payment_experience_web_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. | No parameters |
| payment_experience_web_experience_profiles/put_v1_payment_experience_web_profiles_by_id | 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. | id (string) data (undefined) required |
| payment_experience_web_experience_profiles/patch_v1_payment_experience_web_profiles_by_id | 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. | id (string) data (array) required |
| payment_experience_web_experience_profiles/get_v1_payment_experience_web_profiles_by_id | Shows details for a web experience profile, by ID. | id (string) |
| payment_experience_web_experience_profiles/delete_v1_payment_experience_web_profiles_by_id | Deletes a web experience profile, by ID. | id (string) |
| payments_payment/get_v2_payments_authorizations_by_authorization_id | Shows details for an authorized payment, by ID. | authorization_id (string) PayPal-Auth-Assertion (string) |
| payments_payment/post_v2_payments_authorizations_by_authorization_id_capture | Captures an authorized payment, by ID. | authorization_id (string) PayPal-Request-Id (string) Prefer (string) PayPal-Auth-Assertion (string) data (undefined) required |
| payments_payment/post_v2_payments_authorizations_by_authorization_id_reauthorize | 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. Within the 29-day authorization period, you can issue multiple re-authorizations after the honor period expires.br/br/If 30 days have transpired since the date of the original authorization, you must create an authorized payment instead of reauthorizing the original authorized payment.br/br/A reauthorized payment itself has a | authorization_id (string) PayPal-Request-Id (string) Prefer (string) PayPal-Auth-Assertion (string) data: { . amount } (object) required |
| payments_payment/post_v2_payments_authorizations_by_authorization_id_void | Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been fully captured. | authorization_id (string) PayPal-Auth-Assertion (string) PayPal-Request-Id (string) Prefer (string) |
| payments_payment/get_v2_payments_captures_by_capture_id | Shows details for a captured payment, by ID. | capture_id (string) |
| payments_payment/post_v2_payments_captures_by_capture_id_refund | 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 codeamount/code object in the JSON request body. | capture_id (string) PayPal-Request-Id (string) Prefer (string) PayPal-Auth-Assertion (string) data: { . amount . custom_id (string) . invoice_id (string) . note_to_payer (string) . payment_instruction } (object) required |
| payments_payment/get_v2_payments_refunds_by_refund_id | Shows details for a refund, by ID. | refund_id (string) PayPal-Auth-Assertion (string) |
| payments_payouts_batch/post_v1_payments_payouts | Creates a batch payout. In the JSON request body, pass a sender_batch_header and an items array. The sender_batch_header defines how to handle the payout. The items array defines the payout items.br/You can make payouts to one or more recipients.blockquotestrongNotes:/strong ullipPayPal does not process duplicate payouts. If you specify a codesender_batch_id/code that was used in the last 30 days, the API rejects the request with an error message that shows the duplicate codesender_batch_id/code | PayPal-Request-Id (string) data: { . sender_batch_header . items } (object) required |
| payments_payouts_batch/get_v1_payments_payouts_by_id | Shows the latest status of a batch payout. Includes the transaction status and other data for individual payout items. | id (string) fields (string) page (integer) page_size (integer) total_required (boolean) |
| payments_payouts_batch/get_v1_payments_payouts_item_by_payout_item_id | Shows details for a payout item, by ID. A codepayout_item_id/code helps you identify denied payments. If a payment is denied, you can use the codepayout_item_id/code to identify the payment even if it lacks a codetransaction_id/code. | payout_item_id (string) |
| payments_payouts_batch/post_v1_payments_payouts_item_by_payout_item_id_cancel | 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. You can cancel payout items with a codetransaction_status/code of codeUNCLAIMED/code. | payout_item_id (string) |
| reporting_transactions/get_v1_reporting_transactions | Lists transactions. Specify one or more query parameters to filter the transaction that appear in the response.blockquotestrongNotes:/strong ulliIf you specify one or more optional query parameters, the codeending_balance/code response field is empty./liliIt takes a maximum of three hours for executed transactions to appear in the list transactions call./liliThis call lists transaction for the previous three years./li/ul/blockquote | transaction_id (string) transaction_type (string) transaction_status (string) transaction_amount (string) transaction_currency (string) start_date (string) required end_date (string) required payment_instrument_type (string) store_id (string) terminal_id (string) fields (string) balance_affecting_records_only (string) page_size (integer) page (integer) |
| reporting_transactions/get_v1_reporting_balances | List all balances. Specify date time to list balances for that time that appear in the response.blockquotestrongNotes:/strong ulliIt takes a maximum of three hours for balances to appear in the list balances call./liliThis call lists balances upto the previous three years./li/ul/blockquote | as_of_time (string) currency_code (string) |
| shipping_shipment_tracking/post_v1_shipping_trackers_batch | blockquotestrongDeprecation notice:/strong Adding tracking details for an order through code/v1/shipping/trackers-batch/code is deprecated as its a legacy way of integration. Use the new a href='/docs/tracking/orders-api/integrate/'Orders v2 API/a to share tracking details with PayPal./blockquoteAdds tracking information, with or without tracking numbers, for multiple PayPal transactions. Accepts up to 20 tracking IDs. For more information, see a href='/docs/tracking/tracking-api/integrate/ link | data (undefined) required |
| shipping_shipment_tracking/post_v1_shipping_trackers | Adds tracking information for a PayPal transaction. | data (undefined) required |
| shipping_shipment_tracking/get_v1_shipping_trackers | Lists tracking information that meet search criteria. The tracking ID is required but the tracking number is optional. | transaction_id (string) required tracking_number (string) account_id (string) |
| shipping_shipment_tracking/put_v1_shipping_trackers_by_id | 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 a href='/docs/tracking/tracking-api/integrate/ link-updateorcanceltrackinginformation'Update or cancel tracking information/a. | id (string) data: { . transaction_id (string) . tracking_number (string) . tracking_number_type . status . shipment_date . carrier . carrier_name_other (string) . postage_payment_id (string) . notify_buyer (boolean) . quantity (integer) . tracking_number_validated (boolean) . last_updated_time . shipment_direction (string) . shipment_uploader (string) . account_id (string) . tracking_url (string) . links } (object) required |
| shipping_shipment_tracking/get_v1_shipping_trackers_by_id | Shows tracking information, by tracker ID, for a PayPal transaction. | id (string) account_id (string) |
| vault_payment_tokens/post_v3_vault_payment_tokens | Creates a Payment Token from the given payment source and adds it to the Vault of the associated customer. | PayPal-Request-Id (string) data: { . customer (object) . payment_source } (object) required |
| vault_payment_tokens/get_v3_vault_payment_tokens | Returns all payment tokens for a customer. | customer_id (string) required page_size (integer) page (integer) total_required (boolean) |
| vault_payment_tokens/get_v3_vault_payment_tokens_by_id | Returns a readable representation of vaulted payment source associated with the payment token id. | id (string) |
| vault_payment_tokens/delete_v3_vault_payment_tokens_by_id | Delete the payment token associated with the payment token id. | id (string) |
| vault_payment_tokens/post_v3_vault_setup_tokens | Creates a Setup Token from the given payment source and adds it to the Vault of the associated customer. | PayPal-Request-Id (string) data: { . customer (object) . payment_source } (object) required |
| vault_payment_tokens/get_v3_vault_setup_tokens_by_id | Returns a readable representation of temporarily vaulted payment source associated with the setup token id. | id (string) |