# V5.4.1 - PayPal Integration

#### Released Date - 21 Sep 2022

In this release, we are excited to present to you PayPal as a newly integrated Payment Service Provider (PSP) on your CRM. You can now receive funds with PayPal, debit cards and credit cards, giving your clients a more comprehensive and efficient fund deposit experience. Open up a new deposit stream for your clients by registering and setting up PayPal now!

## <mark style="color:red;">PayPal Integration</mark>&#x20;

### 1)   Marketplace Installation

1. To start offering PayPal as a new deposit method to your clients, you will first need to install it from the CRM marketplace.&#x20;

   <figure><img src="/files/MikmlQuLgk2xNGEqEARq" alt=""><figcaption></figcaption></figure>
2. This function is free for all to use, with no expiry.&#x20;
3. Upon completion of installation, you will see “PayPal Settings” under the “Deposit Settings” module.&#x20;

   <figure><img src="/files/maEFj258izMKOvRa5T9K" alt=""><figcaption></figcaption></figure>

### 2)   Permissions&#x20;

Upon installing PayPal from the CRM Marketplace, you will need to enable the following permissions:

1. Read PayPal Settings
2. Add PayPal Settings
3. Update PayPal Settings
4. Delete PayPal Settings

   <figure><img src="/files/wadjz3OqZ8sjspFd5k0i" alt=""><figcaption></figcaption></figure>

### 3)   Setting up PayPal as a Deposit Method&#x20;

<details>

<summary>Registering for PayPal Account </summary>

1. Register an account via [**https://www.paypal.com/bizsignup/**](https://www.paypal.com/bizsignup/)\
   ![](/files/QcuQRtqmvBt5ntCSub5i)
2. Obtain your Client ID & Secret of your PayPal account&#x20;
   * Log into Dashboard via [**https://developer.paypal.com**](https://developer.paypal.com)<br>

     <figure><img src="/files/UMsGqhL3CSBDpIJ6ExDf" alt=""><figcaption></figcaption></figure>
   * Click “My Apps & Credentials”
   * Fill in your App Name and Select “Create App”<br>

     <figure><img src="/files/hD8VUsgPZF07Fkv1iZSl" alt=""><figcaption></figcaption></figure>
   * Upon creation of your App, you will be able to see your Client ID and Secret.<br>

     <figure><img src="/files/t98G5X96x1z1DMwuLhHS" alt=""><figcaption></figcaption></figure>

</details>

<details>

<summary>Setting up PayPal as a deposit method on CRM</summary>

1. On CRM, go to Deposit Settings > PayPal Settings
2. Create a new PayPal Setting by clicking “Create”

   <figure><img src="/files/aiKRQmiIe2flpGhrg5uq" alt=""><figcaption></figcaption></figure>
3. Fill in the relevant fields:
   * Name&#x20;
     1. Required Field&#x20;
     2. Cannot be repeated&#x20;
   * Client ID&#x20;
     1. Retrieved from PayPal
     2. Can be repeated&#x20;
   * Secret&#x20;
     1. Retrieved from PayPal&#x20;
     2. Cannot be repeated&#x20;
     3. You can create a second secret key on PayPal for the same App Name. However, do take note that there is an expiry to the second secret key. Upon expiry, there will be an invalid secret error reported.
   * Select the currencies you wish to offer to your clients.&#x20;
     1. The currencies supported by PayPal are listed on the CRM.&#x20;
     2. The currencies supported will depend on where your PayPal account is registered. For example, only PayPal accounts registered in China will support CNY as a deposit currency.&#x20;
   * Click “Save”.&#x20;
     1. If successful, there will be a pop-up notice to inform you that PayPal Settings have been created successfully.
     2. If there is an error, there will be a pop-up notice to inform you to that there is an error with your account details. You will need to verify the account details and retry. &#x20;

        <figure><img src="/files/35OFgPGkumTxkoPUGqwH" alt=""><figcaption></figcaption></figure>

        ![](/files/okrltUmJwRL2qOqmABgi)
4. Go to Deposit Settings and create a new Payment Method. You can setup multiple payment methods using the same PayPal account.&#x20;
5. Fill in the relevant fields and save.&#x20;

   By default, all currencies can have a maximum of 2 decimal points.&#x20;

   Exceptions: HUF, JPY & TWD decimal points will be fixed at 0.&#x20;

   <figure><img src="/files/NdTZaU5lL69MAe1N83uM" alt=""><figcaption></figcaption></figure>

</details>

<details>

<summary>Viewing PayPal Settings </summary>

1. You can click the “View” button to view the details for each PayPal Settings.&#x20;

   <figure><img src="/files/zz84gJhbXHgR7KQAzgEh" alt=""><figcaption></figcaption></figure>

</details>

<details>

<summary>Editing PayPal Settings </summary>

1. You can edit your PayPal Settings by clicking the “Edit” button.&#x20;
2. You will not be able to edit the Client ID. The rest of the fields can be amended.&#x20;
3. The changes will be effective once you click “Save”.&#x20;

   <figure><img src="/files/FUq4xubS3ks62OB4pEuc" alt=""><figcaption></figcaption></figure>

</details>

<details>

<summary>Deleting PayPal Settings </summary>

1. You can delete your PayPal Settings by clicking the Delete button.&#x20;

   <figure><img src="/files/bKh1TvrVDi0opnewLfoN" alt=""><figcaption></figcaption></figure>
2. If there is an existing deposit method using the PayPal settings, you will not be able to delete it. You will need to delete the deposit method before deleting the PayPal setting.&#x20;

</details>

### 4)   Client Deposit via PayPal&#x20;

{% tabs %}
{% tab title="Step 1" %}

1. Upon setting up PayPal as a deposit method, your client will be able to deposit via PayPal.&#x20;
2. Client will need to fill in the details and click “Confirm”.&#x20;

   Once client clicks “Confirm”, a deposit request will be submitted to you. <br>

   <figure><img src="/files/QsoRsvgxcTUqZHpWLk2n" alt=""><figcaption></figcaption></figure>

{% endtab %}

{% tab title="Step 2" %}
Client will need to either select “PayPal” or “Debit or Credit Card”.

1. Upon selecting “PayPal”, there will be a popup notification for client to login to their PayPal account to complete the process.
2. Upon selecting “Debit or Credit Card”, Client will need to fill in the card details and click “Pay Now”. Client will be redirected to PayPal to complete the process.
   {% endtab %}

{% tab title="Step 3" %}
Upon successful payment, the Client will be redirected to their request history.

1. Request Status: refers to the status of the deposit request submitted:
   * Pending - pending for you to process the deposit request
   * Approved - deposit request has been approved by you
   * Rejected - deposit request has been rejected by you
2. Payment Status: refers to the callback status of the PayPal payment

   * Pending - pending callback to be received by PayPal
   * Success - callback is successful
   * Failed - callback has failed

   <figure><img src="/files/zf7Hyr8olMNOuObAeQei" alt=""><figcaption></figcaption></figure>

You will receive the deposit request and will be able to approve / reject it accordingly.&#x20;
{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://reference-guide.gitbook.io/crm-version-release-notes/v5.4.1-paypal-integration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.