Get started with Flitt

Step 1. Obtain test data

Refer to Testing page to obtain test merchant, payment secret key and card data.

Step 2. Create test order

Refer to Create order page to create test order with a simple code.

For example:

curl -i -X POST \
-H "Content-Type:application/json" \
-d \
'{
"request": {
"server_callback_url": "http://myshop/callback/",
"order_id": "TestOrder2",
"currency": "USD",
"merchant_id": 1549901,
"order_desc": "Test payment",
"amount": 1000,
"signature": "91ea7da493a8367410fe3d7f877fb5e0ed666490"
}
}' \
'https://pay.flitt.com/api/checkout/url'

Step 3. Choose your integration type

Some more code examples

curlphpvue.jsJavaScriptc#javanode.jspython

$ curl -L 'https://pay.flitt.com/api/checkout/url' \
-H 'Content-Type: application/json' \
-d '{
  "request": {
    "version": "1.0.1",
    "order_id": "test_order_id_132412412",
    "currency": "GEL",
    "merchant_id": 1549901,
    "order_desc": "Test order",
    "amount": 10025,
    "response_url": "https://example.com/thankyoupage",
    "server_callback_url": "https://example.com/api/callback",
    "signature": "7f52380cefaf3cb793746e2deeb56cf7cd75d532"
  }
}'

response:

{
  "response": {
    "checkout_url": "https://pay.flitt.com/merchants/5ad6b888f4becb0c33d543d54e57d86c/default/index.html?token=03fb1c589f8fcabc80f609c70af541fc636df112",
    "payment_id": "805230052",
    "response_status": "success"
  }
}

Composer installation

composer require cloudipsp/php-sdk-v2

Manual installation

git clone -b master https://github.com/cloudipsp/php-sdk-v2.git

Simple Start

require 'vendor/autoload.php';
\Cloudipsp\Configuration::setMerchantId(1549901);
\Cloudipsp\Configuration::setSecretKey('test');

$checkoutData = [
    'currency' => 'GEL',
    'amount' => 1000
];
$data = \Cloudipsp\Checkout::url($checkoutData);
$url = $data->getUrl();
$data->toCheckout();

Simple Start Include checkout.js file

<script src="https://pay.flitt.com/latest/checkout-vue/checkout.js"></script>

Add CSS:

<style>body {margin: 0;}</style>
<link rel="preload" href="https://pay.flitt.com/icons/dist/fonts/inter-regular.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://pay.flitt.com/icons/dist/fonts/inter-medium.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://pay.flitt.com/icons/dist/fonts/inter-semibold.woff2" as="font" type="font/woff2" crossorigin="anonymous">
<link rel="preload" href="https://pay.flitt.com/icons/dist/fonts/cvv.woff" as="font" type="font/woff" crossorigin="anonymous">
<link rel="preload" href="https://pay.flitt.com/icons/dist/fonts/card-number.woff" as="font" type="font/woff" crossorigin="anonymous">
<link rel="preload" href="https://pay.flitt.com/latest/checkout-vue/checkout.css" as="style">
<link href="https://pay.flitt.com/latest/checkout-vue/checkout.css" rel="stylesheet">

HTML congtainer:

<div id="checkout-container"></div>

JavaScript code:

var Options = {
  options: {
    methods: ["card"],
    methods_disabled: [],
    full_screen: false,
    title: "Example title.",
    active_tab: 'card',
    theme: {
      type: "light",
      preset: "black"
    },
  },
  params: {
    merchant_id: 1549901,
    currency: "GEL",
    order_id: new Date().getTime(),
    amount: 5000,
    order_desc: "Test payment"
  }
};
checkout("#checkout-container", Options);

1.Installation

Node If you’re using Npm in your project, you can add ipsp-js-sdk dependency to package.json with following command:

npm i --save ipsp-js-sdk

or add dependency manually:

{
  "dependency": {
    "ipsp-js-sdk":"^1.0"
  }
}

Bower If you’re using Bower in your project, you can run the following command:

