Name: outlook-payments-nodejs-sample
Owner: Office Developer
Description: A sample Node.js implementation of a payment webhook for Payments in Outlook.
Created: 2018-04-24 14:43:42.0
Updated: 2018-05-23 16:11:22.0
Pushed: 2018-05-23 16:11:43.0
Homepage: null
Size: 34
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
This is an example implementation of the payment request and payment complete webhooks for a Payments in Outlook service.
Prior to running this sample, you must register in the Payments in Outlook dashboard and you must have a Stripe connect platform account.
You must also have Node.js and NPM installed.
Install dependencies with the following command:
install
Run the sample with the following command:
start
When you run the sample locally, it is accessible via http://localhost:3333
. The Payment service must be able to contact your webhook from the internet, so running on localhost won't work. However, by using ngrok, we can create a publicly accessible address that is temporarily able to contact localhost.
Open a command prompt or shell and run the following command:
k http 3333 -host-header=localhost:3333
The output should look similar to this:
k by @inconshreveable (Ctrl+C to quit)
ion Status online
unt Jason Johnston (Plan: Free)
ion 2.2.8
on United States (us)
Interface http://127.0.0.1:4040
arding http://68cd84ed.ngrok.io -> localhost:3333
arding https://68cd84ed.ngrok.io -> localhost:3333
Copy the HTTPS URL from the second Forwarding
entry. In the above output, the URL to copy is https://68cd84ed.ngrok.io
. Using that URL as the base, let's construct two URLs: one to the payment request webhook (ngrok URL + /api/update
), and one to the payment complete webhook (ngrok URL + /api/complete
). For example, using the URL from the example output above:
s://68cd84ed.ngrok.io/api/update
s://68cd84ed.ngrok.io/api/complete
Note:: Leave ngrok running so those URLs remain active.
Update your webhook URLs in the partner dashboard with these URLs for testing.
See Get started with Payments in Outlook for steps to send a test message to yourself.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.