API Reference

Odoo

Installation and Setup of Module.

Installation

  • Load the module on Odoo.sh or on-premises server and install the module from Odoo Apps Store

Odoo Version 15

  1. Click on Settings

  1. Enable online payments from Sales, Accounting and Invoicing Module.

Sales Module

  • Sales > Online Payments > Click on Save.

Accounting Module


Invoicing Module

Payment Acquirers> UPayments**


  1. Enter the API key in acquirer and select state enabled for activate Upayments.

  1. Enable the KWD currency, as it is essential. Otherwise, refund issues may occur since UPayments processes amounts in KWD.
  2. Change the currency to KWD and Setup Multi-Currency currency.

Odoo Version 16

  1. Click on Settings

  1. Enable 'Online payments' from Sales, Accounting and Invoicing Module.
  2. Sales Module > Online Payments - Click on Save.

Accounting


Invoicing

Settings >Payment Acquirers

  1. Payment Acquirers > UPayments

  1. Enter the API key in payment provider and select state enabled for activate Upayments. provider.
  2. Enable the KWD currency, as it is essential. Otherwise, refund issues may occur since Upayments processes amounts in KWD.
  1. Setup Multi Currency if Product is sold in any other currency other than KWD

Odoo Version 17

  1. Click on Settings

  1. Enable online payments from Sales, Accounting and Invoicing Module.

Accounting


Invoicing

Settings

  1. Payment Acquirers>UPayments

  1. Then fill the API key in payment provider and select state enabled for activate UPayments provider.
  2. Test API Keys (Bearer Token)
    • Non-whitelabeled API : jtest123
    • White Labeled API: e66a94d579cf75fba327ff716ad68c53aae11528
    • Production API Key (Bearer Token): Contact [email protected] or +965 1809888. Non encrypted API Token can be used for the Bearer Token.
  3. Enable the KWD currency, as it is essential. Otherwise, refund issues may occur since UPayments processes amounts in KWD.

  1. Setup Multi Currency if Product is sold in any other currency other than KWD

Functional Features

Sales Module > Odoo 15 & 16

  1. Select Sales Module
  2. Create Sales order

  1. Click on Action button to generate Payment Link

  1. Check Payment details

Sales Module > Odoo 17

  1. Select Sales Module

  1. Generate Sales order

  1. Click on Settings button to generate Payment Link

  1. Copy the Payment link or Click on Send Email button to send payment link via email

  1. Click on Create Invoice

  1. Click on Generate payment link from invoice

  1. Click on Payment Transaction details

  1. Select the payment in-case of multiple payment attempts for the same order

  1. Click on Check payment status

  1. Click on Check payment status and the System will return payment status

Refund

  1. In case of Refund go the invoice of payment

  1. Click on Payment info icon and click on View

  1. Click on Refund Button (Note- Refund option is only available if payment is made online)

  1. Enter the amount to be Refunded

Partial or full Refund

  1. Click on Refund Smart Button


  1. Reverse Journal

Subscription Module > Odoo 15 & 16

  1. Select Subscription Module


  1. Create Subscription and register invoice and Payment


Subscription Module >Odoo 17

  1. Click on Subscription Module


  1. Create Subscription Plan sales order



  1. Generate Payment link from Sales order


  1. Create Invoice and we can also generate payment link


  1. Invoice is mark paid


  1. Check Payment Transaction details


E-Commerce Module - Odoo 15 & 16

  1. Select Website
  2. Select Product
  3. Click Add to Cart
  4. Click on Process Checkout
  5. In case of non-white label API – UPayments option will be visible
  6. Click on Upayments and Select Payment Method
  7. Process the Payment
  8. Incase Payment failed below error will appeared.
  9. In case Payment in completed we can check the invoice and payment status.
  10. Click on Payment Status smart button to check payment details

E-Commerce Module - Odoo 17

  1. Click on Website module
  2. Click on Shop and Select the product
  3. Click on Add to cart and go the check out
  4. Payment Method will appear based on the API Key (If White label or Non-White label is enabled)
  5. Process the payment
  6. Sales order and Invoice is created check the payment transaction details