Skip to content

Gift cards

Gift cards and their balances. Every example sets SOOQUNA_TOKEN from the environment; see authentication. Responses are from a test store, cut to two items per list.

Endpoint Method Path
Issue a gift card POST /gift-cards
List gift cards GET /gift-cards
Get a gift card GET /gift-cards/{id}
Update a gift card PUT /gift-cards/{id}
Adjust a gift card’s balance POST /gift-cards/{id}/adjust
Disable a gift card POST /gift-cards/{id}/disable
Enable a gift card POST /gift-cards/{id}/enable

POST /gift-cards · Scope: write_gift_cards

Terminal window
curl -X POST "https://api.sooquna.com/admin/api/2026-10/gift-cards" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"value": "250.00",
"recipient_email": "[email protected]",
"recipient_name": "Noora",
"message": "Eid Mubarak!",
"no_expiry": true,
"notify": false
}'
Response 201
{
"balance": 25000,
"code": "F99N Y2QF CNQ5 5Z99",
"created_at": "2026-10-18T09:30:00Z",
"created_by": "Docs",
"currency": "QAR",
"customer_id": null,
"disabled_at": null,
"expires_on": null,
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000015",
"initial_value": 25000,
"last4": "5Z99",
"message": "Eid Mubarak!",
"note": "",
"order_id": null,
"recipient_email": "[email protected]",
"recipient_name": "Noora",
"send_at": null,
"sent_at": null,
"source": "manual",
"status": "active",
"transactions": [
{
"actor": "Docs",
"amount": 25000,
"balance_after": 25000,
"created_at": "2026-10-18T09:30:00Z",
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000016",
"kind": "issue",
"note": "Issued",
"order_id": null
}
],
"version": 1
}

GET /gift-cards · Scope: read_gift_cards

Parameter In Description
status query For example active.
Terminal window
curl -X GET "https://api.sooquna.com/admin/api/2026-10/gift-cards?status=active" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"
Response 200
{
"data": [
{
"balance": 25000,
"created_at": "2026-10-18T09:30:00Z",
"created_by": "Docs",
"currency": "QAR",
"customer_id": null,
"disabled_at": null,
"expires_on": null,
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000015",
"initial_value": 25000,
"last4": "5Z99",
"message": "Eid Mubarak!",
"note": "",
"order_id": null,
"recipient_email": "[email protected]",
"recipient_name": "Noora",
"send_at": null,
"sent_at": null,
"source": "manual",
"status": "active",
"version": 1
}
],
"page_info": {"end_cursor": "", "has_next_page": false}
}

GET /gift-cards/{id} · Scope: read_gift_cards

Parameter In Description
id path The resource’s ID.
Terminal window
curl -X GET "https://api.sooquna.com/admin/api/2026-10/gift-cards/0193a1b2-c3d4-7e5f-8a6b-000000000015" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"
Response 200
{
"balance": 25000,
"created_at": "2026-10-18T09:30:00Z",
"created_by": "Docs",
"currency": "QAR",
"customer_id": null,
"disabled_at": null,
"expires_on": null,
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000015",
"initial_value": 25000,
"last4": "5Z99",
"message": "Eid Mubarak!",
"note": "",
"order_id": null,
"recipient_email": "[email protected]",
"recipient_name": "Noora",
"send_at": null,
"sent_at": null,
"source": "manual",
"status": "active",
"transactions": [
{
"actor": "Docs",
"amount": 25000,
"balance_after": 25000,
"created_at": "2026-10-18T09:30:00Z",
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000016",
"kind": "issue",
"note": "Issued",
"order_id": null
}
],
"version": 1
}

PUT /gift-cards/{id} · Scope: write_gift_cards

Parameter In Description
id path The resource’s ID.
Terminal window
curl -X PUT "https://api.sooquna.com/admin/api/2026-10/gift-cards/0193a1b2-c3d4-7e5f-8a6b-000000000015" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"expires_on": "2027-12-31",
"note": "Customer service goodwill",
"version": 1
}'
Response 200
{
"balance": 25000,
"created_at": "2026-10-18T09:30:00Z",
"created_by": "Docs",
"currency": "QAR",
"customer_id": null,
"disabled_at": null,
"expires_on": "2027-12-31",
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000015",
"initial_value": 25000,
"last4": "5Z99",
"message": "Eid Mubarak!",
"note": "Customer service goodwill",
"order_id": null,
"recipient_email": "[email protected]",
"recipient_name": "Noora",
"send_at": null,
"sent_at": null,
"source": "manual",
"status": "active",
"transactions": [
{
"actor": "Docs",
"amount": 25000,
"balance_after": 25000,
"created_at": "2026-10-18T09:30:00Z",
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000016",
"kind": "issue",
"note": "Issued",
"order_id": null
}
],
"version": 2
}

