v1
latestOpenAPI 3.1.02026-07-131991131.4 KBPayments
List of all payments
Returns a list of success payments (AUTHORIZED or CLOSED) you’ve previously created. The payments are returned in sorted order, with the most recent payments appearing first. Each entry in the array is a separate payments object, including the status, any captures and any refunds. If no more payments are available, the resulting array will be empty. Payments might be filtered by creation date.
get/api/v2/payments
Query parameters
created_at__gtestring date
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 to). 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__ltestring date-time
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 to). No time should be provided, it starts at 00:00:00 be default. For example 2020-01-23 -> 2020-01-23T00:00:00Z.
limitinteger
Limits the number of returned results.
status'authorized' | 'closed' | 'rejected' | 'new' | 'captured' | 'refunded' | 'cancelled'
Example:authorized
Filter the orders by specific statuses:
- authorized, closed and rejected belong to the API payment statuses;
- new, captured, refunded and `cancelled`` refer to the statuses on Tabby Merchant Dashboard;
- If absent, all AUTHORIZED and CLOSED payments are returned.
offsetinteger
The number of records into a dataset that you want to start, indexed at 0.
Response
Success. Returns a list of payments.
Example response
{
"payments": [
{
"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"
}
],
"refunds": [
{
"id": "refund id, uuid format",
"reason": "Reason for the refund",
"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": "refund 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": {
"pnr": "Trip booking number, e.g. TR9088999",
"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-17T00:00:00.000Z",
"document_type": "document_type",
"document_id": "document_id",
"nationality": "nationality",
"gender": "F"
}
],
"affiliate_name": "Name of the affiliate that originated the purchase. If none, leave blank."
},
"hotel_reservation_details": {
"pnr": "TR9088999",
"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-17T00:00:00.000Z",
"document_type": "document_type",
"document_id": "document_id",
"nationality": "nationality",
"gender": "M"
}
],
"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-17T00:00:00.000Z",
"insurance_end_dt": "2018-10-17T00:00:00.000Z",
"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": {
"full_name": "full_name",
"first_name": "first_name",
"last_name": "last_name",
"dob": "2018-10-17T00:00:00.000Z",
"document_type": "document_type",
"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
}
}
}
}
}
],
"pagination": {
"limit": 20,
"total_count": 100
}
}