Invoicing & IPN, by www.entegrations.io (Preview)

entegrations.io custom connector on Microsoft Flow for Invoicing, Payouts and IPN data that leverages your PayPal account. Invoicing feature allows creating and sending invoices to a receiver via PayPal platform. Payouts feature allows sending Payouts to one or more receivers via PayPal platform. IPN feature allows receiving PayPal IPN data. All these 3 features work by proxying thru a third-party i.e. entegrations.io. You would need credentials before you could use this custom connector. For this, you would need to go thru a one-time PayPal authorization and to allow us to create Invoices or Payouts on your behalf. Visit https://portal.entegrations.io/portal/index.html for onboarding instructions. As part of onboarding, you would get API Key that you could use for the connection while using custom connector on Microsoft Flow.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Flow Premium All Flow regions except the following:
     -   US Government (GCC)
PowerApps Premium All PowerApps regions except the following:
     -   US Government (GCC)

Creating a connection

To connect your account, you will need the following information:

Name Type Description
API Key securestring

The API Key for this api

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Advanced Use: Delete the invoicing, payouts etc webhook

Advanced Use: Deletes the Entegrations.io webhook that corresponds to the PayPal webhook.

Create an invoice

Create a draft PayPal Invoice and immediately sends it as per their APIs https://developer.paypal.com/docs/api/invoicing/v1/#invoices_create and https://developer.paypal.com/docs/api/invoicing/v1/#invoices_send

Create payouts

Create PayPal Payouts as per their API https://developer.paypal.com/docs/api/payments.payouts-batch/v1/#payouts_create

Delete the generic IPN webhook

Deletes the Entegrations.io webhook that corresponds to the PayPal IPN's generic webhook.

Delete the invoice paid webhook

Deletes the Entegrations.io webhook that corresponds to the PayPal Invoice paid webhook.

Delete the IPN's express_checkout completed webhook

Deletes the Entegrations.io webhook that corresponds to the PayPal IPN's express_checkout completed webhook.

Delete the IPN's new_case created webhook

Deletes the Entegrations.io webhook that corresponds to the PayPal IPN's new_case created webhook.

Delete the IPN's recurring_payment completed webhook

Deletes the Entegrations.io webhook that corresponds to the PayPal IPN's recurring_payment completed webhook.

Delete the payouts success webhook

Deletes the Entegrations.io webhook that corresponds to the PayPal Payouts success webhook.

Advanced Use: Delete the invoicing, payouts etc webhook

Advanced Use: Deletes the Entegrations.io webhook that corresponds to the PayPal webhook.

Parameters

Name Key Required Type Description
ID of the Webhook being deleted
webhookId True string

ID of the Webhook being deleted

Create an invoice

Create a draft PayPal Invoice and immediately sends it as per their APIs https://developer.paypal.com/docs/api/invoicing/v1/#invoices_create and https://developer.paypal.com/docs/api/invoicing/v1/#invoices_send

Parameters

Name Key Required Type Description
Bill to email
email True string

Bill to email. This may be an email of reciever's PayPal account.

Billing First name
first_name string

First name

Billing Last name
last_name string

Last name

Discount percent
percent integer

Percent

Item name
name string

Item name

Item Quantity
quantity integer

Quantity

Item Tax type/name
name True string

Tax type/name

Item Tax Percent
percent True integer

Percent

Unit Price Currency
currency True string

Currency

Unit Price Value
value True string

Value

Sender's City
city True string

City

Sender's Country Code
country_code True string

Two character ISO country code.

Sender's Address 1
line1 True string

Line 1 of address.

Sender's Postal Code
postal_code string

Postal Code

Sender's State
state string

State

Sender's business name
business_name string

Sender's business name.

Sender's email
email True string

Sender's email which corresponds to PayPal account.

Sender's first name
first_name string

Sender's first name.

Sender's last name
last_name string

Sender's last name.

Sender's country code of phone
country_code string

Country code of the phone.

Sender's phone number with area code
national_number string

Phone nuber with area code.

Invoice note
note string

Invoice note

Shipping Cost Currency
currency string

Currency

Shipping Cost Value
value string

Value

Shipping City
city string

City

Shipping Country code
country_code string

Country code

Shipping Address 1
line1 string

Line 1 of address.

Shipping Postal code
postal_code string

Postal code

Shipping State
state string

State

Shipping First name
first_name string

First name

Shipping Last name
last_name string

Last name

Invoice terms
terms string

Invoice terms

Returns

Response details including status.

Create payouts

Create PayPal Payouts as per their API https://developer.paypal.com/docs/api/payments.payouts-batch/v1/#payouts_create

Parameters

Name Key Required Type Description
Currency
currency True string

Currency

Value
value True string

Value

Note
note string

Payout item level note.

Receiver (email / payer id / phone)
receiver True string

Receiver's email / PayPal payer_id / phone number.

Receiver Type
recipient_type string

Recipient type. Valid values are either of EMAIL / PAYER_ID / PHONE. Either this value or the one in Payout batch header is mandatory.

Sender's Item ID
sender_item_id string