POST /gift-cards/{id}/adjust · Scope: write_gift_cards

A signed amount: +50.00 adds, -20.00 takes off.

Parameter In Description
id path The resource’s ID.
Terminal window
curl -X POST "https://api.sooquna.com/admin/api/2026-10/gift-cards/0193a1b2-c3d4-7e5f-8a6b-000000000015/adjust" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN" \
-H "Content-Type: application/json" \
-d '{"amount": "+50.00", "reason": "Delivery delay apology", "version": 1}'
Response 200
{
"balance": 30000,
"created_at": "2026-10-18T09:30:00Z",
"created_by": "Docs",
"currency": "QAR",
"customer_id": null,
"disabled_at": null,
"expires_on": "2027-12-31",
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000015",
"initial_value": 25000,
"last4": "5Z99",
"message": "Eid Mubarak!",
"note": "Customer service goodwill",
"order_id": null,
"recipient_email": "[email protected]",
"recipient_name": "Noora",
"send_at": null,
"sent_at": null,
"source": "manual",
"status": "active",
"transactions": [
{
"actor": "Docs",
"amount": 5000,
"balance_after": 30000,
"created_at": "2026-10-18T09:30:00Z",
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000053",
"kind": "adjust",
"note": "Delivery delay apology",
"order_id": null
},
{
"actor": "Docs",
"amount": 25000,
"balance_after": 25000,
"created_at": "2026-10-18T09:30:00Z",
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000016",
"kind": "issue",
"note": "Issued",
"order_id": null
}
],
"version": 3
}

POST /gift-cards/{id}/disable · Scope: write_gift_cards

Parameter In Description
id path The resource’s ID.
Terminal window
curl -X POST "https://api.sooquna.com/admin/api/2026-10/gift-cards/0193a1b2-c3d4-7e5f-8a6b-000000000015/disable" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"
Response 200
{
"balance": 30000,
"created_at": "2026-10-18T09:30:00Z",
"created_by": "Docs",
"currency": "QAR",
"customer_id": null,
"disabled_at": "2026-10-18T09:30:00Z",
"expires_on": "2027-12-31",
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000015",
"initial_value": 25000,
"last4": "5Z99",
"message": "Eid Mubarak!",
"note": "Customer service goodwill",
"order_id": null,
"recipient_email": "[email protected]",
"recipient_name": "Noora",
"send_at": null,
"sent_at": null,
"source": "manual",
"status": "disabled",
"transactions": [
{
"actor": "Docs",
"amount": 5000,
"balance_after": 30000,
"created_at": "2026-10-18T09:30:00Z",
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000053",
"kind": "adjust",
"note": "Delivery delay apology",
"order_id": null
},
{
"actor": "Docs",
"amount": 25000,
"balance_after": 25000,
"created_at": "2026-10-18T09:30:00Z",
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000016",
"kind": "issue",
"note": "Issued",
"order_id": null
}
],
"version": 4
}

POST /gift-cards/{id}/enable · Scope: write_gift_cards

Parameter In Description
id path The resource’s ID.
Terminal window
curl -X POST "https://api.sooquna.com/admin/api/2026-10/gift-cards/0193a1b2-c3d4-7e5f-8a6b-000000000015/enable" \
-H "X-Sooquna-Access-Token: $SOOQUNA_TOKEN"
Response 200
{
"balance": 30000,
"created_at": "2026-10-18T09:30:00Z",
"created_by": "Docs",
"currency": "QAR",
"customer_id": null,
"disabled_at": null,
"expires_on": "2027-12-31",
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000015",
"initial_value": 25000,
"last4": "5Z99",
"message": "Eid Mubarak!",
"note": "Customer service goodwill",
"order_id": null,
"recipient_email": "[email protected]",
"recipient_name": "Noora",
"send_at": null,
"sent_at": null,
"source": "manual",
"status": "active",
"transactions": [
{
"actor": "Docs",
"amount": 5000,
"balance_after": 30000,
"created_at": "2026-10-18T09:30:00Z",
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000053",
"kind": "adjust",
"note": "Delivery delay apology",
"order_id": null
},
{
"actor": "Docs",
"amount": 25000,
"balance_after": 25000,
"created_at": "2026-10-18T09:30:00Z",
"id": "0193a1b2-c3d4-7e5f-8a6b-000000000016",
"kind": "issue",
"note": "Issued",
"order_id": null
}
],
"version": 5
}

Was this page helpful?