bower install ipsp-js-sdk

or add dependency manually:

{
  "dependency": {
    "ipsp-js-sdk":"^1.0"
  }
}

Manual installation If you do not use NodeJS, you can download the latest release. Or clone from GitHub the latest developer version

git clone git@github.com:cloudipsp/ipsp-js-sdk.git

Quick start

<script src="https://unpkg.com/ipsp-js-sdk@latest/dist/checkout.min.js"></script>

2. Develop html card form using your own design.

Basic template

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
  </head>
  <body>
    <script src="https://unpkg.com/ipsp-js-sdk@latest/dist/checkout.min.js"></script>
    <script>
    $checkout('Api').scope(function(){
        this.request('api.checkout.form','request', { Parameters } ).done(function(model){
            model.sendResponse();
            console.log(model.attr('order'));
        }).fail(function(model){
            console.log(model.attr('error'));
        });
    });
    </script>
  </body>
</html>

Basic template example: https://github.com/cloudipsp/ipsp-js-sdk#basic-template

3. Create order using Integration Schema C for JavaScript SDK.

Add parameters required_rectoken=Y and server_callback_url in your request to obtain recurring token (if you are planning recurring payments) in server callback (rectoken parameter).

curl -i -X POST \
-H "Content-Type:application/json" \
-d \
'{
"request": {
"server_callback_url": "http://myshop/callback/",
"order_id": "TestOrder2",
"currency": "USD",
"merchant_id": 1549901,
"order_desc": "Test payment",
"amount": 1000,
"signature": "91ea7da493a8367410fe3d7f877fb5e0ed666490"
}
}' \
'https://pay.flitt.com/api/checkout/token'

Documentation: https://docs.flitt.com/docs/page/3/?la=en#chapter-3-6-c. Save host-to-host token parameter from response.

4. Load host-to-host token from step 3 in your card details form.

{
 "payment_system":"card",
 "token":"host-to-host generated token",
 "card_number":"16/19-digits number",
 "expiry_date":"Supported formats: MM/YY, MM/YYYY, MMYY, MMYYYY",
 "cvv2":"3-digits number"
 }

from card form to payment gateway using JavaScript API $checkout('Api'). Instruction: https://github.com/cloudipsp/ipsp-js-sdk#host-to-host-token

5. Use .on('success') and .on('error') JavaScript callbacks to get result on payment processing.

success – order is approved and amount will be charged error – order is declined and amount will not be charged

model.attr('error.message') will contain localized error message in case of payment decline. Order information on order status and details will be returned in model.data.order.order_data

JavaScript callback example:

console.log('success',JSON.stringify(model.attr("order").order_data));

