Tabby

https://docs.tabby.ai/
Admin
Tabby is a Buy Now Pay Later platform for the MENA region that enables merchants to offer flexible...
Tokens:327,940
Snippets:1,693
Trust Score:7.5
Update:1 week ago
Show doc for...
Tokens:
Raw
### Go example to retrieve all dispute webhooks

Source: https://docs.tabby.ai/api-reference/dispute-webhooks/retrieve-all-dispute-webhooks

Uses the net/http package to send a GET request with the required headers and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.tabby.ai/api/v1/dispute-webhooks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Merchant-Code", "<x-merchant-code>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Python requests example to retrieve all dispute webhooks

Source: https://docs.tabby.ai/api-reference/dispute-webhooks/retrieve-all-dispute-webhooks

Uses the requests library to send a GET request with the required headers and prints the response.

```python
import requests

url = "https://api.tabby.ai/api/v1/dispute-webhooks"

headers = {
    "X-Merchant-Code": "<x-merchant-code>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### Ruby Net::HTTP example to retrieve all dispute webhooks

Source: https://docs.tabby.ai/api-reference/dispute-webhooks/retrieve-all-dispute-webhooks

Uses Net::HTTP to send a GET request with the required headers and prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.tabby.ai/api/v1/dispute-webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Merchant-Code"] = '<x-merchant-code>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Install Tabby Magento 2 extension with Composer

Source: https://docs.tabby.ai/e-commerce-platforms/magento-2/magento-2-plugin-installation

Run these commands to install the Tabby metapackage and enable the Tabby_Checkout and Tabby_Feed modules. This is the recommended installation method and also used for updates.

```bash
composer require tabby/m2-payments
php bin/magento module:enable Tabby_Checkout Tabby_Feed
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy -f
php bin/magento cache:flush

```

--------------------------------

### Java Unirest example to retrieve all dispute webhooks

Source: https://docs.tabby.ai/api-reference/dispute-webhooks/retrieve-all-dispute-webhooks

Uses the Unirest library to send a GET request with the required headers and returns the response as a string.

```java
HttpResponse<String> response = Unirest.get("https://api.tabby.ai/api/v1/dispute-webhooks")
  .header("X-Merchant-Code", "<x-merchant-code>")
  .header("Authorization", "Bearer <token>")
  .asString();
```

--------------------------------

### JavaScript fetch example to retrieve all dispute webhooks

Source: https://docs.tabby.ai/api-reference/dispute-webhooks/retrieve-all-dispute-webhooks

Uses the fetch API to send a GET request with the required headers and logs the JSON response.

```javascript
const options = {
  method: 'GET',
  headers: {'X-Merchant-Code': '<x-merchant-code>', Authorization: 'Bearer <token>'}
};

