Developer documentation

Getting Started

Install cheqqly

  • Create a cheqqly account here

  • Navigate on Install cheqqly on the dashboard

  • Toggle the dialog and copy the cheqqly code snippet

  • Grab your merchantId from settings for configuring cheqqly code snippet

Configuring cheqqly widget

In your configuration replace the above with:

                    var config = {
                    
                    merchantId: 'YOUR-MERCHANT-ID' // must be a string, 

                    amount: 'AMOUNT', // must be an integer

                    businessName: 'YOUR-BUSINESS-NAME' // must be a string
                    }
                

Please note:

Use 4242 4242 4242 4242 as a test credit card. This is for testing the sdk if everything is set up well You can test here* Get your merchantId from settings

Every amount is 1/100 of Amount. e.g $5 would be configured as 500. 1/100 * 500 => would yield $5. Please note that the least amount accepted is $0.50 *

Finish up and test

Check and test if it returns successful credit/debit charge

Successfull payment processed should return an Http Response like so:

                {
                     message:`Successully paid _amount_ to business_name`
                }
                

Failed payment processed should return an Http Response like so:

            {
            message:`Failed to process payment. Please check if you entered right card details or check is card is credited`
            }
            

Common errors:

            {
            message:`Failed to process payment. Please check if you entered right card details or check is card is credited`
            }
            

Supported country codes


  • Australia

  • Austria

  • Belgium

  • Canada

  • Denmark

  • Finland

  • Germany

  • Hong Kong

  • Switzerland

  • United Kingdom

  • United States: - usd

  • Ireland

  • Italy

  • Japan

  • Luxembourg

  • Netherlands

  • New Zealand

  • Norway

  • Portugal

  • Spain

  • Sweden