Payments

Close a payment

Changed on Sep 23, 2026

Closed is the final status of the payment. Your payment is going to be closed automatically if you capture the full amount of the payment. If an order is fully cancelled, please close the payment without capturing it - the customer will be refunded for all paid amount. If only a part of the order is delivered, please capture this part and close the payment – it will mean that another part of the order is not going to be delivered to the customer.

post/api/v2/payments/{id}/close

Request

Base URL
https://api.tabby.ai
URL
https://api.tabby.ai/api/v2/payments/{id}/close
Auth
HTTP bearer

Path parameters

idstring uuid required

Example:payment id, uuid format

ID of the payment.

Response

Success. Payment object is returned.

idstring uuid

Unique identifier for the payment (UUID), assigned by Tabby. Save it on your side!

created_atstring date-time

Date and time the payment was created, in UTC, and displayed in ISO 8601 datetime format.

expires_atstring date-time

Date and time the payment expires, in UTC, and displayed in ISO 8601 datetime format.

status'CREATED' | 'AUTHORIZED' | 'CLOSED' | 'REJECTED' | 'EXPIRED'

Status of the current payment:

CREATED means that the payment is created successfully, but not finished yet;
AUTHORIZED and CLOSED mark the successfully approved and captured payments accordingly;
REJECTED is returned when a customer is rejected during Tabby Checkout;
EXPIRED is used when a customer cancels a payment or when Tabby doesn't receive a successfully paid transaction after timeout.

is_testboolean

Indicates whether this is a test payment (created using the Test API keys or Production API Keys).

amountstring required

Total payment amount, including tax, shipping and any discounts. Allows to send up to 2 decimals for AED and SAR, up to 3 decimals for KWD.

currency'AED' | 'SAR' required

ISO 4217 currency code for the payment amount. Currently there are 2 possible currency options - depending on the country where the store is located:

AED - United Arab Emirates Dirham
SAR - Saudi Riyal

descriptionstring nullable

refundsobject[] nullable

Example response

{
  "id": "payment id, uuid format",
  "status": "CLOSED",
  "amount": "100",
  "currency": "AED",
  "description": "description",
  "buyer": {
    "name": "John Doe",
    "phone": "500000001",
    "dob": "2000-01-20"
  },
  "shipping_address": {
    "city": "Dubai",
    "address": "Dubai",
    "zip": "1111"
  },
  "order": {
    "reference_id": "1001",
    "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"
      }
    ]
  },
  "captures": [
    {
      "id": "capture id, uuid format",
      "amount": "100",
      "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"
        }
      ],
      "reference_id": "capture idempotency key"
    }
  ],
  "order_history": [
    {
      "amount": "100",
      "payment_method": "card",
      "buyer": {
        "name": "John Doe",
        "phone": "500000001",
        "dob": "2000-01-20"
      },
      "shipping_address": {
        "city": "Dubai",
        "address": "Dubai",
        "zip": "1111"
      },
      "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"
        }
      ]
    }
  ],
  "meta": {
    "customer": "#customer-id",
    "order_id": "#1234"
  },
  "attachment": {
    "body": {
      "flight_reservation_details": {
        "itinerary": [
          {
            "departure_city": "departure_city",
            "departure_country": "departure_country",
            "arrival_city": "arrival_city",
            "arrival_country": "arrival_country",
            "carrier": "carrier",
            "class": "class"
          }
        ],
        "insurance": [
          {
            "insurance_company": "insurance_company",
            "insurance_type": "insurance_type"
          }
        ],
        "passengers": [
          {
            "full_name": "full_name",
            "first_name": "first_name",
            "last_name": "last_name",
            "dob": "2018-10-17",
            "document_type": "document_type",
            "document_id": "document_id",
            "nationality": "nationality",
            "gender": "F"
          }
        ],
        "pnr": "Trip booking number, e.g. TR9088999",
        "affiliate_name": "Name of the affiliate that originated the purchase. If none, leave blank."
      },
      "hotel_reservation_details": {
        "hotel_itinerary": [
          {
            "hotel_name": "hotel_name",
            "address": "address",
            "hotel_city": "hotel_city",
            "hotel_country": "hotel_country",
            "number_of_rooms": 1,
            "class": "class"
          }
        ],
        "insurance": [
          {
            "insurance_company": "insurance_company",
            "insurance_type": "insurance_type"
          }
        ],
        "passengers": [
          {
            "full_name": "full_name",
            "first_name": "first_name",
            "last_name": "last_name",
            "dob": "2018-10-17",
            "document_type": "document_type",
            "document_id": "document_id",
            "nationality": "nationality",
            "gender": "M"
          }
        ],
        "pnr": "TR9088999",
        "affiliate_name": "Name of the affiliate that originated the purchase. If none, leave blank."
      },
      "insurance_details": {
        "policy_details": {
          "insurance_type": "Insurance policy type",
          "insurance_start_dt": "2018-10-17",
          "insurance_end_dt": "2018-10-17",
          "insured_amount": "100",
          "car_details": {
            "manufacturer": "manufacturer",
            "model": "model",
            "year": "year"
          },
          "travel_details": {
            "departure_country": "departure_country",
            "arrival_country": "arrival_country"
          },
          "provider_name": "provider_name"
        },
        "client": {
          "first_name": "first_name",
          "last_name": "last_name",
          "document_type": "document_type",
          "full_name": "full_name",
          "dob": "2018-10-17",
          "document_id": "document_id",
          "nationality": "nationality",
          "gender": "F"
        },
        "payment_history_simple": {
          "unique_account_identifier": "unique name / id of the customer"
        }
      },
      "payment_history_full": {
        "unique_account_identifier": "unique name / id of the customer",
        "payment_option": "card",
        "number_paid_purchases": 1,
        "total_amount_paid_purchases": 1,
        "count_paid_purchases_last_month": 1,
        "amount_paid_purchases_last_month": 1,
        "max_paid_amount_for_1purchase": 1
      },
      "payment_history_simple": {
        "unique_account_identifier": "unique name / id of the customer"
      },
      "flight_points_simple": {
        "origin": {
          "air_code": "JFK",
          "city_code": "NYC"
        },
        "destination": {
          "air_code": "LAX",
          "city_code": "LAX"
        }
      },
      "marketplaces": {
        "seller_id": "57327813",
        "seller_name": "Pet Shop",
        "seller_category": "Electronics",
        "seller_website": "https://www.petshop.com",
        "seller_phone": "500000001",
        "seller_commercial_registration_number": "1012345678"
      },
      "education_details": {
        "merchant_subtype": "formal_education",
        "program": {
          "payment_tenure_months": 6,
          "months_to_completion": 9
        },
        "student_history": {
          "late_payments_count": 2,
          "avg_overdue_duration_days": 4.5,
          "observation_window_months": 12
        }
      }
    }
  }
}

Changes

Sep 23, 20265c292c22017a Revision changes
- breaking
  the response property / became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property ///// became optional for the status
- breaking
  the response property ///// became optional for the status
- breaking
  the response property ///// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property ///// became optional for the status
- breaking
  the response property ///// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property / became optional for the status
Aug 28, 2026cff62a2a6ee9 Revision changes
- breaking
  the response's body type changed from string to object for status
- info
  removed the non-success response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  removed the KWD enum value from the response property for the response status

Operation history