Requirements
PayPal requires an active account and OAuth client credentials, granted by signing in with your account to connect — both are set up on its own site.[3]
Get your PayPal credentials
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
Connect PayPal in WEXTL
- Log in to your WEXTL account, add the PayPal node module to your workflow, and click Create new credential.Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your PayPal account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
PayPal node modules
The list below is a reference of every PayPal node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Browse every PayPal node module below — each one opens to show its input parameters, outputs, and connection requirements.
Watch InvoicesTrigger
Input fields[3]
| Field | Type |
|---|---|
LimitRequired | number |
Output fields[3]
| Field | Type |
|---|---|
DetailRequired | object |
Currency CodeRequired | text |
| Reference | text |
| Note | text |
| Terms And Conditions | text |
| Memo | text |
| Attachments | array |
| Invoice Number | text |
| Invoice Date | text |
| Payment Term | object |
| Metadata | object |
| Id | text |
| Parent Id | text |
| Status | choice |
| Invoicer | object |
| Business Name | text |
| Name | object |
| Address | object |
| Email Address | text |
| Phones | array |
| Website | text |
| Tax Id | text |
| Additional Notes | text |
| Logo Url | text |
| Primary Recipients | array |
| Primary Recipients | object |
| Additional Recipients | array |
| Item | text |
| Items | array |
| Items | object |
| Configuration | object |
| Tax Calculated After Discount | boolean |
| Tax Inclusive | boolean |
| Allow Tip | boolean |
| Partial Payment | object |
| Has Conditional Rule | boolean |
| Template Id | choice |
| Amount | object |
| Currency Code | text |
| Value | text |
| Breakdown | object |
| Due Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
| Gratuity | object |
Currency CodeRequired | text |
ValueRequired | text |
| Payments | object |
| Paid Amount | object |
| Transactions | array |
| Refunds | object |
| Refund Amount | object |
| Transactions | array |
| Links | array |
| Links | object |
Watch PayPal EventsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | text |
| Create Time | date |
| Resource Type | text |
| Event Type | text |
| Summary | text |
| Resource | text |
| Links | array |
Watch SubscriptionsTrigger
No fields documented.
Find Eligible Payment MethodsSearch
Input fields[3]
| Field | Type |
|---|---|
| Customer | object |
| Country Code | text |
| Channel | object |
| Id | text |
| text | |
| Phone | object |
| Purchase Units | array |
| Purchase Units | object |
| Preferences | object |
| Payment Flow | choice |
| Include Account Details | boolean |
| Include Vault Tokens | boolean |
| Payment Source Constraint | object |
Output fields[3]
| Field | Type |
|---|---|
| Eligible Methods | object |
| Paypal | object |
| Venmo | object |
| Paypal Credit | object |
| Paypal Pay Later | object |
| Payment Tokens | array |
| Payment Tokens | object |
Get Authorized PaymentSearch
Input fields[3]
| Field | Type |
|---|---|
Authorization IdRequired | text |
Output fields[3]
| Field | Type |
|---|---|
| Status | choice |
| Status Details | object |
| Reason | choice |
| Id | text |
| Amount | object |
Gross AmountRequired | object |
| Total Item Amount | object |
| Fee Amount | object |
| Shipping Amount | object |
| Tax Amount | object |
| Net Amount | object |
| Invoice Id | choice |
| Custom Id | text |
| Network Transaction Reference | object |
| Id | text |
| Date | text |
| Network | object |
| Acquirer Reference Number | text |
| Seller Protection | object |
| Status | choice |
| Dispute Categories | array |
| Expiration Time | object |
| Links | array |
| Links | object |
| Create Time | object |
| Update Time | object |
| Supplementary Data | object |
| Related Ids | object |
| Payee | object |
| Email Address | object |
| Merchant Id | object |
Get Captured PaymentSearch
Input fields[3]
| Field | Type |
|---|---|
Capture IdRequired | text |
Output fields[3]
| Field | Type |
|---|---|
| Status | choice |
| Status Details | object |
| Reason | choice |
| Id | text |
| Amount | object |
Gross AmountRequired | object |
| Total Item Amount | object |
| Fee Amount | object |
| Shipping Amount | object |
| Tax Amount | object |
| Net Amount | object |
| Invoice Id | choice |
| Custom Id | text |
| Network Transaction Reference | object |
| Id | text |
| Date | text |
| Network | object |
| Acquirer Reference Number | text |
| Seller Protection | object |
| Status | choice |
| Dispute Categories | array |
| Final Capture | boolean |
| Seller Receivable Breakdown | object |
Gross AmountRequired | object |
| Paypal Fee | object |
| Paypal Fee In Receivable Currency | object |
| Net Amount | object |
| Receivable Amount | object |
| Exchange Rate | object |
| Platform Fees | array |
| Disbursement Mode | object |
| Links | array |
| Links | object |
| Processor Response | object |
| Avs Code | choice |
| Cvv Code | choice |
| Response Code | choice |
| Payment Advice Code | choice |
| Create Time | object |
| Update Time | object |
| Supplementary Data | object |
| Related Ids | object |
| Payee | object |
| Email Address | object |
| Merchant Id | object |
Get InvoiceSearch
Input fields[3]
| Field | Type |
|---|---|
Invoice IdRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
DetailRequired | object |
Currency CodeRequired | text |
| Reference | text |
| Note | text |
| Terms And Conditions | text |
| Memo | text |
| Attachments | array |
| Invoice Number | text |
| Invoice Date | text |
| Payment Term | object |
| Metadata | object |
| Id | text |
| Parent Id | text |
| Status | choice |
| Invoicer | object |
| Business Name | text |
| Name | object |
| Address | object |
| Email Address | text |
| Phones | array |
| Website | text |
| Tax Id | text |
| Additional Notes | text |
| Logo Url | text |
| Primary Recipients | array |
| Primary Recipients | object |
| Additional Recipients | array |
| Item | text |
| Items | array |
| Items | object |
| Configuration | object |
| Tax Calculated After Discount | boolean |
| Tax Inclusive | boolean |
| Allow Tip | boolean |
| Partial Payment | object |
| Has Conditional Rule | boolean |
| Template Id | choice |
| Amount | object |
| Currency Code | text |
| Value | text |
| Breakdown | object |
| Due Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
| Gratuity | object |
Currency CodeRequired | text |
ValueRequired | text |
| Payments | object |
| Paid Amount | object |
| Transactions | array |
| Refunds | object |
| Refund Amount | object |
| Transactions | array |
| Links | array |
| Links | object |
Get Invoice Connection StatusSearch
Get Invoice TemplateSearch
Input fields[3]
| Field | Type |
|---|---|
Template IdRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Default Template | boolean |
| Template Info | object |
| Detail | object |
| Invoicer | object |
| Primary Recipients | array |
| Additional Recipients | array |
| Items | array |
| Configuration | object |
| Amount | object |
| Due Amount | object |
| Settings | object |
| Template Item Settings | array |
| Template Subtotal Settings | array |
| Unit Of Measure | choice |
| Standard Template | boolean |
| Links | array |
| Links | object |
Get OrderSearch
Input fields[3]
| Field | Type |
|---|---|
IdRequired | text |
Output fields[3]
| Field | Type |
|---|---|
| Create Time | object |
| Update Time | object |
| Id | text |
| Payment Source | object |
| Card | object |
| Intent | object |
| Payer | object |
| Email Address | text |
| Payer Id | text |
| Name | object |
| Phone | object |
| Birth Date | object |
| Tax Info | object |
| Address | object |
| Purchase Units | array |
| Purchase Units | object |
| Status | object |
| Links | array |
| Links | object |
Get Payout BatchSearch
Input fields[3]
| Field | Type |
|---|---|
IdRequired | text |
Output fields[3]
| Field | Type |
|---|---|
| Total Items | number |
| Total Pages | number |
| Batch Header | object |
Payout Batch IdRequired | text |
Batch StatusRequired | choice |
Sender Batch HeaderRequired | object |
| Time Created | date |
| Time Completed | date |
| Time Closed | date |
| Funding Source | choice |
| Amount | object |
| Fees | object |
| Items | array |
| Items | object |
| Links | array |
| Links | object |
Get Payout ItemSearch
Input fields[3]
| Field | Type |
|---|---|
Payout Item IdRequired | text |
Output fields[3]
| Field | Type |
|---|---|
Payout Item IdRequired | text |
Payout Batch IdRequired | text |
Payout ItemRequired | object |
AmountRequired | object |
ReceiverRequired | text |
| Recipient Type | choice |
| Note | text |
| Sender Item Id | text |
| Recipient Name | object |
| Recipient Wallet | choice |
| Purpose | choice |
| Transaction Id | text |
| Activity Id | text |
| Transaction Status | choice |
| Payout Item Fee | object |
CurrencyRequired | text |
ValueRequired | text |
| Sender Batch Id | text |
| Currency Conversion | object |
| From Amount | object |
| To Amount | object |
| Exchange Rate | text |
| Time Processed | date |
| Errors | object |
NameRequired | text |
MessageRequired | text |
Debug IdRequired | text |
| Information Link | text |
| Details | array |
| Links | array |
| Links | array |
| Links | object |
Get PlanSearch
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Id | text |
| Product Id | choice |
| Name | text |
| Status | choice |
| Description | text |
| Billing Cycles | array |
| Billing Cycles | object |
| Payment Preferences | object |
| Auto Bill Outstanding | boolean |
| Setup Fee | object |
| Setup Fee Failure Action | choice |
| Payment Failure Threshold | number |
| Taxes | object |
PercentageRequired | text |
| Inclusive | boolean |
| Quantity Supported | boolean |
| Create Time | text |
| Update Time | text |
| Links | array |
| Links | object |
Get ProductSearch
Get RefundSearch
Input fields[3]
| Field | Type |
|---|---|
Refund IdRequired | text |
Output fields[3]
| Field | Type |
|---|---|
| Status | choice |
| Status Details | object |
| Reason | choice |
| Id | text |
| Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
| Invoice Id | choice |
| Custom Id | text |
| Acquirer Reference Number | text |
| Note To Payer | text |
| Seller Payable Breakdown | object |
| Gross Amount | object |
| Paypal Fee | object |
| Paypal Fee In Receivable Currency | object |
| Net Amount | object |
| Net Amount In Receivable Currency | object |
| Platform Fees | array |
| Net Amount Breakdown | array |
| Total Refunded Amount | object |
| Payer | object |
| Email Address | object |
| Merchant Id | object |
| Links | array |
| Links | object |
| Create Time | object |
| Update Time | object |
Get SubscriptionSearch
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Output fields[3]
| Field | Type |
|---|---|
| Status | choice |
| Status Change Note | text |
| Status Update Time | text |
| Id | text |
| Plan Id | choice |
| Start Time | text |
| Quantity | text |
| Shipping Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
| Subscriber | object |
| Email Address | text |
| Payer Id | text |
| Name | object |
| Phone | object |
| Shipping Address | object |
| Payment Source | object |
| Billing Info | object |
Outstanding BalanceRequired | object |
Failed Payments CountRequired | number |
| Cycle Executions | array |
| Last Payment | object |
| Next Billing Time | text |
| Final Payment Time | text |
| Last Failed Payment | object |
| Create Time | text |
| Update Time | text |
| Custom Id | text |
| Plan Overridden | boolean |
| Plan | object |
| Product Id | choice |
| Name | text |
| Description | text |
| Billing Cycles | array |
| Payment Preferences | object |
| Taxes | object |
| Quantity Supported | boolean |
| Links | array |
| Links | object |
List Accounting ConnectionsSearch
List Invoice TemplatesSearch
Input fields[3]
| Field | Type |
|---|---|
LimitRequired | number |
Output fields[3]
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Default Template | boolean |
| Template Info | object |
| Detail | object |
| Invoicer | object |
| Primary Recipients | array |
| Additional Recipients | array |
| Items | array |
| Configuration | object |
| Amount | object |
| Due Amount | object |
| Settings | object |
| Template Item Settings | array |
| Template Subtotal Settings | array |
| Unit Of Measure | choice |
| Standard Template | boolean |
| Links | array |
| Links | object |
List InvoicesSearch
Input fields[3]
| Field | Type |
|---|---|
LimitRequired | number |
Output fields[3]
| Field | Type |
|---|---|
DetailRequired | object |
Currency CodeRequired | text |
| Reference | text |
| Note | text |
| Terms And Conditions | text |
| Memo | text |
| Attachments | array |
| Invoice Number | text |
| Invoice Date | text |
| Payment Term | object |
| Metadata | object |
| Id | text |
| Parent Id | text |
| Status | choice |
| Invoicer | object |
| Business Name | text |
| Name | object |
| Address | object |
| Email Address | text |
| Phones | array |
| Website | text |
| Tax Id | text |
| Additional Notes | text |
| Logo Url | text |
| Primary Recipients | array |
| Primary Recipients | object |
| Additional Recipients | array |
| Item | text |
| Items | array |
| Items | object |
| Configuration | object |
| Tax Calculated After Discount | boolean |
| Tax Inclusive | boolean |
| Allow Tip | boolean |
| Partial Payment | object |
| Has Conditional Rule | boolean |
| Template Id | choice |
| Amount | object |
| Currency Code | text |
| Value | text |
| Breakdown | object |
| Due Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
| Gratuity | object |
Currency CodeRequired | text |
ValueRequired | text |
| Payments | object |
| Paid Amount | object |
| Transactions | array |
| Refunds | object |
| Refund Amount | object |
| Transactions | array |
| Links | array |
| Links | object |
List PlansSearch
Input fields[3]
| Field | Type |
|---|---|
LimitRequired | number |
Output fields[3]
| Field | Type |
|---|---|
| Id | text |
| Product Id | choice |
| Name | text |
| Status | choice |
| Description | text |
| Billing Cycles | array |
| Billing Cycles | object |
| Payment Preferences | object |
| Auto Bill Outstanding | boolean |
| Setup Fee | object |
| Setup Fee Failure Action | choice |
| Payment Failure Threshold | number |
| Taxes | object |
PercentageRequired | text |
| Inclusive | boolean |
| Quantity Supported | boolean |
| Create Time | text |
| Update Time | text |
| Links | array |
| Links | object |
List ProductsSearch
List Subscription TransactionsSearch
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Start TimeRequired | date |
End TimeRequired | date |
LimitRequired | number |
Output fields[3]
| Field | Type |
|---|---|
IdRequired | text |
Amount With BreakdownRequired | object |
Gross AmountRequired | object |
| Total Item Amount | object |
| Fee Amount | object |
| Shipping Amount | object |
| Tax Amount | object |
| Net Amount | object |
TimeRequired | text |
| Status | choice |
| Payer Name | object |
| Prefix | text |
| Given Name | text |
| Surname | text |
| Middle Name | text |
| Suffix | text |
| Full Name | text |
| Payer Email | text |
List SubscriptionsSearch
Input fields[3]
| Field | Type |
|---|---|
| List envelope | text |
Search InvoicesSearch
Input fields[3]
| Field | Type |
|---|---|
| Recipient Email | text |
| Recipient First Name | text |
| Recipient Last Name | text |
| Recipient Business Name | text |
| Invoice Number | text |
| Status | array |
| Item | text |
| Reference | text |
| Currency Code | text |
| Memo | text |
| Total Amount Range | object |
Lower AmountRequired | object |
Upper AmountRequired | object |
| Invoice Date Range | object |
StartRequired | text |
EndRequired | text |
| Due Date Range | object |
StartRequired | text |
EndRequired | text |
| Payment Date Range | object |
StartRequired | text |
EndRequired | text |
| Creation Date Range | object |
StartRequired | text |
EndRequired | text |
| Archived | boolean |
| Fields | array |
| Item | text |
LimitRequired | number |
Output fields[3]
| Field | Type |
|---|---|
DetailRequired | object |
Currency CodeRequired | text |
| Reference | text |
| Note | text |
| Terms And Conditions | text |
| Memo | text |
| Attachments | array |
| Invoice Number | text |
| Invoice Date | text |
| Payment Term | object |
| Metadata | object |
| Id | text |
| Parent Id | text |
| Status | choice |
| Invoicer | object |
| Business Name | text |
| Name | object |
| Address | object |
| Email Address | text |
| Phones | array |
| Website | text |
| Tax Id | text |
| Additional Notes | text |
| Logo Url | text |
| Primary Recipients | array |
| Primary Recipients | object |
| Additional Recipients | array |
| Item | text |
| Items | array |
| Items | object |
| Configuration | object |
| Tax Calculated After Discount | boolean |
| Tax Inclusive | boolean |
| Allow Tip | boolean |
| Partial Payment | object |
| Has Conditional Rule | boolean |
| Template Id | choice |
| Amount | object |
| Currency Code | text |
| Value | text |
| Breakdown | object |
| Due Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
| Gratuity | object |
Currency CodeRequired | text |
ValueRequired | text |
| Payments | object |
| Paid Amount | object |
| Transactions | array |
| Refunds | object |
| Refund Amount | object |
| Transactions | array |
| Links | array |
| Links | object |
Activate PlanAction
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Activate SubscriptionAction
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
| Reason | text |
Add Order TrackingAction
Input fields[3]
| Field | Type |
|---|---|
IdRequired | text |
Tracking NumberRequired | text |
CarrierRequired | choice |
Capture IdRequired | text |
| Carrier Name Other | text |
| Notify Payer | boolean |
| Items | array |
| Items | object |
Output fields[3]
| Field | Type |
|---|---|
| Create Time | object |
| Update Time | object |
| Id | text |
| Payment Source | object |
| Card | object |
| Intent | object |
| Payer | object |
| Email Address | text |
| Payer Id | text |
| Name | object |
| Phone | object |
| Birth Date | object |
| Tax Info | object |
| Address | object |
| Purchase Units | array |
| Purchase Units | object |
| Status | object |
| Links | array |
| Links | object |
Authorize Order PaymentAction
Cancel Sent InvoiceAction
Input fields[3]
| Field | Type |
|---|---|
Invoice IdRequired | choice |
| Subject | text |
| Note | text |
| Send To Invoicer | boolean |
| Send To Recipient | boolean |
| Additional Recipients | array |
| Item | text |
Cancel SubscriptionAction
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
ReasonRequired | text |
Cancel Unclaimed Payout ItemAction
Input fields[3]
| Field | Type |
|---|---|
Payout Item IdRequired | text |
Output fields[3]
| Field | Type |
|---|---|
Payout Item IdRequired | text |
Payout Batch IdRequired | text |
Payout ItemRequired | object |
AmountRequired | object |
ReceiverRequired | text |
| Recipient Type | choice |
| Note | text |
| Sender Item Id | text |
| Recipient Name | object |
| Recipient Wallet | choice |
| Purpose | choice |
| Transaction Id | text |
| Activity Id | text |
| Transaction Status | choice |
| Payout Item Fee | object |
CurrencyRequired | text |
ValueRequired | text |
| Sender Batch Id | text |
| Currency Conversion | object |
| From Amount | object |
| To Amount | object |
| Exchange Rate | text |
| Time Processed | date |
| Errors | object |
NameRequired | text |
MessageRequired | text |
Debug IdRequired | text |
| Information Link | text |
| Details | array |
| Links | array |
| Links | array |
| Links | object |
Capture Authorized PaymentAction
Input fields[3]
| Field | Type |
|---|---|
Authorization IdRequired | text |
| Invoice Id | choice |
| Note To Payer | text |
| Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
| Final Capture | boolean |
| Payment Instruction | object |
| Platform Fees | array |
| Disbursement Mode | object |
| Payee Pricing Tier Id | text |
| Payee Receivable Fx Rate Id | text |
| Soft Descriptor | text |
Output fields[3]
| Field | Type |
|---|---|
| Status | choice |
| Status Details | object |
| Reason | choice |
| Id | text |
| Amount | object |
Gross AmountRequired | object |
| Total Item Amount | object |
| Fee Amount | object |
| Shipping Amount | object |
| Tax Amount | object |
| Net Amount | object |
| Invoice Id | choice |
| Custom Id | text |
| Network Transaction Reference | object |
| Id | text |
| Date | text |
| Network | object |
| Acquirer Reference Number | text |
| Seller Protection | object |
| Status | choice |
| Dispute Categories | array |
| Final Capture | boolean |
| Seller Receivable Breakdown | object |
Gross AmountRequired | object |
| Paypal Fee | object |
| Paypal Fee In Receivable Currency | object |
| Net Amount | object |
| Receivable Amount | object |
| Exchange Rate | object |
| Platform Fees | array |
| Disbursement Mode | object |
| Links | array |
| Links | object |
| Processor Response | object |
| Avs Code | choice |
| Cvv Code | choice |
| Response Code | choice |
| Payment Advice Code | choice |
| Create Time | object |
| Update Time | object |
| Supplementary Data | object |
| Related Ids | object |
| Payee | object |
| Email Address | object |
| Merchant Id | object |
Capture Order PaymentAction
Input fields[3]
| Field | Type |
|---|---|
IdRequired | text |
| Payment Source | object |
| Card | object |
Output fields[3]
| Field | Type |
|---|---|
| Create Time | object |
| Update Time | object |
| Id | text |
| Payment Source | object |
| Card | object |
| Intent | object |
| Payer | object |
| Email Address | text |
| Payer Id | text |
| Name | object |
| Phone | object |
| Birth Date | object |
| Tax Info | object |
| Address | object |
| Purchase Units | array |
| Purchase Units | object |
| Status | object |
| Links | array |
| Links | object |
Capture Subscription PaymentAction
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
NoteRequired | text |
Capture TypeRequired | choice |
AmountRequired | object |
Currency CodeRequired | text |
ValueRequired | text |
Output fields[3]
| Field | Type |
|---|---|
IdRequired | text |
Amount With BreakdownRequired | object |
Gross AmountRequired | object |
| Total Item Amount | object |
| Fee Amount | object |
| Shipping Amount | object |
| Tax Amount | object |
| Net Amount | object |
TimeRequired | text |
| Status | choice |
| Payer Name | object |
| Prefix | text |
| Given Name | text |
| Surname | text |
| Middle Name | text |
| Suffix | text |
| Full Name | text |
| Payer Email | text |
Confirm OrderAction
Input fields[3]
| Field | Type |
|---|---|
IdRequired | text |
Payment SourceRequired | object |
| Card | object |
| Application Context | object |
| Brand Name | text |
| Locale | object |
| Return Url | text |
| Cancel Url | text |
| Stored Payment Source | object |
Output fields[3]
| Field | Type |
|---|---|
| Create Time | object |
| Update Time | object |
| Id | text |
| Payment Source | object |
| Card | object |
| Intent | object |
| Payer | object |
| Email Address | text |
| Payer Id | text |
| Name | object |
| Phone | object |
| Birth Date | object |
| Tax Info | object |
| Address | object |
| Purchase Units | array |
| Purchase Units | object |
| Status | object |
| Links | array |
| Links | object |
Create Batch PayoutAction
Input fields[3]
| Field | Type |
|---|---|
Sender Batch HeaderRequired | object |
| Sender Batch Id | text |
| Recipient Type | text |
| Email Subject | text |
| Email Message | text |
| Note | text |
ItemsRequired | array |
| Items | object |
Output fields[3]
| Field | Type |
|---|---|
| Batch Header | object |
Batch StatusRequired | choice |
Payout Batch IdRequired | text |
Sender Batch HeaderRequired | object |
| Time Created | date |
| Links | array |
| Links | object |
Create Draft InvoiceAction
Input fields[3]
| Field | Type |
|---|---|
DetailRequired | object |
Currency CodeRequired | text |
| Reference | text |
| Note | text |
| Terms And Conditions | text |
| Memo | text |
| Attachments | array |
| Invoice Number | text |
| Invoice Date | text |
| Payment Term | object |
| Metadata | object |
| Id | text |
| Parent Id | text |
| Status | choice |
| Invoicer | object |
| Business Name | text |
| Name | object |
| Address | object |
| Email Address | text |
| Phones | array |
| Website | text |
| Tax Id | text |
| Additional Notes | text |
| Logo Url | text |
| Primary Recipients | array |
| Primary Recipients | object |
| Additional Recipients | array |
| Item | text |
| Items | array |
| Items | object |
| Configuration | object |
| Tax Calculated After Discount | boolean |
| Tax Inclusive | boolean |
| Allow Tip | boolean |
| Partial Payment | object |
| Has Conditional Rule | boolean |
| Template Id | choice |
| Amount | object |
| Currency Code | text |
| Value | text |
| Breakdown | object |
| Due Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
| Gratuity | object |
Currency CodeRequired | text |
ValueRequired | text |
| Payments | object |
| Paid Amount | object |
| Transactions | array |
| Refunds | object |
| Refund Amount | object |
| Transactions | array |
| Links | array |
| Links | object |
Output fields[3]
| Field | Type |
|---|---|
DetailRequired | object |
Currency CodeRequired | text |
| Reference | text |
| Note | text |
| Terms And Conditions | text |
| Memo | text |
| Attachments | array |
| Invoice Number | text |
| Invoice Date | text |
| Payment Term | object |
| Metadata | object |
| Id | text |
| Parent Id | text |
| Status | choice |
| Invoicer | object |
| Business Name | text |
| Name | object |
| Address | object |
| Email Address | text |
| Phones | array |
| Website | text |
| Tax Id | text |
| Additional Notes | text |
| Logo Url | text |
| Primary Recipients | array |
| Primary Recipients | object |
| Additional Recipients | array |
| Item | text |
| Items | array |
| Items | object |
| Configuration | object |
| Tax Calculated After Discount | boolean |
| Tax Inclusive | boolean |
| Allow Tip | boolean |
| Partial Payment | object |
| Has Conditional Rule | boolean |
| Template Id | choice |
| Amount | object |
| Currency Code | text |
| Value | text |
| Breakdown | object |
| Due Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
| Gratuity | object |
Currency CodeRequired | text |
ValueRequired | text |
| Payments | object |
| Paid Amount | object |
| Transactions | array |
| Refunds | object |
| Refund Amount | object |
| Transactions | array |
| Links | array |
| Links | object |
Create Invoice TemplateAction
Input fields[3]
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Default Template | boolean |
| Template Info | object |
| Detail | object |
| Invoicer | object |
| Primary Recipients | array |
| Additional Recipients | array |
| Items | array |
| Configuration | object |
| Amount | object |
| Due Amount | object |
| Settings | object |
| Template Item Settings | array |
| Template Subtotal Settings | array |
| Unit Of Measure | choice |
| Standard Template | boolean |
| Links | array |
| Links | object |
Output fields[3]
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Default Template | boolean |
| Template Info | object |
| Detail | object |
| Invoicer | object |
| Primary Recipients | array |
| Additional Recipients | array |
| Items | array |
| Configuration | object |
| Amount | object |
| Due Amount | object |
| Settings | object |
| Template Item Settings | array |
| Template Subtotal Settings | array |
| Unit Of Measure | choice |
| Standard Template | boolean |
| Links | array |
| Links | object |
Create OrderAction
Input fields[3]
| Field | Type |
|---|---|
IntentRequired | choice |
Purchase UnitsRequired | array |
| Purchase Units | object |
| Payer | object |
| Email Address | text |
| Payer Id | text |
| Name | object |
| Phone | object |
| Birth Date | object |
| Tax Info | object |
| Address | object |
| Payment Source | object |
| Card | object |
| Application Context | object |
| Brand Name | text |
| Locale | object |
| Landing Page | choice |
| Shipping Preference | choice |
| User Action | choice |
| Payment Method | object |
| Return Url | text |
| Cancel Url | text |
| Stored Payment Source | object |
Output fields[3]
| Field | Type |
|---|---|
| Create Time | object |
| Update Time | object |
| Id | text |
| Payment Source | object |
| Card | object |
| Intent | object |
| Payer | object |
| Email Address | text |
| Payer Id | text |
| Name | object |
| Phone | object |
| Birth Date | object |
| Tax Info | object |
| Address | object |
| Purchase Units | array |
| Purchase Units | object |
| Status | object |
| Links | array |
| Links | object |
Create PlanAction
Input fields[3]
| Field | Type |
|---|---|
NameRequired | text |
Billing CyclesRequired | array |
| Billing Cycles | object |
Payment PreferencesRequired | object |
| Auto Bill Outstanding | boolean |
| Setup Fee | object |
| Setup Fee Failure Action | choice |
| Payment Failure Threshold | number |
Product IdRequired | choice |
| Status | choice |
| Description | text |
| Taxes | object |
PercentageRequired | text |
| Inclusive | boolean |
| Quantity Supported | boolean |
Output fields[3]
| Field | Type |
|---|---|
| Id | text |
| Product Id | choice |
| Name | text |
| Status | choice |
| Description | text |
| Billing Cycles | array |
| Billing Cycles | object |
| Payment Preferences | object |
| Auto Bill Outstanding | boolean |
| Setup Fee | object |
| Setup Fee Failure Action | choice |
| Payment Failure Threshold | number |
| Taxes | object |
PercentageRequired | text |
| Inclusive | boolean |
| Quantity Supported | boolean |
| Create Time | text |
| Update Time | text |
| Links | array |
| Links | object |
Create ProductAction
Create SubscriptionAction
Input fields[3]
| Field | Type |
|---|---|
Plan IdRequired | choice |
| Start Time | text |
| Quantity | text |
| Shipping Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
| Subscriber | object |
| Email Address | text |
| Payer Id | text |
| Name | object |
| Phone | object |
| Shipping Address | object |
| Payment Source | object |
| Auto Renewal | boolean |
| Application Context | object |
Return UrlRequired | text |
Cancel UrlRequired | text |
| Brand Name | text |
| Locale | text |
| Shipping Preference | choice |
| User Action | choice |
| Payment Method | object |
| Custom Id | text |
| Plan | object |
| Billing Cycles | array |
| Payment Preferences | object |
| Taxes | object |
| Merchant Inventory | text |
Output fields[3]
| Field | Type |
|---|---|
| Status | choice |
| Status Change Note | text |
| Status Update Time | text |
| Id | text |
| Plan Id | choice |
| Start Time | text |
| Quantity | text |
| Shipping Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
| Subscriber | object |
| Email Address | text |
| Payer Id | text |
| Name | object |
| Phone | object |
| Shipping Address | object |
| Payment Source | object |
| Billing Info | object |
Outstanding BalanceRequired | object |
Failed Payments CountRequired | number |
| Cycle Executions | array |
| Last Payment | object |
| Next Billing Time | text |
| Final Payment Time | text |
| Last Failed Payment | object |
| Create Time | text |
| Update Time | text |
| Custom Id | text |
| Plan Overridden | boolean |
| Plan | object |
| Product Id | choice |
| Name | text |
| Description | text |
| Billing Cycles | array |
| Payment Preferences | object |
| Taxes | object |
| Quantity Supported | boolean |
| Links | array |
| Links | object |
Deactivate PlanAction
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Delete External Invoice PaymentAction
Input fields[3]
| Field | Type |
|---|---|
Invoice IdRequired | choice |
Transaction IdRequired | text |
Delete External Invoice RefundAction
Input fields[3]
| Field | Type |
|---|---|
Invoice IdRequired | choice |
Transaction IdRequired | text |
Delete InvoiceAction
Input fields[3]
| Field | Type |
|---|---|
Invoice IdRequired | choice |
Delete Invoice TemplateAction
Input fields[3]
| Field | Type |
|---|---|
Template IdRequired | choice |
Generate Invoice NumberAction
Generate Invoice QR CodeAction
Make an API Calluniversal
Reauthorize Authorized PaymentAction
Record Invoice PaymentAction
Record Invoice RefundAction
Refund Captured PaymentAction
Input fields[3]
| Field | Type |
|---|---|
Capture IdRequired | text |
| Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
| Custom Id | text |
| Invoice Id | choice |
| Note To Payer | text |
| Payment Instruction | object |
| Platform Fees | array |
Output fields[3]
| Field | Type |
|---|---|
| Status | choice |
| Status Details | object |
| Reason | choice |
| Id | text |
| Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
| Invoice Id | choice |
| Custom Id | text |
| Acquirer Reference Number | text |
| Note To Payer | text |
| Seller Payable Breakdown | object |
| Gross Amount | object |
| Paypal Fee | object |
| Paypal Fee In Receivable Currency | object |
| Net Amount | object |
| Net Amount In Receivable Currency | object |
| Platform Fees | array |
| Net Amount Breakdown | array |
| Total Refunded Amount | object |
| Payer | object |
| Email Address | object |
| Merchant Id | object |
| Links | array |
| Links | object |
| Create Time | object |
| Update Time | object |
Revise SubscriptionAction
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
| Plan Id | choice |
| Quantity | text |
| Shipping Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
| Shipping Address | object |
| Name | object |
| Type | choice |
| Options | array |
| Address | object |
| Application Context | object |
Return UrlRequired | text |
Cancel UrlRequired | text |
| Brand Name | text |
| Locale | text |
| Shipping Preference | choice |
| Payment Method | object |
| Plan | object |
| Billing Cycles | array |
| Payment Preferences | object |
| Taxes | object |
Output fields[3]
| Field | Type |
|---|---|
| Plan Id | choice |
| Quantity | text |
| Shipping Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
| Shipping Address | object |
| Name | object |
| Type | choice |
| Options | array |
| Address | object |
| Plan | object |
| Billing Cycles | array |
| Payment Preferences | object |
| Taxes | object |
| Plan Overridden | boolean |
| Links | array |
| Links | object |
Send InvoiceAction
Send Invoice ReminderAction
Input fields[3]
| Field | Type |
|---|---|
Invoice IdRequired | choice |
| Subject | text |
| Note | text |
| Send To Invoicer | boolean |
| Send To Recipient | boolean |
| Additional Recipients | array |
| Item | text |
Suspend SubscriptionAction
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
ReasonRequired | text |
Update InvoiceAction
Input fields[3]
| Field | Type |
|---|---|
Invoice IdRequired | choice |
DetailRequired | object |
Currency CodeRequired | text |
| Reference | text |
| Note | text |
| Terms And Conditions | text |
| Memo | text |
| Attachments | array |
| Invoice Number | text |
| Invoice Date | text |
| Payment Term | object |
| Metadata | object |
| Id | text |
| Parent Id | text |
| Status | choice |
| Invoicer | object |
| Business Name | text |
| Name | object |
| Address | object |
| Email Address | text |
| Phones | array |
| Website | text |
| Tax Id | text |
| Additional Notes | text |
| Logo Url | text |
| Primary Recipients | array |
| Primary Recipients | object |
| Additional Recipients | array |
| Item | text |
| Items | array |
| Items | object |
| Configuration | object |
| Tax Calculated After Discount | boolean |
| Tax Inclusive | boolean |
| Allow Tip | boolean |
| Partial Payment | object |
| Has Conditional Rule | boolean |
| Template Id | choice |
| Amount | object |
| Currency Code | text |
| Value | text |
| Breakdown | object |
| Due Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
| Gratuity | object |
Currency CodeRequired | text |
ValueRequired | text |
| Payments | object |
| Paid Amount | object |
| Transactions | array |
| Refunds | object |
| Refund Amount | object |
| Transactions | array |
| Links | array |
| Links | object |
Output fields[3]
| Field | Type |
|---|---|
DetailRequired | object |
Currency CodeRequired | text |
| Reference | text |
| Note | text |
| Terms And Conditions | text |
| Memo | text |
| Attachments | array |
| Invoice Number | text |
| Invoice Date | text |
| Payment Term | object |
| Metadata | object |
| Id | text |
| Parent Id | text |
| Status | choice |
| Invoicer | object |
| Business Name | text |
| Name | object |
| Address | object |
| Email Address | text |
| Phones | array |
| Website | text |
| Tax Id | text |
| Additional Notes | text |
| Logo Url | text |
| Primary Recipients | array |
| Primary Recipients | object |
| Additional Recipients | array |
| Item | text |
| Items | array |
| Items | object |
| Configuration | object |
| Tax Calculated After Discount | boolean |
| Tax Inclusive | boolean |
| Allow Tip | boolean |
| Partial Payment | object |
| Has Conditional Rule | boolean |
| Template Id | choice |
| Amount | object |
| Currency Code | text |
| Value | text |
| Breakdown | object |
| Due Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
| Gratuity | object |
Currency CodeRequired | text |
ValueRequired | text |
| Payments | object |
| Paid Amount | object |
| Transactions | array |
| Refunds | object |
| Refund Amount | object |
| Transactions | array |
| Links | array |
| Links | object |
Update Invoice TemplateAction
Input fields[3]
| Field | Type |
|---|---|
Template IdRequired | choice |
| Id | text |
| Name | text |
| Default Template | boolean |
| Template Info | object |
| Detail | object |
| Invoicer | object |
| Primary Recipients | array |
| Additional Recipients | array |
| Items | array |
| Configuration | object |
| Amount | object |
| Due Amount | object |
| Settings | object |
| Template Item Settings | array |
| Template Subtotal Settings | array |
| Unit Of Measure | choice |
| Standard Template | boolean |
| Links | array |
| Links | object |
Output fields[3]
| Field | Type |
|---|---|
| Id | text |
| Name | text |
| Default Template | boolean |
| Template Info | object |
| Detail | object |
| Invoicer | object |
| Primary Recipients | array |
| Additional Recipients | array |
| Items | array |
| Configuration | object |
| Amount | object |
| Due Amount | object |
| Settings | object |
| Template Item Settings | array |
| Template Subtotal Settings | array |
| Unit Of Measure | choice |
| Standard Template | boolean |
| Links | array |
| Links | object |
Update OrderAction
Input fields[3]
| Field | Type |
|---|---|
IdRequired | text |
Patch OperationsRequired | array |
| Operation | object |
Update Order TrackingAction
Input fields[3]
| Field | Type |
|---|---|
IdRequired | text |
Tracker IdRequired | text |
Patch OperationsRequired | array |
| Operation | object |
Update PlanAction
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Patch OperationsRequired | array |
| Operation | object |
Update Plan PricingAction
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Pricing SchemesRequired | array |
| Pricing Schemes | object |
Update ProductAction
Input fields[3]
| Field | Type |
|---|---|
Product IdRequired | choice |
Patch OperationsRequired | array |
| Operation | object |
Update SubscriptionAction
Input fields[3]
| Field | Type |
|---|---|
IdRequired | choice |
Patch OperationsRequired | array |
| Operation | object |
Void Authorized PaymentAction
Input fields[3]
| Field | Type |
|---|---|
Authorization IdRequired | text |
Output fields[3]
| Field | Type |
|---|---|
| Status | choice |
| Status Details | object |
| Reason | choice |
| Id | text |
| Amount | object |
Gross AmountRequired | object |
| Total Item Amount | object |
| Fee Amount | object |
| Shipping Amount | object |
| Tax Amount | object |
| Net Amount | object |
| Invoice Id | choice |
| Custom Id | text |
| Network Transaction Reference | object |
| Id | text |
| Date | text |
| Network | object |
| Acquirer Reference Number | text |
| Seller Protection | object |
| Status | choice |
| Dispute Categories | array |
| Expiration Time | object |
| Links | array |
| Links | object |
| Create Time | object |
| Update Time | object |
| Supplementary Data | object |
| Related Ids | object |
| Payee | object |
| Email Address | object |
| Merchant Id | object |
Templates
Look for PayPal templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Bling[2]Brazilian ERP and ecommerce back-office platform for invoices, inventory, orders, and contacts.
- BillAccounts-payable and receivable — manage bills, invoices, vendors, and payments.
- CandisAccounts-payable automation for invoices, approvals, and ERP exports.
- bexioBusiness software for small businesses and startups.
- ChargebeeSubscription billing for customers, plans, invoices, and payments.
References
- WEXTL® PayPal Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for PayPal.
- WEXTL® visual workflow builder data.
Last updated: Aug 28, 2026 21:56