GET
/
api
/
v2
/
payments
curl --request GET \
  --url https://api.tabby.ai/api/v2/payments \
  --header 'Authorization: Bearer <token>'
{
  "payments": [
    {
      "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"
      }
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total_count": 123
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
created_at__gte
string

This is a filter for the payment creation date, use it to get the list of payments where creation date >= created_at__gte. ISO 8601 date time format (greater than or equal). No time should be provided, it starts at 00:00:00 be default. For example 2020-01-23 -> 2020-01-23T00:00:00Z.

​
created_at__lte
string

This is a filter for the payment creation date, use it to get the list of payments where creation date <= created_at__lte. ISO 8601 date time format (less than or equal). No time should be provided, it starts at 00:00:00 be default. For example 2020-01-23 -> 2020-01-23T00:00:00Z.

​
limit
integer

Limits the number of returned results.

Required range: x <= 20
​
status
enum<string>

Filter the orders by specific statuses. "authorized", "closed" and "rejected" belong to the API payment statuses, while "new", "captured", "refunded" and "cancelled" refer to the statuses from Tabby Merchant Dashboard. If absent, all authorized and closed payments are returned.

Available options:
authorized,
closed,
rejected,
new,
captured,
refunded,
cancelled
Example:

"authorized"

​
offset
integer

The number of records into a dataset that you want to start, indexed at 0.

Response

200
application/json

Success. Returns a list of payments.

The response is of type object.