Comment on page

Squad Payment Modal

Payment Modal 
Squad Payment Modal provides an easy and convenient payment flow. It is the simplest way to securely collect payments from your customers without them leaving your website. The customer will be shown all the payment methods you have selected.
It can be integrated with simple steps, by copying the code in the embedded section and pasting it on your page; making it the easiest way to accept payments. It works across devices and can help increase your conversion.
Parameters
To initialize a transaction, you need to pass details such as email, first name, last name, amount, transaction reference, etc. Email, amount, and currency are required. You can also pass any other additional information in the metadata object field. The following is a complete list of parameters that you can pass:
PARAMETERS
REQUIRED?
DESCRIPTION
key
Yes
Your Squad public key. Use the test key found in your Sandbox account in test mode, and use the live key found in your Squad dashboard in live mode.
email
Yes
Customer's email address.
amount
Yes
The amount you are debiting customer (expressed in the lowest currency value - kobo& cent). 
transaction_ref
No
Unique case-sensitive transaction reference. If you do not pass this parameter, Squad will generate a unique reference for you.
currency_code
Yes
The currency you want the amount to be charged in. Allowed value is NGN or USD. 
payment_channels
No
An array of payment channels to control what channels you want to make available for the user to make a payment with. Available channels include; ['card', 'bank' , 'ussd','transfer']
customer_name
No
Name of Customer
callback_url
No
Sample: https://squadco.com
metadata
No
Object that contains any additional information that you want to record with the transaction. The custom fields in the object will be returned via webhook and the payment verification endpoint.
pass_charge
No
It takes two possible values: True or False.
It is set to False by default. When set to True, the charges on the transaction is computed and passed on to the customer(payer).
But when set to False, the charge is passed to the merchant and will be deducted from the amount to be settled to the merchant.

The customer information can either be retrieved from a form, or from your database if you already have it stored. (Example below)
Code Glossary
HTML
JavaScript
<!DOCTYPE html>
<html lang="en">
<HEAD>
<TITLE>SQUAD</TITLE>
<!-- bootstrap -->
<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
​
</HEAD>
<BODY>
  <form style="padding-left: 30px;" class="text-center">
      <div class="text-left" style="color:red; font-family: Verdana; font-size: 30px;">SAMPLE CHECKOUT</div>
      <h6>Note: Amount should be between $1 to $10,000 (USD), NGN100 to NGN5,000,000 and KSH100 to KSH5,000,000</h6>
      <div class="row text-center">
        <div class="col-lg-4">
            <label for="email">Email Address</label>
            <input type="email" id="email-address" class="form-control" required /><br>
        </div>
        <div class="col-lg-4">
            <label for="amount">Amount</label>
            <input type="tel" id="amount" class="form-control" required /><br>
        </div>
      </div>
      <div class="row">
        <div class="col-lg-4">
            <label for="first-name">First Name</label>
            <input type="text" id="first-name" class="form-control" /><br>
        </div>
        <div class="col-lg-4">
            <label for="last-name">Last Name</label>
            <input type="text" id="last-name" class="form-control" /><br>
        </div>
      </div>
      <div class="col-lg-4">
        <div class="form-submit">
          <button type="button" onclick="SquadPay()" class="btn btn-danger">Check Out</button><br><br>
        </div>
      </div>
    </div>
  </form>