fetch('https://api.tabby.ai/api/v1/dispute-webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Complete Checkout snippet example

Source: https://docs.tabby.ai/pay-in-4-custom-integration/on-site-messaging

A complete HTML example combining the container div, script tag, and TabbyCard initialization for the Checkout page.

```html
<html>
  <body>
    <div id="TabbyCard"></div>
    <script src="https://checkout.tabby.ai/tabby-card.js"></script>
    <script>
      new TabbyCard({
        selector: '#TabbyCard',
        currency: 'AED',
        price: '2000.00',
        lang: 'en',
        shouldInheritBg: false,
        publicKey: 'your_pk',
        merchantCode: 'your_merchant_code'
      });
    </script>
  </body>
</html>
```

--------------------------------

### Get disputes list with Go

Source: https://docs.tabby.ai/api-reference/disputes/get-disputes-list

Uses Go's net/http package to send a GET request for the disputes list and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.tabby.ai/api/v1/disputes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### GET /api/v2/checkout/{id} - 200 Response Sample

Source: https://docs.tabby.ai/api-reference

Example of a successful response (200) for retrieving a checkout session. The response includes the session ID, configuration, token (null in this example), payment details, status, merchant URLs, and merchant name.

```json
{
  "id": "session id, uuid format",
  "configuration": {
    "available_products": {
      "installments": [
        {
          "web_url": "https://checkout.tabby.ai/",
          "qr_code": "https://api.tabby.ai/api/v2/checkout/{id}/hpp_link_qr"
        }
      ]
    },
    "products": {
      "installments": {
        "type": "installments",
        "is_available": true,
        "rejection_reason": null
      }
    }
  },
  "token": null,
  "payment": {
    "id": "payment id, uuid format",
    "created_at": "2019-08-24T14:15:22Z",
    "status": "CLOSED",
    "is_test": true,
    "amount": "100",
    "currency": "AED",
    "description": "test payload",
    "order": {
      "reference_id": "1001",
      "updated_at": "2019-08-24T14:15:22Z",
      "tax_amount": "0.00",
      "shipping_amount": "0.00",
      "discount_amount": "0.00",
      "items": [
        {
          "reference_id": "SKU123",
          "title": "Name of the product",
          "description": "Description of the product",
          "quantity": 1,
          "unit_price": "0.00",
          "image_url": "https://example.com/",
          "product_url": "https://example.com/",
          "gender": "Kids",
          "category": "Clothes",
          "color": "white",
          "product_material": "cotton",
          "size_type": "EU",
          "size": "M",
          "brand": "Name of the Brand",
          "is_refundable": true
        }
      ]
    },
    "meta": {
      "customer": "#customer-id",
      "order_id": "#1234"
    },
    "attachment": {
      "body": "{\"flight_reservation_details\": {\"pnr\": \"TR9088999\",\"itinerary\": [...],\"insurance\": [...],\"passengers\": [...],\"affiliate_name\": \"some affiliate\"}}",
      "content_type": "application/vnd.tabby.v1+json"
    }
  },
  "status": "created",
  "merchant_urls": {
    "success": "https://your-store/success",
    "cancel": "https://your-store/cancel",
    "failure": "https://your-store/failure"
  },
  "merchant": {
    "name": "Your store name"
  }
}
```

--------------------------------

### Complete Product and Cart snippet example

Source: https://docs.tabby.ai/pay-in-4-custom-integration/on-site-messaging

A complete HTML example combining the container div, script tag, and TabbyPromo initialization for Product and Cart pages.

```html
<html>
  <body>
    <div id="TabbyPromo"></div>
    <script src="https://checkout.tabby.ai/tabby-promo.js"></script>
    <script>
      new TabbyPromo({
        selector: '#TabbyPromo',
        currency: 'AED',
        price: '2000.00',
        lang: 'en',
        source: 'product',
        shouldInheritBg: false,
        publicKey: 'your_pk',
        merchantCode: 'your_merchant_code'
      });
    </script>
  </body>
</html>
```

--------------------------------

### Successful response for get dispute by id

Source: https://docs.tabby.ai/api-reference/disputes/get-dispute-by-id

Example 200 response containing the dispute object with fields such as id, amount, status, and history.

```json
{
  "dispute": {
    "id": "dispute id, uuid format",
    "attachments": [
      "attachment_1"
    ],
    "payment_id": "payment id, uuid format",
    "amount": "100.00",
    "currency": "AED",
    "created_at": "2018-10-17T00:00:00.000Z",
    "expired_at": "2018-10-17T00:00:00.000Z",
    "status": "new",
    "reason": "unreceived_refund",
    "days_left": 123,
    "history": [
      {
        "attachments": [
          "attachment_1"
        ],
        "created_at": "2018-10-17T00:00:00.000Z",
        "created_by": "email address of the source",
        "content": "customer comment",
        "source": "merchant",
        "event_type": "dispute_created",
        "note": "additional comments"
      }
    ],
    "items": [
      {
        "reference_id": "payment id",
        "title": "Order item title",
        "unit_price": "100.00"
      }
    ],
    "order_number": "#1234",
    "comment": "additional comments"
  }
}
```

--------------------------------

### Install Tabby extension with Composer

Source: https://docs.tabby.ai/e-commerce-platforms/magento-2

Run these commands to install the Tabby metapackage and enable the required modules. This sequence also upgrades the database, compiles DI, deploys static content, and flushes the cache.

```bash
composer require tabby/m2-payments
php bin/magento module:enable Tabby_Checkout Tabby_Feed
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy -f
php bin/magento cache:flush
```

--------------------------------

### Go example for challenging a dispute

Source: https://docs.tabby.ai/api-reference/disputes/challenge-disputes

Uses net/http to send a POST request with a JSON string payload. Prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.tabby.ai/api/v1/disputes/challenge"

	payload := strings.NewReader("{\n  \"dispute_id\": \"uuid\",\n  \"description\": \"Comment for Tabby support\",\n  \"reason\": \"merchant_reason_other\",\n  \"amount\": \"100\",\n  \"attachment_ids\": [\n    \"attachment id, uuid format\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### PHP cURL example to retrieve all dispute webhooks

Source: https://docs.tabby.ai/api-reference/dispute-webhooks/retrieve-all-dispute-webhooks

Uses PHP cURL to send a GET request with the required headers and handles errors.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tabby.ai/api/v1/dispute-webhooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Merchant-Code: <x-merchant-code>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### Python request to retrieve all webhooks

Source: https://docs.tabby.ai/api-reference/webhooks/retrieve-all-webhooks

Python script using the requests library to GET all webhooks. Requires the requests package and the same headers as the cURL example.

```python
import requests

url = "https://api.tabby.ai/api/v1/webhooks"

headers = {
    "X-Merchant-Code": "<x-merchant-code>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### Product and Cart page snippet: TabbyPromo initialization

Source: https://docs.tabby.ai/pay-in-4-custom-integration/on-site-messaging

Include the Tabby Promo script and initialize the TabbyPromo component after the script loads. Required parameters: selector, currency, price, publicKey, merchantCode. Optional: lang, source, shouldInheritBg. Re-initialize when the price changes.

```html
<script src="https://checkout.tabby.ai/tabby-promo.js"></script>
<script>
  new TabbyPromo({
    selector: '#TabbyPromo', // required
    currency: 'AED', // required, 'AED' or 'SAR', uppercase, no spaces
    price: '2000.00', // required, 2 decimal places for AED and SAR
    lang: 'en', // optional, 'en' or 'ar'
    source: 'product', // optional, 'product' or 'cart'
    shouldInheritBg: false, // optional, true or false
    publicKey: 'your_pk', // required, your public key
    merchantCode: 'your_merchant_code' // required, your merchant code, based on your store currency
  });
</script>
```

--------------------------------

### Session creation response JSON

Source: https://docs.tabby.ai/api-reference/checkout/session-payload-model

Example response body for a successful session creation (200 OK). The payment object echoes the request payload. Save payment.id for later verify, capture, and refund calls. The installments array's first element contains the web_url for the Hosted Payment Page; validate it before redirecting.

```json
{
  "id": "e5f9d6c8-...",                  // session id
  "status": "created",                    // "created" | "rejected" | "expired"
  "payment": {
    "id": "01a04380-64b8-8432-a20f-904a48584390",  // payment id — SAVE IT: used to verify, capture and refund
    "created_at": "2026-01-20T09:12:00Z",
    "status": "CREATED",
    "is_test": true,
    "amount": "100.00",
    "currency": "AED"
    // ...the rest of your request payload echoed back
  },
  "configuration": {
    "available_products": {
      "installments": [
        {
          "web_url": "https://checkout.tabby.ai/?sessionId=...&apiKey=pk_test_...&product=installments",
          "qr_code": "https://api.tabby.ai/api/v2/checkout/.../hpp_link_qr?product_type=installments"
        }
      ]
    },
    "products": {
      "installments": {
        "type": "installments",
        "is_available": true,
        "rejection_reason": null
      }
    }
  },
  "merchant_urls": {
    "success": "https://your-store/success",
    "cancel": "https://your-store/cancel",
    "failure": "https://your-store/failure"
  },
  "merchant": {
    "name": "Your store name"
  }
}
```

--------------------------------

### Create checkout session with C#

Source: https://docs.tabby.ai/pay-in-4-custom-integration/quick-start

C# example using HttpClient to create a checkout session. It sends the payload from the cURL tab and redirects to the HPP web_url if the session is created. Save the payment ID before redirecting.

```csharp
using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("TABBY_SECRET_KEY"));

var res = await http.PostAsJsonAsync("https://api.tabby.ai/api/v2/checkout", payload); // the JSON from the cURL tab
var session = await res.Content.ReadFromJsonAsync<JsonElement>();

var status = session.GetProperty("status").GetString();
var installments = session.GetProperty("configuration")
    .GetProperty("available_products").TryGetProperty("installments", out var arr) ? arr : default;
if (status == "created" && installments.ValueKind == JsonValueKind.Array && installments.GetArrayLength() > 0)
{
    var webUrl = installments[0].GetProperty("web_url").GetString(); // save payment.id first
    return Redirect(webUrl);
}
// status "rejected" (or missing web_url): show the rejection message
```

--------------------------------

### Enable and rebuild Magento module

Source: https://docs.tabby.ai/e-commerce-platforms/magento-2/magento-2-plugin-installation

Run these commands to enable the Tabby_Checkout module and rebuild Magento after manual installation.

```bash
php bin/magento module:enable Tabby_Checkout
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy -f
php bin/magento cache:flush

```

--------------------------------

### Create a session with cURL (PHP)

Source: https://docs.tabby.ai/api-reference/checkout/create-a-session

Use this PHP cURL example to create a payment session. The payload includes order items, shipping address, consumer details, and merchant URLs. The Authorization header must contain a valid token. The response is printed to the output.

```php
curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tabby.ai/api/v2/checkout/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'items' => [
        [
            'title' => 'Item title',
            'quantity' => 1,
            'unit_price' => '100.00',
            'reference' => 'item reference',
            'product_url' => 'https://your-store/product',
            'image_url' => 'https://your-store/product/image',
            'category' => 'clothes',
            'options' => [
                [
                    'name' => 'Size',
                    'value' => 'M'
                ]
            ]
        ]
    ],
    'shipping_address' => [
        'city' => 'Dubai',
        'address' => 'Street 1',
        'zip' => '00000'
    ],
    'consumer' => [
        'first_name' => 'John',
        'last_name' => 'Doe',
        'phone' => '0000000000',
        'email' => 'john@doe.com'
    ],
    'order' => [
        'tax_amount' => '0.00',
        'shipping_amount' => '0.00',
        'payment_method' => 'card',
        'reference' => 'order-123',
        'items' => [
            [
                'title' => 'Item title',
                'quantity' => 1,
                'unit_price' => '100.00',
                'reference' => 'item reference',
                'product_url' => 'https://your-store/product',
                'image_url' => 'https://your-store/product/image',
                'category' => 'clothes',
                'options' => [
                    [
                        'name' => 'Size',
                        'value' => 'M'
                    ]
                ]
            ]
        ],
        'details' => [
            'shipping' => [
                'address' => [
                    'city' => 'Dubai',
                    'address' => 'Street 1',
                    'zip' => '00000'
                ]
            ],
            'items' => [
                [
                    'title' => 'Item title',
                    'quantity' => 1,
                    'unit_price' => '100.00',
                    'reference' => 'item reference',
                    'product_url' => 'https://your-store/product',
                    'image_url' => 'https://your-store/product/image',
                    'category' => 'clothes',
                    'options' => [
                        [
                            'name' => 'Size',
                            'value' => 'M'
                        ]
                    ]
                ]
            ]
        ]
    ],
    'description' => 'test payload',
    'meta' => [
        'customer' => '#customer-id',
        'order_id' => '#1234'
    ],
    'attachment' => [
        'body' => '{"flight_reservation_details": {"pnr": "TR9088999","itinerary": [...],"insurance": [...],"passengers": [...],"affiliate_name": "some affiliate"}}',
        'content_type' => 'application/vnd.tabby.v1+json'
    ],
    'lang' => 'en',
    'merchant_code' => 'code provided to you from Tabby side',
    'merchant_urls' => [
        'success' => 'https://your-store/success',
        'cancel' => 'https://your-store/cancel',
        'failure' => 'https://your-store/failure'
    ],
    'token' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### 404 error response example

Source: https://docs.tabby.ai/api-reference/disputes/challenge-disputes

Example of a 404 response body, a plain text message '404 page not found'.

```text
"404 page not found"
```

--------------------------------

### Java Unirest to get dispute by id

Source: https://docs.tabby.ai/api-reference/disputes/get-dispute-by-id

Uses Unirest to send a GET request and returns the response as a string.

```java
HttpResponse<String> response = Unirest.get("https://api.tabby.ai/api/v1/disputes/{disputeId}")
  .header("Authorization", "Bearer <token>")
  .asString();
```

--------------------------------

### Go HTTP request to get dispute by id

Source: https://docs.tabby.ai/api-reference/disputes/get-dispute-by-id

Uses net/http to send a GET request and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.tabby.ai/api/v1/disputes/{disputeId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```
Tokens:
Raw