1. Home
  2. Docs
  3. Payment Gateways
  4. PayPal Gateway

PayPal Gateway

Configuring the gateway

First, you need to make sure monetization active on your site.  You can activate monetization from Directorist Listings > Directorist Settings >  Monetization Settings and set Enable Monetization Feature to Yes.

Next, go to the Gateway Settings Tab and Configure the following settings: 

  1. Active Gateways: Active gateways will be displayed in the checkout page. Check the PayPal Gateway in this field. Your users now will be able to pay using the PayPal Gateway.
  2. Default Gateway: You can show PayPal as the default gateway in the checkout page. The default gateway will be selected by default. Select the PayPal Gateway in the Default Gateway Dropdown and save the changes. See the screenshots below.
  3. Enabled Test Mode(OPTIONAL): If you want to test the integration of your gateway, then set the “Enable Test Mode” to “Yes“. No live transaction will occur if the test mode is enabled.
    You must disable the test mode to collect payment from users on a live site by setting the “Enable Test Mode” option to “No“.

Next, go to the PayPal Gateway Tab and set your PayPal business email and customize the Title and description of the gateway. The title and description of the gateway will be displayed in the checkout page. See the screenshots below.

Managing Orders

Please go to Directory Listings > Order History to view all of the orders received on your site. You will receive an order when a user submits a listing using a plan(if you are using directorist pricing plans/ Directorist Pricing Plans) or buy the featured listing. An order will have different statuses depending on the type of gateways a user chooses to pay at the checkout process. An order can have one of the following 6 statuses.

  1. Created: When an order created, it will have a “Created” status by default as an initial status.
  2. Pending: You can set this status manually when the payment for an order is pending.
  3. Completed: An order will have this “Completed” status when payment for an order is completed. However, only online gateways like PayPal or Stripe will update the status of an order to “Completed” automatically when the payment is made successfully, but you need to update the order status manually if the gateway is an offline gateway like the bank transfer gateway.
  4. Failed: An order will have this status when a payment fails. You can also set this status to any orders manually. Keep reading to know how to change order status.
  5. Cancelled: When an order is cancelled, it will have this ‘Cancelled’ status. You can cancel any order manually.
  6. Refunded: When you refund the money of an order, it will have this status. An online gateway will update the order status to refunded automatically when a refund is made. However, you need to update the order status manually if you make a refund manually.

When a listing submitted using a plan, the user will land on the checkout page. The user can pay for the plan using an online or an offline gateway. Of course, you need to have one or more online gateways like the Directorist PayPal Gateway or Stripe gateway installed on your site for your users to be able to pay using an online gateway. However, the default gateway available for free with directorist is the Bank Transfer gateway which is an offline gateway.

Online vs Offline Gateway:

An online gateway like PayPal or Stripe can mark the order completed if the payment is successful during the checkout. The purchased plan gets activated upon order completion. All the listings submitted under the activated plan will be visible to the website users.

An offline gateway like the Bank Transfer Gateway will create an order and set the status of the order as “Created”. Then once you receive the payment in your bank account, you should mark the order completed manually. See how to change the status of order below.

How to change an order status manually:

Please go to Directory Listings > Order History page and check the orders you would like to change the status of and select a status from the highlighted box and hit apply. The order will have a new status. For example, we are marking an order status as completed in the example below.