API reference · Owned cards
Reveal a card
/v1/wallets/{walletId}/owned-cards/{soldCardId}/revealPOST /v1/wallets/{walletId}/owned-cards/{soldCardId}/reveal — Shows one bought card’s codes. Sends no body.
cards:revealanis.OwnedCards.RevealAsync(walletId, soldCardId)Parameters
| Name | In | Type | Notes |
|---|---|---|---|
walletIdrequired | path | UUID | A UUID, lower-case with hyphens. |
soldCardIdrequired | path | UUID | A UUID, lower-case with hyphens. |
Request
Signed with your key, with a one-time nonce and a digest of the body.
Headers: Signature-Input, Signature, Content-Digest, Nonce, X-Anis-Date, Accept-Language (optional). The SDKs set all of them for you.
Body: No body at all — not even {}. Any byte is refused with validation_failed. The signature still covers the digest of the empty body.
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | Success. | RevealedCredential |
| 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 |
| 409 | Refused: conflicts with the current state. | Problem |
| 422 | Refused: the request breaks a rule. | Problem |
| 429 | Refused: a limit was reached. | Problem |
| 503 | No decision: a dependency was unavailable. | Problem |
Every answer of this call is signed by Anis — success and every refusal. Require the signature and verify it before you act on the answer; an answer without one is a failure, never an answer (how).
Refusals
Every refusal of this call is a signed problem. 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 |
| Replay detected | replay_detected | 409 |
| Account not authorised | binding_not_authorized | 403 |
| Account inactive | account_inactive | 403 |
| Wallet not granted | wallet_not_granted | 404 |
| Card not found | card_not_found | 404 |
| Validation failed | validation_failed | 422 |
| Reveal not allowed | reveal_not_allowed | 409 |
| Business subscription required | business_subscription_required | 409 |
| Wallet disabled | wallet_disabled | 409 |
| Wallet expired | wallet_expired | 409 |
| Service unavailable | dependency_unavailable | 503 |
| Request timeout | request_timeout | 504 |
| Internal error | internal_error | 500 |
Types
RevealedCredential
| Field | Type | Notes |
|---|---|---|
soldCardIdalways present | UUID | The sold card these codes belong to. |
serialNumber | string | The card’s serial number. A secret: store it where you keep secrets and never log it. |
voucher | string | The card’s voucher code. A secret: store it where you keep secrets and never log it. |
revealedAt | string (date-time) | When it was revealed. |
expiryDate | string (date) | The last day the card can be used, as yyyy-MM-dd. Tell your end customer. Absent when the card has none. |
invoiceId | any | The invoice the card is on. Also inside an order’s soldCards. |
card | CardSummary | The catalogue card that was sold, so you know which card these codes are for. Also inside an order’s soldCards. |
purchasedAt | string (date-time) | When the card was bought. Also inside an order’s soldCards. |
CardSummary
| Field | Type | Notes |
|---|---|---|
id | UUID | The catalogue card’s id. |
name | LocalizedText | The card name in Arabic and English; empty localized text is omitted. |
faceValue | string | Optional printed value; absent when empty. |
logo | string | Optional absolute URL of the subcategory logo; absent when empty. |
subcategory | object | The card’s subcategory, with id and localized name. |
subcategory.id | UUID | The subcategory’s id. |
subcategory.name | LocalizedText | The subcategory’s name in Arabic and English. |
category | object | The card’s category, with id and localized name. |
category.id | UUID | The category’s id. |
category.name | LocalizedText | The category’s name in Arabic and English. |
LocalizedText
| Field | Type | Notes |
|---|---|---|
ar | string | The Arabic text; omitted when empty. |
en | string | The English text; omitted when empty. |