About this integration
Payments, invoices, payouts, and subscriptions — create and capture orders, send invoices, run batch payouts, and watch PayPal events.
There are 3 triggers, 21 search modules and 43 actions available. The integration connects via oauth authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for Client ID, Client Secret, and Environment.
Prefer the interactive builder form? Open it on the app page.
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
| Field | Type | Help |
|---|---|---|
Client IDRequired | text | Apps & Credentials → REST API app → Client ID. |
Client SecretRequired | password | Same app → Secret. Treat it like a password. |
EnvironmentRequired | select | Sandbox host api-m.sandbox.paypal.com; live api-m.paypal.com. Separate credentials per environment. |
Use it in workflow automation
Start with Watch Invoices, then add Activate Plan.
Triggers, searches and actions
Open any PayPal trigger, search, or action to see its inputs and outputs — 3 triggers, 21 searchs, 43 actions.
Triggers
Use one of 3 triggers to kick off a workflow as soon as an event occurs in the app.
- Watch Invoices
- Watch PayPal Events
- Watch Subscriptions
Searches
This integration includes 21 search modules for looking data up mid-run.
- Find Eligible Payment Methods
- Get Authorized Payment
- Get Captured Payment
- Get Invoice
- Get Invoice Connection Status
16more searches
Actions
Take action during a run with 43 available modules that write data back into the app.
- Activate Plan
- Activate Subscription
- Add Order Tracking
- Authorize Order Payment
- Cancel Sent Invoice
38more actions
Explore the fields available for each PayPal trigger, search, and action.
Triggers
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Event TypesRequired | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Create Time | date |
Resource Type | text |
Event Type | text |
Summary | text |
Resource | text |
Links | array |
No fields documented.
Searches
Input fields
| Field | Type |
|---|---|
Customer | object |
Country Code | text |
Channel | object |
Id | text |
Email | 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
| Field | Type |
|---|---|
Eligible Methods | object |
Paypal | object |
Venmo | object |
Paypal Credit | object |
Paypal Pay Later | object |
Payment Tokens | array |
Payment Tokens | object |
Input fields
| Field | Type |
|---|---|
Authorization IdRequired | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Capture IdRequired | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IdRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
IdRequired | choice |
Output fields
| Field | Type |
|---|---|
Id | text |
Connection Status | array |
Connection Status | object |
Input fields
| Field | Type |
|---|---|
Template IdRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
IdRequired | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
IdRequired | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Payout Item IdRequired | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
IdRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Product IdRequired | choice |
Output fields
| Field | Type |
|---|---|
Id | text |
Name | text |
Description | text |
Type | choice |
Category | choice |
Image Url | text |
Home Url | text |
Create Time | text |
Update Time | text |
Links | array |
Links | object |
Input fields
| Field | Type |
|---|---|
Refund IdRequired | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
IdRequired | choice |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
Platform Name | text |
Last Sync Time | text |
Last Sync Status | choice |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
LimitRequired | number |
Output fields
| Field | Type |
|---|---|
Id | text |
Name | text |
Description | text |
Create Time | text |
Links | array |
Links | object |
Input fields
| Field | Type |
|---|---|
List envelope | text |
Input fields
| Field | Type |
|---|---|
IdRequired | choice |
Start TimeRequired | date |
End TimeRequired | date |
LimitRequired | number |
Output fields
| 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 |
Input fields
| 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
| 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 |
Actions
Input fields
| Field | Type |
|---|---|
IdRequired | choice |
Input fields
| Field | Type |
|---|---|
IdRequired | choice |
Reason | text |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
IdRequired | text |
Payment Source | object |
Card | object |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IdRequired | choice |
Subject | text |
Note | text |
Send To Invoicer | boolean |
Send To Recipient | boolean |
Additional Recipients | array |
Item | text |
Input fields
| Field | Type |
|---|---|
IdRequired | choice |
ReasonRequired | text |
Input fields
| Field | Type |
|---|---|
Payout Item IdRequired | text |
Output fields
| 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 |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
IdRequired | text |
Payment Source | object |
Card | object |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
IdRequired | choice |
NoteRequired | text |
Capture TypeRequired | choice |
AmountRequired | object |
Currency CodeRequired | text |
ValueRequired | text |
Output fields
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| Field | Type |
|---|---|
Batch Header | object |
Batch StatusRequired | choice |
Payout Batch IdRequired | text |
Sender Batch HeaderRequired | object |
Time Created | date |
Links | array |
Links | object |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
TypeRequired | choice |
Id | text |
Description | text |
Category | choice |
Image Url | text |
Home Url | text |
Output fields
| Field | Type |
|---|---|
Id | text |
Name | text |
Description | text |
Type | choice |
Category | choice |
Image Url | text |
Home Url | text |
Create Time | text |
Update Time | text |
Links | array |
Links | object |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
IdRequired | choice |
Input fields
| Field | Type |
|---|---|
Invoice IdRequired | choice |
Transaction IdRequired | text |
Input fields
| Field | Type |
|---|---|
Invoice IdRequired | choice |
Transaction IdRequired | text |
Input fields
| Field | Type |
|---|---|
Invoice IdRequired | choice |
Input fields
| Field | Type |
|---|---|
Template IdRequired | choice |
Input fields
| Field | Type |
|---|---|
Fetch Id | boolean |
Output fields
| Field | Type |
|---|---|
Invoice Number | text |
Invoice Id | choice |
Input fields
| Field | Type |
|---|---|
Invoice IdRequired | choice |
Width | number |
Height | number |
Action | text |
Output fields
| Field | Type |
|---|---|
QR Code | text |
Input fields
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
Output fields
| Field | Type |
|---|---|
Body | text |
Headers | text |
Status Code | number |
Input fields
| Field | Type |
|---|---|
Authorization IdRequired | text |
Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
Output fields
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IdRequired | choice |
MethodRequired | choice |
Type | choice |
Payment Id | text |
Payment Date | text |
Note | text |
Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
Shipping Info | object |
Business Name | text |
Name | object |
Address | object |
Output fields
| Field | Type |
|---|---|
Payment Id | text |
Input fields
| Field | Type |
|---|---|
Invoice IdRequired | choice |
MethodRequired | choice |
Type | choice |
Refund Id | text |
Refund Date | text |
Amount | object |
Currency CodeRequired | text |
ValueRequired | text |
Output fields
| Field | Type |
|---|---|
Refund Id | text |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
Invoice IdRequired | choice |
Subject | text |
Note | text |
Send To Invoicer | boolean |
Send To Recipient | boolean |
Additional Recipients | array |
Item | text |
Output fields
| Field | Type |
|---|---|
HrefRequired | text |
RelRequired | text |
Method | choice |
Input fields
| Field | Type |
|---|---|
Invoice IdRequired | choice |
Subject | text |
Note | text |
Send To Invoicer | boolean |
Send To Recipient | boolean |
Additional Recipients | array |
Item | text |
Input fields
| Field | Type |
|---|---|
IdRequired | choice |
ReasonRequired | text |
Input fields
| 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
| 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 |
Input fields
| 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
| 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 |
Input fields
| Field | Type |
|---|---|
IdRequired | text |
Patch OperationsRequired | array |
Operation | object |
Input fields
| Field | Type |
|---|---|
IdRequired | text |
Tracker IdRequired | text |
Patch OperationsRequired | array |
Operation | object |
Input fields
| Field | Type |
|---|---|
IdRequired | choice |
Patch OperationsRequired | array |
Operation | object |
Input fields
| Field | Type |
|---|---|
IdRequired | choice |
Pricing SchemesRequired | array |
Pricing Schemes | object |
Input fields
| Field | Type |
|---|---|
Product IdRequired | choice |
Patch OperationsRequired | array |
Operation | object |
Input fields
| Field | Type |
|---|---|
IdRequired | choice |
Patch OperationsRequired | array |
Operation | object |
Input fields
| Field | Type |
|---|---|
Authorization IdRequired | text |
Output fields
| 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 |