{
  "response": {
    "rrn": "111111111111",
    "masked_card": "444455XXXXXX1111",
    "sender_cell_phone": "",
    "sender_account": "",
    "currency": "UAH",
    "fee": "",
    "reversal_amount": "0",
    "settlement_amount": "0",
    "actual_amount": "200",
    "response_description": "",
    "sender_email": "test@test.com",
    "order_status": "approved",
    "response_status": "success",
    "order_time": "13.07.2024 01:23:59",
    "actual_currency": "UAH",
    "order_id": "test33694502191",
    "tran_type": "purchase",
    "eci": "5",
    "settlement_date": "",
    "payment_system": "card",
    "approval_code": "123456",
    "merchant_id": 1549901,
    "settlement_currency": "",
    "payment_id": 805243692,
    "card_bin": 444455,
    "response_code": "",
    "card_type": "VISA",
    "amount": "200",
    "signature": "b7884b5c4906956fbac4d20390388d913a78c0b0",
    "product_id": "",
    "merchant_data": "Test merchant data",
    "rectoken": "",
    "rectoken_lifetime": "",
    "verification_status": "",
    "parent_order_id": "",
    "fee_oplata": "0",
    "additional_info": "{\"capture_status\": null, \"capture_amount\": null, \"reservation_data\": \"{}\", \"transaction_id\": 1994930931, \"bank_response_code\": null, \"bank_response_description\": null, \"client_fee\": 0.0, \"settlement_fee\": 0.0, \"bank_name\": null, \"bank_country\": null, \"card_type\": \"VISA\", \"card_product\": \"empty_visa\", \"card_category\": null, \"timeend\": \"13.07.2024 01:24:08\", \"ipaddress_v4\": \"178.54.60.26\", \"payment_method\": \"card\", \"version_3ds\": 1, \"is_test\": true}",
    "response_signature_string": "**********|200|UAH|{\"capture_status\": null, \"capture_amount\": null, \"reservation_data\": \"{}\", \"transaction_id\": 1994930931, \"bank_response_code\": null, \"bank_response_description\": null, \"client_fee\": 0.0, \"settlement_fee\": 0.0, \"bank_name\": null, \"bank_country\": null, \"card_type\": \"VISA\", \"card_product\": \"empty_visa\", \"card_category\": null, \"timeend\": \"13.07.2024 01:24:08\", \"ipaddress_v4\": \"178.54.60.26\", \"payment_method\": \"card\", \"version_3ds\": 1, \"is_**********\": true}|200|123456|444455|VISA|UAH|5|0|444455XXXXXX1111|Test merchant data|1549901|**********33694502191|approved|13.07.2024 01:23:59|805243692|card|success|0|111111111111|**********@**********.com|0|purchase"
  }
}

Example: https://jsfiddle.net/flitt/on8ydsgq/1/

6. Process final response received as server callbacks to server_callback_url.

Format of final response: Response

Installation SDK availble on NuGet

Simple start

using CloudIpspSDK;
using CloudIpspSDK.Checkout;

Config.MerchantId = 1549901;
Config.SecretKey = "test";

var req = new CheckoutRequest {
  order_id = Guid.NewGuid().ToString("N"),
  amount = 100000,
  order_desc = "checkout json demo",
  currency = "GEL"
};
var resp = new Url().Post(req);
if (resp.Error == null) {
 string url = resp.checkout_url;
}

Installation Add maven dependencies

<dependencies>
    <dependency>
        <groupId>com.cloudipsp.cloudipspsdk</groupId>
        <artifactId>java-cloudipsp-sdk-client</artifactId>
        <version>1.0.0</version>
    </dependency>
</dependencies>

Simple start

public class Main {
    public static void main(String[] args) {
        final Configuration config = new Configuration()
                .setSecretKey("test")
                .setMerchantId(1549901);
        client = new CloudIpspApi(config);
        pamentApi = client.getPaymentApi(); // Get payment api instance
        orderApi = client.getOrderApi(); // Get api instance for working with orders
        /**
         * Generate payment request
         */
        JSONObject payload = new JSONObject();
        payload.put("currency", "EUR");
        payload.put("amount", 100);
        payload.put("order_id", "test123");
        BaseApiResponse response = pamentApi.paymentUrl(payload);
        JSONObject order = response.getParsedResponse();
        URI checkout_url = response.getCheckoutUrl();
    }
}

Installation

npm install cloudipsp-node-js-sdk

Manual installation

git clone -b master https://github.com/cloudipsp/node-js-sdk.git

Simple start

const CloudIpsp = require('cloudipsp-node-js-sdk')

const checkout = new CloudIpsp(
  {
    merchantId: 1549901,
    secretKey: 'test'
  }
)
const requestData = {
  order_id: 'Your Order Id',
  order_desc: 'test order',
  currency: 'GEL',
  amount: '1000'
}
checkout.Checkout(requestData).then(data => {
  console.log(data)
}).catch((error) => {
  console.log(error)
})

Installation

pip install cloudipsp

Simple start

from cloudipsp import Api, Checkout
api = Api(merchant_id=1549901,
          secret_key='test')
checkout = Checkout(api=api)
data = {
    "currency": "GEL",
    "amount": 10000
}
url = checkout.url(data).get('checkout_url')