Sender's Payout Item ID (Should be unique value, in last 30 days, per PayPal).

Sender's email
email True string

Sender's email which corresponds to PayPal account.

Email Subject
email_subject string

Subject of the email notification that would be sent out by PayPal.

Receiver Type
recipient_type string

Recipient type. Valid values are either of EMAIL / PAYER_ID / PHONE. Either this value or the ones in Payout item/details is mandatory.

Sender's Batch ID
sender_batch_id string

Sender's Batch ID (Should be unique value, in last 30 days, per PayPal).

Returns

Delete the generic IPN webhook

Deletes the Entegrations.io webhook that corresponds to the PayPal IPN's generic webhook.

Parameters

Name Key Required Type Description
txnType of the Webhook being deleted
txnType True string

txnType of the Webhook being deleted

txnStatus of the Webhook being deleted
txnStatus True string

txnStatus of the Webhook being deleted

ID of the Webhook being deleted
webhookId True string

ID of the Webhook being deleted

Delete the invoice paid webhook

Deletes the Entegrations.io webhook that corresponds to the PayPal Invoice paid webhook.

Parameters

Name Key Required Type Description
ID of the Webhook being deleted
webhookId True string

ID of the Webhook being deleted

Delete the IPN's express_checkout completed webhook

Deletes the Entegrations.io webhook that corresponds to the PayPal IPN's express_checkout completed webhook.

Parameters

Name Key Required Type Description
ID of the Webhook being deleted
webhookId True string

ID of the Webhook being deleted

Delete the IPN's new_case created webhook

Deletes the Entegrations.io webhook that corresponds to the PayPal IPN's new_case created webhook.

Parameters

Name Key Required Type Description
ID of the Webhook being deleted
webhookId True string

ID of the Webhook being deleted

Delete the IPN's recurring_payment completed webhook

Deletes the Entegrations.io webhook that corresponds to the PayPal IPN's recurring_payment completed webhook.

Parameters

Name Key Required Type Description
ID of the Webhook being deleted
webhookId True string

ID of the Webhook being deleted

Delete the payouts success webhook

Deletes the Entegrations.io webhook that corresponds to the PayPal Payouts success webhook.

Parameters

Name Key Required Type Description
ID of the Webhook being deleted
webhookId True string

ID of the Webhook being deleted

Triggers

Advanced Use: When an IPN (generic) update is received

Advanced Use: Creates an entegrations.io webhook for PayPal IPN event data and it triggers whenever entegrations.io receives an on-behalf-of IPN payload from PayPal. Note that this is default payload, getting you whatever PayPal sends out.

Advanced Use: When invoicing, payouts updates received

Advanced Use: Creates an entegrations.io webhook for PayPal Invoicing, Payouts etc webhooks data and it triggers whenever entegrations.io receives an on-behalf-of webhook payload from PayPal. Note that this is default payload, getting you whatever PayPal sends out.

Whenever an invoice (at PayPal) is paid

Creates an entegrations.io webhook for PayPal Invoicing Paid data and it triggers whenever entegrations.io receives an on-behalf-of webhook payload for Invoice Paid from PayPal.

Whenever Express Checkout payment is completed

Creates an entegrations.io webhook for PayPal express_checkout completed IPN event and it triggers whenever entegrations.io receives an on-behalf-of ipn payload from PayPal.

Whenever New Case is created

Creates an entegrations.io webhook for PayPal new case created IPN event and it triggers whenever entegrations.io receives an on-behalf-of ipn payload from PayPal.

Whenever payouts is paid

Creates an entegrations.io webhook for PayPal Payouts Paid data and it triggers whenever entegrations.io receives an on-behalf-of webhook payload for Payouts Paid from PayPal.

Whenever Recurring Payment is completed

Creates an entegrations.io webhook for PayPal recurring payment completed IPN event and it triggers whenever entegrations.io receives an on-behalf-of ipn payload from PayPal.

Advanced Use: When an IPN (generic) update is received

Advanced Use: Creates an entegrations.io webhook for PayPal IPN event data and it triggers whenever entegrations.io receives an on-behalf-of IPN payload from PayPal. Note that this is default payload, getting you whatever PayPal sends out.

Parameters

Name Key Required Type Description
txn_type of the IPN being created.
txnType True string

txn_type of the IPN being created. Leave all for all txn_types.

txn or payment status of the Webhook being created.
txnStatus True string

txn or payment status of the Webhook being created. Leave all for all statuses.

paypalEmailAddress
paypalEmailAddress True string

Email address of the PayPal account. You must use the same PayPal email address you have used to onboard for the custom connector.

Returns

Advanced Use: When invoicing, payouts updates received

Advanced Use: Creates an entegrations.io webhook for PayPal Invoicing, Payouts etc webhooks data and it triggers whenever entegrations.io receives an on-behalf-of webhook payload from PayPal. Note that this is default payload, getting you whatever PayPal sends out.

Parameters

Name Key Required Type Description
paypalEmailAddress
paypalEmailAddress True string

Email address of the PayPal account. You must use the same PayPal email address you have used to onboard for the custom connector.

Returns

