Payment Gateway Integration in Odoo

Payment Gateway Integration

Integrating the payment gateway with Odoo is an easy task if we have a basic knowledge in python. In this section let us look how to integration on a payment gateway with the Odoo. First of all, I am using the Paytab as the payment gateway provider here.

Once we create an account in the Pay tab we will get a merchant email and secret key. Which is then used as the login credentials.

After creating the account in Pay tab, we now let us focus on the integration. The main steps in the integration is,

1. Validating the secret key
2. Creating the pay page
3. Verifying the payment

Now let us look how to validate the secret key

Secret Key validation

The secret is validating to check the existence of the account and to know the details of the account to which the amount has to be remitted.

This method uses the merchant email and secret key to validate your credentials.

You can find the secret key from your Pay tab account like this.

Click on Merchant’s Dashboard >> Pay Tabs Services >> e-commerce

Plugins and API. Here you can find the merchant email and the secret key.

After getting the both, we have to send a request to validate secret key like this,

URL: https://www.paytabs.com/apiv2/validate_secret_key

Method: POST

We have to pass the merchant email and the secret key along with this URL.

For the validation of the secret key.

Sample Code:

secret_key_validation_url = 'https://www.paytabs.com/apiv2/validate_secret_key/{}'
merchant_email = 'niyasraphyk@gmail.com'
secret_key = 'BSWzZCWTrCgeKzCpS3rugWnhWNDgNFopykYxXVqpxGDiggI9kaDA61S2OviCbH1K1ZiZUJosp1LGhtPBDtcKu4MiA5UMMWxOVPNQ'
params = {'merchant_email': merchant_email, 'secret_key': secret_key}
r = requests.post(url=secret_key_validation_url, data=params)

This is how we will send the validation request, then we will get the response from the gateway in the variable r.

Let us look the different response that we are possible to get,

If we get a response of 4000, we can process to the next step, i.e., Pay Page creation.

To get the response code from the variable r, we can use the following code

r = requests.post(url=payment_url, data=params)
d = ast.literal_eval(r.text)
print d['response_code']

Pay page creation

Pay page creation method will accept all the parameters required to create a Pay Page and then return the response as well as the link where all the parameters posted to the API will appear in the Pay Page customer can enter ONLY the credit card information such as account number and cvv to make the payment.

For the Pay Page creation, we have to pass the following values.

The above-listed fields are required to create a Pay Page so that we have .to pass all these data along with the URL to create the Pay Page. 

URL: https://www.paytabs.com/apiv2/create_pay_page

Method: POST

Sample code

 
pay_page_url = "https://www.paytabs.com/apiv2/create_pay_page"
params2 = {'merchant_email': merchant_email, 'secret_key': secret_key, 'pay_page_url': pay_page_url,
           'site_url': site_url, 'return_url': return_url, 'title': title, 'currency': currency,
           'amount': amount, 'quantity': quantity, 'unit_price': unit_price, 'discount': discount,
           'other_charges': other_charges, 'cc_first_name': cc_first_name, 'cc_last_name': cc_last_name,
           'cc_phone_number': cc_phone_number, 'phone_number': phone_number, 'email': email,
           'products_per_title': products_per_title, 'msg_lang': msg_lang, 'country_shipping': country_shipping,
           'postal_code_shipping': postal_code_shipping, 'state_shipping': state_shipping,
           'city_shipping': city_shipping, 'address_shipping': address_shipping,
           'billing_address': billing_address, 'shipping_last_name': shipping_last_name,
           'shipping_first_name': shipping_first_name, 'country': country, 'postal_code': postal_code,
           'reference_no': reference_no, 'state': state, 'city': city, 'ip_merchant': ip_merchant,
           'ip_customer': ip_customer, 'cms_with_version': cms_with_version}
d = requests.post(url=pay_page_url, data=params2)

 After placing this request, we will get a response from the gateway.

 Response message

Once the payment page is created successfully (pay page is the page where which user can add his card details)

After entering the card details, a user can click the pay now button. On creating the Pay Page we have to pass one more value, i.e., return url, the URL to which the page gets redirected after the payment.

Payment Verification 

To verify the payment we will receive a p_id in the response message to the page.

URL: https://www.paytabs.com/apiv2/verify_payment

Method: POST

To verify the payment we have to pass the following parameters along with url 

Response codes that you will get after this, 

Sample code

 
verify_payment = 'https://www.paytabs.com/apiv2/verify_payment/{}'
merchant_email = "malappuram132@gmail.com"
secret_key = "BSWzZCWTrCgeKzCpS3rugWnhWNDgNFopykYxXVqpxGDiggI9kaDA61S2OviCbH1K1ZiZUJosp1LGhtPBDtcKu4MiA5UMMWxOVPNQ"
p_id = "85533"
params = {'merchant_email': merchant_email, 'secret_key': secret_key, 'payment_reference': p_id}
g = requests.post(url=verify_payment, data=params)

This is how a payment gateway odoo integration with the pay tab is done