PayPal™ integration

PayPal™ is offered by Viva Wallet as a payment method to all its eligible merchants. This method lets your customers pay you online using PayPal if they wish to do so.

We support the following currencies in PayPal:

There are some merchant categories that PayPal does not allow. These are indicated in the list below.

Merchant Category (MCC) Description
5499 Misc. Food Stores – Convenience Stores and Specialty Markets
5967 Direct Marketing – Inbound Teleservices Merchant
7841 Video Tape Rental Stores

Viva Wallet Smart Checkout supports PayPal with only minor configuration required (i.e. you just need to enable PayPal as a payment option). Once you have followed the setup steps below, your checkout page will include PayPal as an option for your customers to pay with:

PayPal button shown on Smart Checkout

Your customers will be able to click on the PayPal button to display the PayPal popup:

PayPal popup

Payments into your Viva Wallet account using this payment method will be displayed under Sales > Sales Transactions in the normal manner but flagged as PayPal Charge in the Type field.

The integration between Viva Wallet and PayPal will function only if your PayPal Business Account has been fully approved by PayPal and can accept payments.

Setup steps

The steps below explain how to enable PayPal on your live merchant account. Further down is how to do the equivalent in sandbox mode.

Setup steps to enable PayPal as a payment method (live mode)

If you want to integrate with PayPal in production, follow the procedure below:

  1. Sign in to your production Viva Wallet account .

  2. Click on Settings > API Access and scroll down to the PayPal (Payment Method) section.

  3. Click on the Enable PayPal as a payment method button:

    Enable PayPal as a payment method
    A PayPal popup window is displayed.

  4. Do one of the following:

    • If you already have a PayPal Business Account:

      1. Enter your registered email address, select your country and click on the Next button.
        Another popup is displayed.

      2. Enter your password and click on the Log In button.
        A message is displayed about confirming your email address. Setup is now complete.

    • If you do not already have a PayPal Business Account:

      1. Enter the email address you wish to register, select your country and click on the Next button.
        The Set up you PayPal Business Account window is displayed.

      2. Create and confirm your password and click on the Next button.
        The Please tell us about your business window is displayed.

      3. Complete the required details and click on the Agree and Create Account button.
        Two more windows are displayed requesting details about your business and you.

      4. Complete the first of these then click on the Next button.

      5. After completion of the second window, click on the Submit button.
        A confirmation window is displayed stating that you need to confirm your email address to activate your account.

      6. Go to your email and confirm activation of your PayPal account.

  5. Close the window and refresh the Viva Wallet Settings > API Access page.
    You should see a temporary message in the PayPal (Payment Method) section indicating that setup is in progress.

    Nothing else is required from your side, PayPal will appear as a payment method once PayPal approves the integration:

    Enabling PayPal in progress

  6. Optional step: If you refresh again in 2 minutes or so the message will update to the below which indicates that the PayPal payment method is successfully set up:

    Disable PayPal as payment method

Optional: Setup steps to enable PayPal as a payment method (sandbox mode)

If you want to test out PayPal in sandbox mode, follow the procedure below:

  1. Visit developer.paypal.com and click on the Log in to Dashboard button:

    Log in to dashboard button
    The PayPal login page is displayed.

  2. Enter the email address / mobile number and password of your PayPal Business Account and click on the Log in button.
    A dialog box requesting a further authentication step may be displayed. If this is the case, choose your preferred option and click on the Next button.
    Once fully logged in, the My apps & credentials page is displayed.

  3. Ensure that the Sandbox tab under the page title is selected:

    Sandbox tab

  4. Click on Accounts in the left nav in the Sandbox section.

  5. Click on the Create account button.
    The Create Sandbox Account dialog box is displayed.

  6. With the Business (Merchant Account) radio button selected, choose the country for your sandbox account:

    Create sandbox account

  7. Click on the Create button.
    After a little bit of time, the Sandbox test accounts page should be displayed with the new account listed.

  8. Click on the three dots under Manage accounts:

    Sandbox test accounts

  9. Select View/edit account from the sub-menu that pops up.
    The Account details window is displayed:

    Account details

  10. Make a temporary note of your Email ID and System Generated Password for later on.

  11. Sign in to your demo Viva Wallet account .

  12. Click on Settings > API Access and scroll down to the PayPal (Payment Method) section.

  13. Click on the Enable PayPal as a payment method button:

    Enable PayPal as a payment method
    The PayPal test store popup window is displayed:

    PayPal test store

  14. Complete the Email field with the Email ID you made a note of earlier, and select country from the drop-down to match the country of the sandbox account you recently set up.

  15. Click on the Next button.
    A window is displayed prompting you to enter a password:

    PayPal password window

  16. Complete the Password field with the System Generated Password you made a note of earlier.

  17. Click on the Log in button.
    An example PayPal account summary window is displayed.

  18. Close the window and refresh the Viva Wallet Settings > API Access page.
    You should see a temporary message in the PayPal (Payment Method) section indicating that setup is in progress.

    Nothing else is required from your side, PayPal will appear as a payment method once PayPal approves the integration:

    Enabling PayPal in progress

  19. Optional step: If you refresh again in 2 minutes or so the message will update to the below which indicates that the PayPal payment method is successfully set up:

    Disable PayPal as payment method

Issuing customer refunds

A full or partial refund can be made to a customer at any time for an order already placed with funds received into PayPal.

All refunds that are made through the PayPal back-office update both the payment in your PayPal Business Account and the related sales transaction in your Viva Wallet account.

All refunds that are made through the Viva Wallet banking app update both the related sales transaction in your Viva Wallet account and the payment in your PayPal Business Account.

Refunds will not be displayed on the Sales > Sales Transactions page in the Viva Wallet banking app until PayPal has finished processing them.

Full and partial refunds through PayPal

To issue refunds through your PayPal Business Account, see How do I issue a full or partial refund? in the PayPal Help Center.

Full and partial refunds through Viva Wallet

To issue a full refund through the Viva Wallet banking app:

  1. Sign in to your production Viva Wallet account .

  2. Go to Sales > Sales Transactions and click on the Search button with the required date range selected.
    A transaction list will be displayed:

    PayPal sales transaction

  3. Find the required transaction labelled PayPal Charge.

  4. Click on the Refund button.
    The Refund Transaction dialog box is displayed:

    Refund transaction

  5. Do one of the following:

    • To issue a full refund:

      1. Ensure the amount is the same as the original payment amount.

      2. Click on the OK button.

    • To issue a partial refund:

      1. Enter an amount that is smaller than the original payment amount.

      2. Click on the OK button.

    In both cases, a PayPal-related confirmation message will be displayed confirming the amount to be refunded:

    PayPal refund confirmation message