</BODY>
</HTML>
<script src="https://checkout.squadco.com/widget/squad.min.js"></script> 
​
function SquadPay() {
 
  const squadInstance = new squad({
    onClose: () => console.log("Widget closed"),
    onLoad: () => console.log("Widget loaded successfully"),
    onSuccess: () => console.log(`Linked successfully`),
    key: "test_pk_sample-public-key-1",
    //Change key (test_pk_sample-public-key-1) to the key on your Squad Dashboard
    email: document.getElementById("email-address").value,
    amount: document.getElementById("amount").value * 100,
    //Enter amount in Naira or Dollar (Base value Kobo/cent already multiplied by 100)
    currency_code: "NGN"
  });
  squadInstance.setup();
  squadInstance.open();
​
}
Initiate transaction
When the customer clicks on the submit button, initiate a transaction by passing the necessary details (email, amount, and any other parameters) to Squad through to a JavaScript function. 
function SquadPay() {
 
  const squadInstance = new squad({
    onClose: () => console.log("Widget closed"),
    onLoad: () => console.log("Widget loaded successfully"),
    onSuccess: () => console.log(`Linked successfully`),
    key: "test_pk_sample-public-key-1",
    //Change key (test_pk_sample-public-key-1) to the key on your Squad Dashboard
    email: document.getElementById("email-address").value,
    amount: document.getElementById("amount").value * 100,
    //Enter amount in Naira or Dollar (Base value Kobo/cent already multiplied by 100)
    currency_code: "NGN"
  });
  squadInstance.setup();
  squadInstance.open();
​
}
A checkout modal will pop-up with different payment options for the customer to choose and input their payment information to complete the transaction. 
​
Checkout Demo
Key Information
1.The key field takes your Squad key.
2.By default, the amount field is already set in the lowest currency unit (kobo, cent). That is, to pay NGN100, you have to enter 10000 in the amount field.
To convert amount to the base currency (Naira, Dollar), multiply the amount parameter by 100 in your code, amount: document.getElementById("amount").value * 100, This will allow you enter the amount in Naira or Dollar as the case may be.
Payment Channels
After initialization, there are a couple of payment channels available to the customer to complete the transaction.
USSD
The USSD channel allows your Nigerian customers to pay you by dialing the USSD code on their mobile devices. Nigerian banks provide USSD services for customers to use for transactions, and we have integrated with some of these banks to allow your customers to complete payments. 
After dialing the USSD code displayed, the system will prompt the user to input the USSD PIN to authenticate the transaction and then confirm it. All that is needed to initiate USSD payment is the customer's email and the amount to be charged. When the user makes a payment, the response will be sent to your webhook. 
Therefore, to make it work as expected, webhooks must be configured on your Squad dashboard.
Banks Supported
Here is a list of all the Banks USSD shortcodes we currently support:
Bank
USSD Shortcode
Access (Diamond) Bank
426
Access Bank
901
EcoBank
326
First City Monument Bank (FCMB)
329
Fidelity Bank
770
First Bank
894
Guaranty Trust
737
Heritage Bank
745
Keystone Bank
7111
Rubies (Highstreet) MFB
779
Stanbic IBTC Bank
909
Sterling Bank
822
United Bank for Africa (UBA)
919
Union Bank
826
Unity Bank
7799
VFD Bank
5037
Wema Bank
945
Zenith Bank
966
Bank Transfer
Squad provides a payment method that makes it possible for customers to pay you through a direct bank account transfer. The customer provides their name, phone number, and email address. Then a preset account number is displayed along with the preregistered bank name. 
Card
With Squad, customers can pay with Card provided their card details are correct and updated.  The customer provides their card number, card expiry date, and CVV.
How To Test
1.Create a free Squad sandbox account and get your test keys from the dashboard.
2.Copy the code sample from the Code Glossary of this documentation unto a text editor of your choice.
3.Save the document as .html file. For example index.html 
4.With an internet-enabled device, view the .html file (index.html) using any web server of your choice either local (WAMP, XAMPP, etc) or online.
Go Live
To go live on the payment modal, simply change the test key to the live key found in your Squad dashboard.
​

Initiate Payment

Verify Transaction

Last modified 3mo ago

PARAMETERS	REQUIRED?	DESCRIPTION
key	Yes	Your Squad public key. Use the test key found in your Sandbox account in test mode, and use the live key found in your Squad dashboard in live mode.
email	Yes	Customer's email address.
amount	Yes	The amount you are debiting customer (expressed in the lowest currency value - `kobo`& `cent`).
transaction_ref	No	Unique case-sensitive transaction reference. If you do not pass this parameter, Squad will generate a unique reference for you.
currency_code	Yes	The currency you want the amount to be charged in. Allowed value is `NGN or USD`.
payment_channels	No	An array of payment channels to control what channels you want to make available for the user to make a payment with. Available channels include; [`'card'`, `'bank'` , `'ussd'`,`'transfer'`]
customer_name	No	Name of Customer
callback_url	No	Sample: https://squadco.com
metadata	No	Object that contains any additional information that you want to record with the transaction. The `custom fields in the object` will be returned via webhook and the payment verification endpoint.
pass_charge	No	It takes two possible values: True or False. It is set to False by default. When set to True, the charges on the transaction is computed and passed on to the customer(payer). But when set to False, the charge is passed to the merchant and will be deducted from the amount to be settled to the merchant.

Bank	USSD Shortcode
Access (Diamond) Bank	426
Access Bank	901
EcoBank	326
First City Monument Bank (FCMB)	329
Fidelity Bank	770
First Bank	894
Guaranty Trust	737
Heritage Bank	745
Keystone Bank	7111
Rubies (Highstreet) MFB	779
Stanbic IBTC Bank	909
Sterling Bank	822
United Bank for Africa (UBA)	919
Union Bank	826
Unity Bank	7799
VFD Bank	5037
Wema Bank	945
Zenith Bank	966