Integration with PayPal

PayPal is a service that allows you to manage online payments.

Integration with PayPal allows you to make a payment link through PayPal. After you pay the bill, the payment status automatically changes in RetailCRM. If necessary, you can also arrange a refund for an order in RetailCRM. The payment link can be sent via SMS, e-mail or sent to the customer in a more convenient way, such as through chats and messengers.

The integration is available if at least one of the following countries is enabled: Spain, Peru, United States, Chile, Great Britain, Mexico, Bolivia, Japan, Germany, Colombia, Ecuador, Peru, Argentina, India, Brazil, Portugal, China.

The PayPal currency must match the currency selected in RetailCRM.

Configuration of the integration

To connect PayPal, you must have a verified PayPal account. You have to fill in all the company details, bank details, etc..

Once you sign the contract and have the operating account, you will be able to connect it with RetailCRM.

Before connecting PayPal, go to your RetailCRM account (for example: and access Settings > Integration > API Access Keys and create a new API key.

Select the store and the following methods:



To start the integration with PayPal, click on the PayPal icon in the Marketplace widget. After clicking the "Connect" button, you will be redirected to the Connection page, where you have to enter the previously created API key and the URL of your RetailCRM account.

After saving the changes, you will be redirected to the settings page. Go to the “Accounts” section and enter the “Client id” and “Secret key” to add an account.

Note: to get the “Client id” and “Secret key”go to your PayPal account. Under My Apps & Credentials > Dashboard > click on Create App.

Create App Name and Sandbox developer account, and click on “Create App” button.

Then switch on Live tab. There you will find “Client id” and “Secret key”

After adding the keys to the system, click on save and the settings page will be updated where the connected account appears, the store name and the option to “Confirm manually”.

Confirm manually: this option serves to avoid an erroneous payment and do not have to make the money back. It will allow you to confirm if you want to receive this payment or reject it in each order below the link.

Note: if this option is disabled, all payments will be accepted automatically. To cancel the payment, you will have to make a refund (return).

The “Sandbox" field is configured via PayPal. It helps you to know if you are using the test or production account.

Below the table with the list of connected accounts, there is a link for the configuration of payment methods within your system.

Add payment method for PayPal

After the integration with PayPal, go to the Data books > Payment types section and click on the "Add" button to create a payment type and connect it with the integration.

In the "Integrate with" section, you have to select the PayPal account that you previously connected. After saving the configurations, this field can no longer be modified.

Remember that a new payment method must be created for each connected store.

If this is the first time that you have connected a payment method to the directory, you must configure the invoice statuses.

When connecting any payment module later on, these status settings will already apply. If it’s necessary, this link can be edited.

Clicking the "Configure" button in the "Invoice statuses" section opens a pop-up window, allowing you to configure the status link.

If the existing statutes are not appropriate, you can create new ones from this section. To do this, provide the status you want to link and click the “Add new payment status” button.

Remember that the statuses created from the pop-up window are also available in the "Payment statuses" section.

For more information about payment statuses, see the corresponding article.

Work with PayPal in an order card

When everything is already set up in the “Payments” block, PayPal payment will be available.

You will have the option to generate the link after saving a created order.

Once the link is generated, you will receive the following information:

After clicking through the link, the customer will be redirected to the payment window.

When the payment is made successfully, in the order, the payment status is updated according to the link that was created previously and in the field Sum and Paid date the updated data.

If you want to make a refund, you can do it from the same order form by selecting the "Obtain a refund” button.

Once the refund is confirmed, the status of the payment will be updated.

Page last modified on April 07, 2021, at 05:18 PM