Integrate with Stripe

Stripe is a financial platform that allows businesses to accept payments and handle financial operations over the internet.

To enable payments using Stripe, perform the following tasks:

1. Obtain a Stripe API key
2. Subscribe to Stripe checkout events
3. Configure the Stripe gateway
4. Define payment methods
5. Confirm event delivery

Before you begin

• To obtain a Stripe API key, sign up and create a Stripe account.
• To integrate with DreamApply, your account must have the Superuser role or the accounting-gateways permission.

Obtain a Stripe API key

To connect DreamApply with Stripe, you need to create and copy a secret API key in your Stripe Dashboard. For detailed instructions, see the Stripe documentation.

Subscribe to Stripe checkout events

To ensure that Stripe successfully communicates payment results and synchronizes payment statuses with DreamApply, you must subscribe to checkout events in the Stripe Dashboard.

1. In the bottom left corner of the Stripe Dashboard, click Developers.

2. Under Workbench, select Webhooks.

   

3. Under Trigger reactions in your integration with Stripe events, click Add destination.

   

4. In the Events from section, select Your account.

5. From the API version list, select the basil or clover version.

   

6. In the Events section, select to listen to all Checkout events:

   • checkout.session.async_payment_failed
   • checkout.session.async_payment_succeeded
   • checkout.session.completed
   • checkout.session.expired

7. Click Continue.

   

8. At the Choose where you want to send events step, select Webhook endpoint and click Continue.

   

9. At the Configure destination step, define the following settings:

   • Destination name: Provide a name for the DreamApply destination

   • Endpoint URL: Specify the endpoint to which Stripe checkout events must be sent:

     https://dream-pay.svcs.dreamapply.com/static-notify/stripe

   • Description: Provide the endpoint description

10. Click Create destination.

Configure the Stripe gateway

To configure a Stripe payment gateway in DreamApply:

1. In the main menu, under Finance, select Payment gateways.

2. In the gateway list, select Stripe.

3. Specify the gateway settings:

   1. In the Name field, specify the gateway name. This name will be used for internal reference only and will not be displayed to applicants.

   2. In the Call to action field, specify the text to display on the payment button on financial documents, for example, Pay with Stripe.

   3. In the Invoice series section, select check boxes next to the invoice series that must be processed through the Stripe gateway. If a specific series is not selected, DreamApply will not display the payment button on documents that use this series.

      You can link the same invoice series to several payment gateways to allow applicants to choose their preferred payment option.

   4. In the Stripe API Key field, specify the secret API key you created in the Stripe Dashboard.

4. At the top of the form, click Save changes.

Define payment methods

To define which payment methods applicants can use when paying with Stripe, you must enable them in your Stripe Dashboard. DreamApply will display the methods you activated to applicants at checkout. For details, see the Stripe documentation.

Confirm event delivery

After setting up the gateway, we recommend performing one or more test payments to verify that the integration works and DreamApply receives the checkout events.

1. In the bottom left corner of the Stripe Dashboard, click Developers.
2. Under Workbench, select Webhooks.
3. Use the Overview and Event deliveries tabs to confirm that Stripe events are successfully delivered to DreamApply.

Payment processing

Stripe follows a synchronous payment processing model. When an applicant completes the payment, Stripe immediately sends a confirmation back to DreamApply, and DreamApply updates the payment status in real time.