Whenever an invoice (at PayPal) is paid

Creates an entegrations.io webhook for PayPal Invoicing Paid data and it triggers whenever entegrations.io receives an on-behalf-of webhook payload for Invoice Paid from PayPal.

Parameters

Name Key Required Type Description
paypalEmailAddress
paypalEmailAddress True string

Email address of the PayPal account. You must use the same PayPal email address you have used to onboard for the custom connector.

Returns

Whenever Express Checkout payment is completed

Creates an entegrations.io webhook for PayPal express_checkout completed IPN event and it triggers whenever entegrations.io receives an on-behalf-of ipn payload from PayPal.

Parameters

Name Key Required Type Description
paypalEmailAddress
paypalEmailAddress True string

Email address of the PayPal account. You must use the same PayPal email address you have used to onboard for the custom connector.

Returns

Whenever New Case is created

Creates an entegrations.io webhook for PayPal new case created IPN event and it triggers whenever entegrations.io receives an on-behalf-of ipn payload from PayPal.

Parameters

Name Key Required Type Description
paypalEmailAddress
paypalEmailAddress True string

Email address of the PayPal account. You must use the same PayPal email address you have used to onboard for the custom connector.

Returns

Whenever payouts is paid

Creates an entegrations.io webhook for PayPal Payouts Paid data and it triggers whenever entegrations.io receives an on-behalf-of webhook payload for Payouts Paid from PayPal.

Parameters

Name Key Required Type Description
paypalEmailAddress
paypalEmailAddress True string

Email address of the PayPal account. You must use the same PayPal email address you have used to onboard for the custom connector.

Returns

Whenever Recurring Payment is completed

Creates an entegrations.io webhook for PayPal recurring payment completed IPN event and it triggers whenever entegrations.io receives an on-behalf-of ipn payload from PayPal.

Parameters

Name Key Required Type Description
paypalEmailAddress
paypalEmailAddress True string

Email address of the PayPal account. You must use the same PayPal email address you have used to onboard for the custom connector.

Returns

Definitions

EntegrationsInvoice4PayPalCreateResponse

Response details including status.

Name Path Type Description
paypal_invoice_id
details.paypal_invoice_id string

Invoice ID generated by PayPal.

paypal_invoice_number
details.paypal_invoice_number string

Invoice Number generated by PayPal.

errorMessage
errorMessage string

Error message, if there is any error.

status
status string

Status of creating the Invoice. Possible values: success or error.

EntegrationsPayouts4PayPalCreateResponse

Name Path Type Description
paypal_payout_batch_id
details.paypal_payout_batch_id string

Batch ID generated by the PayPal for this Payout.

sender_batch_id
details.sender_batch_id string

Batch ID that was sent in the request (echoing back the same value)

errorMessage
errorMessage string

Error message, if there is any error.

status
status string

Status of creating the Payouts. Possible values: success or error.

EntegrationsWebhook4PayPalDefaultPushResponse

Name Path Type Description
create_time as given by PayPal
create_time string
event_type as given by PayPal
event_type string
ID as given by PayPal
id string
Stringified version of the resource given by PayPal
resouce_json_stringified string
resource as given by PayPal
resource object
resource_type as given by PayPal
resource_type string
summary as given by PayPal
summary string

EntegrationsWebhook4PayPalInvoicingPaidPushResponse

Name Path Type Description
ID as given by PayPal
invoice_paid_paypal_invoice_id string
resource as given by PayPal
invoice_paid_resource object
summary as given by PayPal
invoice_paid_summary string
create_time as given by PayPal
invoice_paid_time string

EntegrationsWebhook4PayPalIpnEcCompletedPushResponse

Name Path Type Description
mc_fee as given by PayPal
mc_fee string
mc_gross as given by PayPal
mc_gross string
payer_email as given by PayPal
payer_email string
payment_date as given by PayPal
payment_date string
txn_id as given by PayPal
txn_id string

EntegrationsWebhook4PayPalIpnNewCaseCreatedPushResponse

Name Path Type Description
buyer_additional_information as given by PayPal
buyer_additional_information string
case_creation_date as given by PayPal
case_creation_date string
case_id as given by PayPal
case_id string
case_type as given by PayPal
case_type string
reason_code as given by PayPal
reason_code string

EntegrationsWebhook4PayPalIpnRecurringPaymentCompletedPushResponse

Name Path Type Description
amount as given by PayPal
amount string
custom value (that you must have used during your integration with PayPal and that's) as given by PayPal
custom string
payer_email as given by PayPal
payer_email string
first and last name, if they are null. Otherwise, the business name. These values are as given by PayPal
payer_full_name string
payment_date as given by PayPal
payment_date string
payment_status as given by PayPal
payment_status string
txn_id as given by PayPal
txn_id string

EntegrationsWebhook4PayPalPayoutsPaidPushResponse

Name Path Type Description
ID as given by PayPal
payouts_batch_success_paypal_payout_batch_id string
resource as given by PayPal
payouts_batch_success_resource object
summary as given by PayPal
payouts_batch_success_summary string
create_time as given by PayPal
payouts_batch_success_time string