Skip to main content

Getting started

This API docs describes how to integrate with Credify's EF on your e-commerce store.

Store Types Available​

Credify provides plugins for seamless integration with Shopify and WooCommerce. To utilize these plugins, log in to your merchant dashboard where you will find detailed instructions on the "Connected Stores" page.

For stores that do not use Shopify or WooCommerce, please refer to this guide for instructions on how to implement Credify's payment flow on your website or service.

Integration Overview​

To integrate EF payment method, Credify will need to know basic info on the order (order id, items, total price, customer name, mobile number and shipping address) and user should be able to go through the payment process via an iframe and after payment is done, Credify services will send a webhook notification that notifies your website/service with the status of the order or payment.

The over all process can be sumamrized as follows:

  1. Customer initiaties payment in checkout screen on your website

  2. JS code should open an iframe with the following parameters: unique order ID and your merchant ID

  3. Credify Backend service will send a server-to-server API call to get order details

  4. Payment process will start and customer should be able to finish the payment flow

  5. After payment flow is completed, a webhook notification will be sent from Credify server to your website/service.

What is required from store​

To summarize the requirements to ensure a healthy integration:

  1. Create an API that receives the order ID and returns basic order info.
  2. Implement an API to receive webhook calls that notify your store of payment, cancellation, refund, or partial refunds.
  3. Implement security controls on the above APIs.
  4. Provide Credify with the URLs for the 2 APIs above.
  5. If a user chooses to checkout using Credify, open an iframe with the URL that will be provided by Credify during the setup process.