API reference · Catalogue

Read a subcategory

GET/v1/wallets/{walletId}/catalog/subcategories/{subcategoryId}

One subcategory.

Permissioncatalogue:read

AuthenticationSigned read

Anis’s answerNot signed

Staff-set limits it counts towardAll requests

.NET SDKanis.Catalogue.GetSubcategoryAsync(walletId, subcategoryId)

Parameters

Name	In	Type	Notes
`walletId`required	`path`	UUID	A UUID, lower-case with hyphens.
`subcategoryId`required	`path`	UUID	A UUID, lower-case with hyphens.

Request

Signed with your key. No body, no nonce.

Headers: Signature-Input, Signature, X-Anis-Date, Accept-Language (optional). The SDKs set all of them for you.

Body: none.

Responses

Status	Meaning	Body
200	Success.	CatalogueObject
400	Refused: the signed request is badly built.	Problem
401	Refused: not authenticated.	Problem
403	Refused: not allowed.	Problem
404	Refused: not found, or not yours.	Problem
429	Refused: a limit was reached.	Problem
503	No decision: a dependency was unavailable.	Problem

The answers of this call are not signed — no Signature or Signature-Input header, success or refusal. There is nothing to verify; TLS protects them. Content-Digest and X-Request-Id are still present.

Refusals

A refusal of this call is a problem without a signature. Branch on its code; each links to what it means and what to do.

Error	Code	Status
Invalid credentials	`invalid_credentials`	401
Malformed signed request	`malformed_signed_request`	400
Insufficient scope	`insufficient_scope`	403
Source address not allowed	`source_ip_not_allowed`	403
Rate limited	`rate_limited`	429
Account not authorised	`binding_not_authorized`	403
Account inactive	`account_inactive`	403
Wallet not granted	`wallet_not_granted`	404
Not found	`resource_not_found`	404
Service unavailable	`dependency_unavailable`	503
Request timeout	`request_timeout`	504
Internal error	`internal_error`	500

Types

CatalogueObject

One of: CatalogueCategory, CatalogueSubcategory, CatalogueCard — each route answers with exactly one of them.

CatalogueCategory

Field	Type	Notes
`id`always present	UUID	The category’s id.
`name`	LocalizedText	The category’s name, in Arabic and English.
`description`	LocalizedText	A description, in Arabic and English.
`logo`	string	The address of the category’s logo image.
`type`	string	Whether the category is local or international. Values: `local`, `international`
`inStock`always present	boolean	Whether anything in it can be bought now.
`displayOrder`always present	integer	The order to show categories in — lower first.

LocalizedText

Field	Type	Notes
`ar`	string	The Arabic text; omitted when empty.
`en`	string	The English text; omitted when empty.

CatalogueSubcategory

Field	Type	Notes
`id`always present	UUID	The subcategory’s id.
`categoryId`always present	UUID	The category it belongs to.
`categoryType`	string	Whether the category it belongs to is local or international. Absent if Anis has not set it. Values: `local`, `international`
`name`	LocalizedText	The subcategory’s name, in Arabic and English.
`description`	LocalizedText	A description, in Arabic and English.
`disclaimer`	any	Anis’s current note for buyers of this subcategory’s cards, in Arabic and English. Show it to your end customer before they buy. Absent when there is no note.
`logo`	string	The address of the subcategory’s logo image.
`isBestSelling`always present	boolean	Marked by Anis as a best seller.
`displayOrder`always present	integer	The order to show subcategories in — lower first.
`available`always present	boolean	Whether it can be bought from now.

CatalogueCard

Field	Type	Notes
`id`always present	UUID	The card’s id — the `cardId` an order carries.
`subcategoryId`always present	UUID	The subcategory it belongs to.
`name`	LocalizedText	The card’s name, in Arabic and English.
`faceValue`	string	The value printed on the card, when it has one.
`unitPrice`	Money	The price THIS wallet pays. Send it unchanged as the order’s `expectedUnitPrice`. A card without it cannot be sold to this wallet.
`businessPrice`	Money	For display. An order at this price can be refused as `price_changed`.
`personalPrice`	Money	The retail price, shown only while it is above the business price. For display.
`hasSpecialOffer`always present	boolean	Whether a special offer applies.
`specialOfferPrice`	Money	The offer price, shown only with a special offer. For display.
`available`always present	boolean	Whether the card can be bought now.
`minimumQuantity`always present	integer	Always 1: the platform minimum for an order.
`maximumQuantity`always present	integer	The platform order limit: 100. Stock and availability are checked separately.
`logo`	string	Absolute URL of the subcategory logo; omitted when empty.
`category`	object	The category, with id and localized name.
`category.id`	UUID	The category’s id.
`category.name`	LocalizedText	The category’s name in Arabic and English.
`category.type`	string	Whether the category is local or international. Absent if Anis has not set it. Values: `local`, `international`

Money

Field	Type	Notes
`amount`always present	string	A decimal string, never a JSON number. Wallet balances may be negative while allowed debt is used. Prices and totals follow each route's amount rules.
`currency`always present	string	An uppercase three-letter currency code, such as `LYD`. Read a wallet’s currency from `balance.currency`.
`asOf`	string (date-time)	When this price or balance was read.