POST
/
api
/
v2
/
checkout
curl --request POST \
  --url https://api.tabby.ai/api/v2/checkout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "payment": {
    "amount": "100",
    "currency": "AED",
    "description": "test payload",
    "buyer": {
      "phone": "500000001",
      "email": "jsmith@example.com",
      "name": "John Doe",
      "dob": "2000-01-20"
    },
    "shipping_address": {
      "city": "Dubai",
      "address": "Dubai",
      "zip": "1111"
    },
    "order": {
      "tax_amount": "0.00",
      "shipping_amount": "0.00",
      "discount_amount": "0.00",
      "updated_at": "2023-11-07T05:31:56Z",
      "reference_id": "1001",
      "items": [
        {
          "title": "Name of the product",
          "description": "Description of the product",
          "quantity": 1,
          "unit_price": "0.00",
          "discount_amount": "0.00",
          "reference_id": "SKU123",
          "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
        }
      ]
    },
    "buyer_history": {
      "registered_since": "2023-11-07T05:31:56Z",
      "loyalty_level": 0,
      "wishlist_count": 0,
      "is_social_networks_connected": true,
      "is_phone_number_verified": true,
      "is_email_verified": true
    },
    "order_history": [
      {
        "purchased_at": "2023-11-07T05:31:56Z",
        "amount": "100.00",
        "payment_method": "card",
        "status": "new",
        "buyer": {
          "phone": "500000001",
          "email": "jsmith@example.com",
          "name": "John Doe",
          "dob": "2000-01-20"
        },
        "shipping_address": {
          "city": "Dubai",
          "address": "Dubai",
          "zip": "1111"
        },
        "items": [
          {
            "title": "Name of the product",
            "description": "Description of the product",
            "quantity": 1,
            "unit_price": "0.00",
            "discount_amount": "0.00",
            "reference_id": "SKU123",
            "image_url": "https://example.com/",
            "product_url": "https://example.com/",
            "ordered": 0,
            "captured": 0,
            "shipped": 0,
            "refunded": 0,
            "gender": "Other",
            "category": "Skirt",
            "color": "blue",
            "product_material": "Synthetic",
            "size_type": "UK",
            "size": "8",
            "brand": "Name of the Brand"
          }
        ]
      }
    ],
    "meta": {
      "order_id": "#1234",
      "customer": "#customer-id"
    },
    "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
}'
{
  "id": "session id, uuid format",
  "configuration": {
    "available_products": {
      "installments": [
        {
          "web_url": "https://api.tabby.ai/",
          "qr_code": "https://api.tabby.ai/api/v2/checkout/{id}/hpp_link_qr"
        }
      ]
    },
    "expires_at": "2023-11-07T05:31:56Z",
    "products": {
      "installments": {
        "type": "installments",
        "is_available": true,
        "rejection_reason": null
      }
    },
    "payment": {
      "id": "payment id, uuid format",
      "created_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z",
      "status": "CREATED",
      "is_test": true,
      "amount": "100",
      "currency": "AED",
      "description": "test payload",
      "buyer": {
        "phone": "500000001",
        "email": "jsmith@example.com",
        "name": "John Doe",
        "dob": "2000-01-20"
      },
      "shipping_address": {
        "city": "Dubai",
        "address": "Dubai",
        "zip": "1111"
      },
      "order": {
        "tax_amount": "0.00",
        "shipping_amount": "0.00",
        "discount_amount": "0.00",
        "updated_at": "2023-11-07T05:31:56Z",
        "reference_id": "1001",
        "items": [
          {
            "title": "Name of the product",
            "description": "Description of the product",
            "quantity": 1,
            "unit_price": "0.00",
            "discount_amount": "0.00",
            "reference_id": "SKU123",
            "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
          }
        ]
      },
      "captures": [
        {
          "id": "capture id, uuid format",
          "amount": "100.00",
          "reference_id": "1001",
          "tax_amount": "0.00",
          "shipping_amount": "0.00",
          "discount_amount": "0.00",
          "created_at": "2023-11-07T05:31:56Z",
          "items": [
            {
              "title": "Name of the product",
              "description": "Description of the product",
              "quantity": 1,
              "unit_price": "0.00",
              "discount_amount": "0.00",
              "reference_id": "SKU123",
              "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
            }
          ]
        }
      ],
      "refunds": [
        {
          "id": "refund id, uuid format",
          "amount": "0.00",
          "reference_id": "1001",
          "reason": "Reason for the refund",
          "created_at": "2023-11-07T05:31:56Z",
          "items": [
            {
              "title": "Name of the product",
              "description": "Description of the product",
              "quantity": 1,
              "unit_price": "0.00",
              "discount_amount": "0.00",
              "reference_id": "SKU123",
              "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
            }
          ]
        }
      ],
      "buyer_history": {
        "registered_since": "2023-11-07T05:31:56Z",
        "loyalty_level": 0,
        "wishlist_count": 0,
        "is_social_networks_connected": true,
        "is_phone_number_verified": true,
        "is_email_verified": true
      },
      "order_history": [
        {
          "purchased_at": "2023-11-07T05:31:56Z",
          "amount": "100.00",
          "payment_method": "card",
          "status": "new",
          "buyer": {
            "phone": "500000001",
            "email": "jsmith@example.com",
            "name": "John Doe",
            "dob": "2000-01-20"
          },
          "shipping_address": {
            "city": "Dubai",
            "address": "Dubai",
            "zip": "1111"
          },
          "items": [
            {
              "title": "Name of the product",
              "description": "Description of the product",
              "quantity": 1,
              "unit_price": "0.00",
              "discount_amount": "0.00",
              "reference_id": "SKU123",
              "image_url": "https://example.com/",
              "product_url": "https://example.com/",
              "ordered": 0,
              "captured": 0,
              "shipped": 0,
              "refunded": 0,
              "gender": "Other",
              "category": "Skirt",
              "color": "blue",
              "product_material": "Synthetic",
              "size_type": "UK",
              "size": "8",
              "brand": "Name of the Brand"
            }
          ]
        }
      ],
      "meta": {
        "order_id": "#1234",
        "customer": "#customer-id"
      },
      "attachment": {
        "body": "{\"flight_reservation_details\": {\"pnr\": \"TR9088999\",\"itinerary\": [...],\"insurance\": [...],\"passengers\": [...],\"affiliate_name\": \"some affiliate\"}}",
        "content_type": "application/vnd.tabby.v1+json"
      }
    },
    "status": "created",
    "token": null,
    "merchant_urls": {
      "success": "https://your-store/success",
      "cancel": "https://your-store/cancel",
      "failure": "https://your-store/failure"
    },
    "lang": "eng",
    "merchant": {
      "name": "Your store name with Tabby",
      "address": "a, a",
      "logo": "https://example.com/"
    },
    "merchant_code": "code provided to you from Tabby side"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Response

200
application/json

Success. Checkout session object is returned.

The response is of type object.