> For the complete documentation index, see [llms.txt](https://apidocs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.akinon.com/commerce-openapis/dynamic-bin-scheduler/models.md).

# Models

## The CurrencyType object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"CurrencyType":{"type":"string","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"],"description":"ISO 4217 currency codes supported by Bankaci"}}}}
```

## The PromotionStatus object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"PromotionStatus":{"type":"string","enum":["ACTIVE","PASSIVE","EXPIRED"],"description":"Lifecycle status of a promotion"}}}}
```

## The PreorderCardRequest object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"PreorderCardRequest":{"type":"object","required":["card_number","basket_id","basket_modified_date"],"properties":{"card_number":{"type":"string","description":"Raw card number. Must be exactly 15 or 16 digits."},"basket_id":{"type":"integer","description":"Omnitron basket ID"},"basket_modified_date":{"type":"string","format":"date-time","description":"Last modification timestamp of the basket (ISO 8601)"},"currency":{"$ref":"#/components/schemas/CurrencyType"}}},"CurrencyType":{"type":"string","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"],"description":"ISO 4217 currency codes supported by Bankaci"}}}}
```

## The PreorderSavedCardRequest object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"PreorderSavedCardRequest":{"type":"object","required":["card_token","masked_card_number","basket_id","basket_modified_date"],"properties":{"card_token":{"type":"string","description":"TapPay card token in the format `{card_id}||{customer_id}`"},"masked_card_number":{"type":"string","description":"Masked card number. Minimum 6 characters. The first 6 characters are used as\nthe BIN-6 prefix for promotion matching. Must match the BIN returned by TapPay.\n","minLength":6},"basket_id":{"type":"integer","description":"Omnitron basket ID"},"basket_modified_date":{"type":"string","format":"date-time","description":"Last modification timestamp of the basket (ISO 8601)"},"currency":{"$ref":"#/components/schemas/CurrencyType"}}},"CurrencyType":{"type":"string","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"],"description":"ISO 4217 currency codes supported by Bankaci"}}}}
```

## The BasketRequest object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"BasketRequest":{"type":"object","required":["id","modified_date"],"properties":{"id":{"type":"integer","description":"Omnitron basket ID"},"modified_date":{"type":"string","format":"date-time","description":"Last modification timestamp of the basket (ISO 8601)"},"voucher_code":{"type":"string","nullable":true,"description":"Optional voucher code applied to the basket. When provided, only promotions\nwith `usable_with_voucher_code: true` are returned.\n"}}}}}}
```

## The BasketOfferItem object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"BasketOfferItem":{"type":"object","properties":{"basket_offer_id":{"type":"integer","description":"Omnitron BasketOffer ID to activate for this basket"},"session_code":{"type":"string","format":"uuid","description":"Unique session UUID linking this activation to its `PreOrderCall` record.\nUsed internally for usage verification.\n"}}}}}}
```

## The BasketOfferResponse object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"BasketOfferResponse":{"type":"object","properties":{"basket_offers":{"type":"array","items":{"$ref":"#/components/schemas/BasketOfferItem"},"description":"Basket offer activations eligible for this card/basket combination.\nEmpty array when no promotions match the card BIN.\n"}}},"BasketOfferItem":{"type":"object","properties":{"basket_offer_id":{"type":"integer","description":"Omnitron BasketOffer ID to activate for this basket"},"session_code":{"type":"string","format":"uuid","description":"Unique session UUID linking this activation to its `PreOrderCall` record.\nUsed internally for usage verification.\n"}}}}}}
```

## The CardInput object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"CardInput":{"type":"object","required":["card_token","masked_card_number"],"properties":{"card_token":{"type":"string","description":"TapPay card token in the format `{card_id}||{customer_id}`"},"masked_card_number":{"type":"string","description":"Masked card number (min 6 chars; first 6 used as BIN-6)","minLength":6}}}}}}
```

## The BulkPromotionsRequest object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"BulkPromotionsRequest":{"type":"object","required":["cards"],"properties":{"cards":{"type":"array","items":{"$ref":"#/components/schemas/CardInput"},"minItems":1,"maxItems":50,"description":"List of saved cards to query. Duplicates (by `card_token`) are silently removed\nwhile preserving original order.\n"},"currency":{"$ref":"#/components/schemas/CurrencyType"}}},"CardInput":{"type":"object","required":["card_token","masked_card_number"],"properties":{"card_token":{"type":"string","description":"TapPay card token in the format `{card_id}||{customer_id}`"},"masked_card_number":{"type":"string","description":"Masked card number (min 6 chars; first 6 used as BIN-6)","minLength":6}}},"CurrencyType":{"type":"string","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"],"description":"ISO 4217 currency codes supported by Bankaci"}}}}
```

## The PromotionDetail object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"PromotionDetail":{"type":"object","properties":{"title":{"type":"string","description":"Human-readable promotion title"},"basket_offer_ids":{"type":"array","items":{"type":"string"},"description":"Omnitron BasketOffer IDs associated with this promotion"},"priority":{"type":"integer","description":"Promotion priority. Higher value = higher priority in offer ordering."},"per_card_limit":{"type":"integer","description":"Maximum uses per tokenized card within the current reset period"},"end_date":{"type":"string","format":"date-time","description":"Promotion expiry date (ISO 8601)"},"usable_with_voucher_code":{"type":"boolean","description":"Whether this promotion can be stacked with a voucher code.\nWhen `false`, the promotion is excluded when the basket has a voucher code applied.\n"}}}}}}
```

## The CardPromotions object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"CardPromotions":{"type":"object","properties":{"card_token":{"type":"string","description":"The input card token (echoed back)"},"bin_6":{"type":"string","nullable":true,"description":"First 6 digits of the resolved card number. `null` when the TapPay lookup failed.\nNote: for cards whose BIN has no matching promotions, `bin_6` is still returned\n(extracted from `masked_card_number`) with an empty `promotions` array.\n"},"promotions":{"type":"array","items":{"$ref":"#/components/schemas/PromotionDetail"},"description":"Available promotions for this card. Filtered by `per_card_limit` within the\ncurrent reset period. Empty when no promotions match or the card lookup failed.\n"},"error":{"type":"string","nullable":true,"description":"Per-card error message. `null` on success. Do not display to end users.\nPossible values: `\"Invalid token format\"`, `\"Card not found\"`,\n`\"Card lookup timeout\"`, `\"Request timeout exceeded\"`, `\"Card lookup failed\"`,\n`\"Rate limit exceeded, retry later\"`.\n"}}},"PromotionDetail":{"type":"object","properties":{"title":{"type":"string","description":"Human-readable promotion title"},"basket_offer_ids":{"type":"array","items":{"type":"string"},"description":"Omnitron BasketOffer IDs associated with this promotion"},"priority":{"type":"integer","description":"Promotion priority. Higher value = higher priority in offer ordering."},"per_card_limit":{"type":"integer","description":"Maximum uses per tokenized card within the current reset period"},"end_date":{"type":"string","format":"date-time","description":"Promotion expiry date (ISO 8601)"},"usable_with_voucher_code":{"type":"boolean","description":"Whether this promotion can be stacked with a voucher code.\nWhen `false`, the promotion is excluded when the basket has a voucher code applied.\n"}}}}}}
```

## The BulkPromotionsMeta object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"BulkPromotionsMeta":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of unique card tokens processed (after deduplication)"},"success_count":{"type":"integer","description":"Number of cards successfully resolved via TapPay"},"error_count":{"type":"integer","description":"Number of cards that failed during lookup"}}}}}}
```

## The BulkPromotionsResponse object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"BulkPromotionsResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/CardPromotions"},"description":"One entry per input card (after deduplication), in original input order.\nCards whose BIN has no active promotion are included with `promotions: []` and\n`error: null` — they were skipped without a TapPay call.\n"},"errors":{"type":"array","items":{"type":"object","properties":{"card_token":{"type":"string"},"error":{"type":"string"}}},"description":"Aggregated list of per-card errors (subset of `results` where `error != null`)"},"meta":{"$ref":"#/components/schemas/BulkPromotionsMeta"}}},"CardPromotions":{"type":"object","properties":{"card_token":{"type":"string","description":"The input card token (echoed back)"},"bin_6":{"type":"string","nullable":true,"description":"First 6 digits of the resolved card number. `null` when the TapPay lookup failed.\nNote: for cards whose BIN has no matching promotions, `bin_6` is still returned\n(extracted from `masked_card_number`) with an empty `promotions` array.\n"},"promotions":{"type":"array","items":{"$ref":"#/components/schemas/PromotionDetail"},"description":"Available promotions for this card. Filtered by `per_card_limit` within the\ncurrent reset period. Empty when no promotions match or the card lookup failed.\n"},"error":{"type":"string","nullable":true,"description":"Per-card error message. `null` on success. Do not display to end users.\nPossible values: `\"Invalid token format\"`, `\"Card not found\"`,\n`\"Card lookup timeout\"`, `\"Request timeout exceeded\"`, `\"Card lookup failed\"`,\n`\"Rate limit exceeded, retry later\"`.\n"}}},"PromotionDetail":{"type":"object","properties":{"title":{"type":"string","description":"Human-readable promotion title"},"basket_offer_ids":{"type":"array","items":{"type":"string"},"description":"Omnitron BasketOffer IDs associated with this promotion"},"priority":{"type":"integer","description":"Promotion priority. Higher value = higher priority in offer ordering."},"per_card_limit":{"type":"integer","description":"Maximum uses per tokenized card within the current reset period"},"end_date":{"type":"string","format":"date-time","description":"Promotion expiry date (ISO 8601)"},"usable_with_voucher_code":{"type":"boolean","description":"Whether this promotion can be stacked with a voucher code.\nWhen `false`, the promotion is excluded when the basket has a voucher code applied.\n"}}},"BulkPromotionsMeta":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of unique card tokens processed (after deduplication)"},"success_count":{"type":"integer","description":"Number of cards successfully resolved via TapPay"},"error_count":{"type":"integer","description":"Number of cards that failed during lookup"}}}}}}
```

## The ValidationError object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"ValidationError":{"type":"object","properties":{"detail":{"type":"array","items":{"type":"object","properties":{"loc":{"type":"array","items":{"type":"string"}},"msg":{"type":"string"},"type":{"type":"string"}}}}}}}}}
```

## The PromotionOut object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"PromotionOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true},"title":{"type":"string","maxLength":255},"status":{"$ref":"#/components/schemas/PromotionStatus"},"currency":{"$ref":"#/components/schemas/CurrencyType"},"per_card_limit":{"type":"integer","default":1,"description":"Maximum uses per tokenized card within the reset period"},"reset_schedule":{"type":"string","nullable":true,"description":"Cron expression for when `per_card_limit` resets. `null` = lifetime limit (never resets).\nExample: `\"0 0 * * *\"` resets the counter daily at midnight UTC.\n"},"bin_6_list":{"type":"array","items":{"type":"string","maxLength":6},"description":"6-digit card BIN prefixes this promotion applies to"},"priority":{"type":"integer","default":0,"description":"Higher value = shown first in promotion listings"},"basket_offer_ids":{"type":"array","items":{"type":"string","maxLength":255},"description":"Omnitron `BasketOffer` IDs to activate when this promotion matches.\nAlso used to verify actual discount application via `DiscountItem.conditional_offer`.\n"},"start_date":{"type":"string","format":"date-time","description":"Promotion start date (inclusive)"},"end_date":{"type":"string","format":"date-time","description":"Promotion end date (exclusive)"},"usable_with_voucher_code":{"type":"boolean","default":false,"description":"Whether this promotion can be stacked with a voucher code"}}},"PromotionStatus":{"type":"string","enum":["ACTIVE","PASSIVE","EXPIRED"],"description":"Lifecycle status of a promotion"},"CurrencyType":{"type":"string","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"],"description":"ISO 4217 currency codes supported by Bankaci"}}}}
```

## The PromotionIn object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"PromotionIn":{"type":"object","required":["title","bin_6_list","basket_offer_ids","start_date","end_date"],"properties":{"title":{"type":"string","maxLength":255},"status":{"$ref":"#/components/schemas/PromotionStatus"},"currency":{"$ref":"#/components/schemas/CurrencyType"},"per_card_limit":{"type":"integer","default":1},"reset_schedule":{"type":"string","nullable":true,"description":"Valid cron expression (validated on write). `null` for lifetime limit."},"bin_6_list":{"type":"array","items":{"type":"string","maxLength":6}},"priority":{"type":"integer","default":0},"basket_offer_ids":{"type":"array","items":{"type":"string","maxLength":255}},"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"usable_with_voucher_code":{"type":"boolean","default":false}}},"PromotionStatus":{"type":"string","enum":["ACTIVE","PASSIVE","EXPIRED"],"description":"Lifecycle status of a promotion"},"CurrencyType":{"type":"string","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"],"description":"ISO 4217 currency codes supported by Bankaci"}}}}
```

## The PromotionPatch object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"PromotionPatch":{"type":"object","description":"All fields are optional for partial update","properties":{"title":{"type":"string","maxLength":255},"status":{"$ref":"#/components/schemas/PromotionStatus"},"currency":{"$ref":"#/components/schemas/CurrencyType"},"per_card_limit":{"type":"integer"},"reset_schedule":{"type":"string","nullable":true},"bin_6_list":{"type":"array","items":{"type":"string","maxLength":6}},"priority":{"type":"integer"},"basket_offer_ids":{"type":"array","items":{"type":"string"}},"start_date":{"type":"string","format":"date-time"},"end_date":{"type":"string","format":"date-time"},"usable_with_voucher_code":{"type":"boolean"}}},"PromotionStatus":{"type":"string","enum":["ACTIVE","PASSIVE","EXPIRED"],"description":"Lifecycle status of a promotion"},"CurrencyType":{"type":"string","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"],"description":"ISO 4217 currency codes supported by Bankaci"}}}}
```

## The BulkStatusUpdateIn object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"BulkStatusUpdateIn":{"type":"object","required":["promotion_ids","status"],"properties":{"promotion_ids":{"type":"array","items":{"type":"integer"},"description":"IDs of promotions to update"},"status":{"$ref":"#/components/schemas/PromotionStatus"}}},"PromotionStatus":{"type":"string","enum":["ACTIVE","PASSIVE","EXPIRED"],"description":"Lifecycle status of a promotion"}}}}
```

## The PreOrderOut object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"PreOrderOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"basket_id":{"type":"integer","description":"Omnitron basket ID"},"basket_modified_date":{"type":"string","format":"date-time"},"tokenized_card":{"type":"integer","description":"FK to TokenizedCard"},"bin_6":{"type":"string","maxLength":6},"fingerprint":{"type":"string","maxLength":1024,"description":"Unique card fingerprint from TapPay"},"currency":{"$ref":"#/components/schemas/CurrencyType"},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true}}},"CurrencyType":{"type":"string","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"],"description":"ISO 4217 currency codes supported by Bankaci"}}}}
```

## The PreOrderCallOut object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"PreOrderCallOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"pre_order":{"$ref":"#/components/schemas/PreOrderOut"},"promotion":{"$ref":"#/components/schemas/PromotionOut"},"uuid":{"type":"string","format":"uuid","description":"Session code returned to the client as `session_code`"},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true}}},"PreOrderOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"basket_id":{"type":"integer","description":"Omnitron basket ID"},"basket_modified_date":{"type":"string","format":"date-time"},"tokenized_card":{"type":"integer","description":"FK to TokenizedCard"},"bin_6":{"type":"string","maxLength":6},"fingerprint":{"type":"string","maxLength":1024,"description":"Unique card fingerprint from TapPay"},"currency":{"$ref":"#/components/schemas/CurrencyType"},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true}}},"CurrencyType":{"type":"string","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"],"description":"ISO 4217 currency codes supported by Bankaci"},"PromotionOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true},"title":{"type":"string","maxLength":255},"status":{"$ref":"#/components/schemas/PromotionStatus"},"currency":{"$ref":"#/components/schemas/CurrencyType"},"per_card_limit":{"type":"integer","default":1,"description":"Maximum uses per tokenized card within the reset period"},"reset_schedule":{"type":"string","nullable":true,"description":"Cron expression for when `per_card_limit` resets. `null` = lifetime limit (never resets).\nExample: `\"0 0 * * *\"` resets the counter daily at midnight UTC.\n"},"bin_6_list":{"type":"array","items":{"type":"string","maxLength":6},"description":"6-digit card BIN prefixes this promotion applies to"},"priority":{"type":"integer","default":0,"description":"Higher value = shown first in promotion listings"},"basket_offer_ids":{"type":"array","items":{"type":"string","maxLength":255},"description":"Omnitron `BasketOffer` IDs to activate when this promotion matches.\nAlso used to verify actual discount application via `DiscountItem.conditional_offer`.\n"},"start_date":{"type":"string","format":"date-time","description":"Promotion start date (inclusive)"},"end_date":{"type":"string","format":"date-time","description":"Promotion end date (exclusive)"},"usable_with_voucher_code":{"type":"boolean","default":false,"description":"Whether this promotion can be stacked with a voucher code"}}},"PromotionStatus":{"type":"string","enum":["ACTIVE","PASSIVE","EXPIRED"],"description":"Lifecycle status of a promotion"}}}}
```

## The PromotionUsageOut object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"PromotionUsageOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"pre_order_call":{"$ref":"#/components/schemas/PreOrderCallOut"},"promotion":{"$ref":"#/components/schemas/PromotionOut"},"tokenized_card":{"type":"integer","description":"FK to TokenizedCard"},"basket_id":{"type":"string","description":"Omnitron basket ID (stored as string)"},"order_number":{"type":"string","nullable":true,"description":"Omnitron order number, populated after order is placed"},"fingerprint":{"type":"string","maxLength":1024},"reset_date":{"type":"string","format":"date-time","nullable":true,"description":"Date after which this usage record no longer counts toward `per_card_limit`.\nCalculated from `promotion.reset_schedule` at the time of order placement.\n`null` when the promotion has no reset schedule (lifetime limit).\n"},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true}}},"PreOrderCallOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"pre_order":{"$ref":"#/components/schemas/PreOrderOut"},"promotion":{"$ref":"#/components/schemas/PromotionOut"},"uuid":{"type":"string","format":"uuid","description":"Session code returned to the client as `session_code`"},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true}}},"PreOrderOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"basket_id":{"type":"integer","description":"Omnitron basket ID"},"basket_modified_date":{"type":"string","format":"date-time"},"tokenized_card":{"type":"integer","description":"FK to TokenizedCard"},"bin_6":{"type":"string","maxLength":6},"fingerprint":{"type":"string","maxLength":1024,"description":"Unique card fingerprint from TapPay"},"currency":{"$ref":"#/components/schemas/CurrencyType"},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true}}},"CurrencyType":{"type":"string","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"],"description":"ISO 4217 currency codes supported by Bankaci"},"PromotionOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true},"title":{"type":"string","maxLength":255},"status":{"$ref":"#/components/schemas/PromotionStatus"},"currency":{"$ref":"#/components/schemas/CurrencyType"},"per_card_limit":{"type":"integer","default":1,"description":"Maximum uses per tokenized card within the reset period"},"reset_schedule":{"type":"string","nullable":true,"description":"Cron expression for when `per_card_limit` resets. `null` = lifetime limit (never resets).\nExample: `\"0 0 * * *\"` resets the counter daily at midnight UTC.\n"},"bin_6_list":{"type":"array","items":{"type":"string","maxLength":6},"description":"6-digit card BIN prefixes this promotion applies to"},"priority":{"type":"integer","default":0,"description":"Higher value = shown first in promotion listings"},"basket_offer_ids":{"type":"array","items":{"type":"string","maxLength":255},"description":"Omnitron `BasketOffer` IDs to activate when this promotion matches.\nAlso used to verify actual discount application via `DiscountItem.conditional_offer`.\n"},"start_date":{"type":"string","format":"date-time","description":"Promotion start date (inclusive)"},"end_date":{"type":"string","format":"date-time","description":"Promotion end date (exclusive)"},"usable_with_voucher_code":{"type":"boolean","default":false,"description":"Whether this promotion can be stacked with a voucher code"}}},"PromotionStatus":{"type":"string","enum":["ACTIVE","PASSIVE","EXPIRED"],"description":"Lifecycle status of a promotion"}}}}
```

## The ChangeCapturePointerOut object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"ChangeCapturePointerOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"key":{"type":"string","maxLength":255,"description":"Unique CDC pointer key (e.g. `last_modified_date_minute`)"},"value":{"type":"string","nullable":true,"description":"Serialized pointer value (ISO 8601 string for datetime type)"},"value_type":{"type":"string","enum":["int","str","datetime"],"description":"Type hint used to deserialize `value`"},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true}}}}}}
```

## The PaginatedPromotionResponse object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"PaginatedPromotionResponse":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PromotionOut"}}}},"PromotionOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true},"title":{"type":"string","maxLength":255},"status":{"$ref":"#/components/schemas/PromotionStatus"},"currency":{"$ref":"#/components/schemas/CurrencyType"},"per_card_limit":{"type":"integer","default":1,"description":"Maximum uses per tokenized card within the reset period"},"reset_schedule":{"type":"string","nullable":true,"description":"Cron expression for when `per_card_limit` resets. `null` = lifetime limit (never resets).\nExample: `\"0 0 * * *\"` resets the counter daily at midnight UTC.\n"},"bin_6_list":{"type":"array","items":{"type":"string","maxLength":6},"description":"6-digit card BIN prefixes this promotion applies to"},"priority":{"type":"integer","default":0,"description":"Higher value = shown first in promotion listings"},"basket_offer_ids":{"type":"array","items":{"type":"string","maxLength":255},"description":"Omnitron `BasketOffer` IDs to activate when this promotion matches.\nAlso used to verify actual discount application via `DiscountItem.conditional_offer`.\n"},"start_date":{"type":"string","format":"date-time","description":"Promotion start date (inclusive)"},"end_date":{"type":"string","format":"date-time","description":"Promotion end date (exclusive)"},"usable_with_voucher_code":{"type":"boolean","default":false,"description":"Whether this promotion can be stacked with a voucher code"}}},"PromotionStatus":{"type":"string","enum":["ACTIVE","PASSIVE","EXPIRED"],"description":"Lifecycle status of a promotion"},"CurrencyType":{"type":"string","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"],"description":"ISO 4217 currency codes supported by Bankaci"}}}}
```

## The PaginatedPreOrderResponse object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"PaginatedPreOrderResponse":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PreOrderOut"}}}},"PreOrderOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"basket_id":{"type":"integer","description":"Omnitron basket ID"},"basket_modified_date":{"type":"string","format":"date-time"},"tokenized_card":{"type":"integer","description":"FK to TokenizedCard"},"bin_6":{"type":"string","maxLength":6},"fingerprint":{"type":"string","maxLength":1024,"description":"Unique card fingerprint from TapPay"},"currency":{"$ref":"#/components/schemas/CurrencyType"},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true}}},"CurrencyType":{"type":"string","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"],"description":"ISO 4217 currency codes supported by Bankaci"}}}}
```

## The PaginatedPreOrderCallResponse object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"PaginatedPreOrderCallResponse":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PreOrderCallOut"}}}},"PreOrderCallOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"pre_order":{"$ref":"#/components/schemas/PreOrderOut"},"promotion":{"$ref":"#/components/schemas/PromotionOut"},"uuid":{"type":"string","format":"uuid","description":"Session code returned to the client as `session_code`"},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true}}},"PreOrderOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"basket_id":{"type":"integer","description":"Omnitron basket ID"},"basket_modified_date":{"type":"string","format":"date-time"},"tokenized_card":{"type":"integer","description":"FK to TokenizedCard"},"bin_6":{"type":"string","maxLength":6},"fingerprint":{"type":"string","maxLength":1024,"description":"Unique card fingerprint from TapPay"},"currency":{"$ref":"#/components/schemas/CurrencyType"},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true}}},"CurrencyType":{"type":"string","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"],"description":"ISO 4217 currency codes supported by Bankaci"},"PromotionOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true},"title":{"type":"string","maxLength":255},"status":{"$ref":"#/components/schemas/PromotionStatus"},"currency":{"$ref":"#/components/schemas/CurrencyType"},"per_card_limit":{"type":"integer","default":1,"description":"Maximum uses per tokenized card within the reset period"},"reset_schedule":{"type":"string","nullable":true,"description":"Cron expression for when `per_card_limit` resets. `null` = lifetime limit (never resets).\nExample: `\"0 0 * * *\"` resets the counter daily at midnight UTC.\n"},"bin_6_list":{"type":"array","items":{"type":"string","maxLength":6},"description":"6-digit card BIN prefixes this promotion applies to"},"priority":{"type":"integer","default":0,"description":"Higher value = shown first in promotion listings"},"basket_offer_ids":{"type":"array","items":{"type":"string","maxLength":255},"description":"Omnitron `BasketOffer` IDs to activate when this promotion matches.\nAlso used to verify actual discount application via `DiscountItem.conditional_offer`.\n"},"start_date":{"type":"string","format":"date-time","description":"Promotion start date (inclusive)"},"end_date":{"type":"string","format":"date-time","description":"Promotion end date (exclusive)"},"usable_with_voucher_code":{"type":"boolean","default":false,"description":"Whether this promotion can be stacked with a voucher code"}}},"PromotionStatus":{"type":"string","enum":["ACTIVE","PASSIVE","EXPIRED"],"description":"Lifecycle status of a promotion"}}}}
```

## The PaginatedPromotionUsageResponse object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"PaginatedPromotionUsageResponse":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PromotionUsageOut"}}}},"PromotionUsageOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"pre_order_call":{"$ref":"#/components/schemas/PreOrderCallOut"},"promotion":{"$ref":"#/components/schemas/PromotionOut"},"tokenized_card":{"type":"integer","description":"FK to TokenizedCard"},"basket_id":{"type":"string","description":"Omnitron basket ID (stored as string)"},"order_number":{"type":"string","nullable":true,"description":"Omnitron order number, populated after order is placed"},"fingerprint":{"type":"string","maxLength":1024},"reset_date":{"type":"string","format":"date-time","nullable":true,"description":"Date after which this usage record no longer counts toward `per_card_limit`.\nCalculated from `promotion.reset_schedule` at the time of order placement.\n`null` when the promotion has no reset schedule (lifetime limit).\n"},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true}}},"PreOrderCallOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"pre_order":{"$ref":"#/components/schemas/PreOrderOut"},"promotion":{"$ref":"#/components/schemas/PromotionOut"},"uuid":{"type":"string","format":"uuid","description":"Session code returned to the client as `session_code`"},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true}}},"PreOrderOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"basket_id":{"type":"integer","description":"Omnitron basket ID"},"basket_modified_date":{"type":"string","format":"date-time"},"tokenized_card":{"type":"integer","description":"FK to TokenizedCard"},"bin_6":{"type":"string","maxLength":6},"fingerprint":{"type":"string","maxLength":1024,"description":"Unique card fingerprint from TapPay"},"currency":{"$ref":"#/components/schemas/CurrencyType"},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true}}},"CurrencyType":{"type":"string","enum":["try","eur","usd","egp","gbp","mad","pln","sar","ron","uah","czk","huf","rub","bgn","iqd","kwd","bhd","omr","qar","aed","ngn","inr","lei","kzt","jod","rsd"],"description":"ISO 4217 currency codes supported by Bankaci"},"PromotionOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true},"title":{"type":"string","maxLength":255},"status":{"$ref":"#/components/schemas/PromotionStatus"},"currency":{"$ref":"#/components/schemas/CurrencyType"},"per_card_limit":{"type":"integer","default":1,"description":"Maximum uses per tokenized card within the reset period"},"reset_schedule":{"type":"string","nullable":true,"description":"Cron expression for when `per_card_limit` resets. `null` = lifetime limit (never resets).\nExample: `\"0 0 * * *\"` resets the counter daily at midnight UTC.\n"},"bin_6_list":{"type":"array","items":{"type":"string","maxLength":6},"description":"6-digit card BIN prefixes this promotion applies to"},"priority":{"type":"integer","default":0,"description":"Higher value = shown first in promotion listings"},"basket_offer_ids":{"type":"array","items":{"type":"string","maxLength":255},"description":"Omnitron `BasketOffer` IDs to activate when this promotion matches.\nAlso used to verify actual discount application via `DiscountItem.conditional_offer`.\n"},"start_date":{"type":"string","format":"date-time","description":"Promotion start date (inclusive)"},"end_date":{"type":"string","format":"date-time","description":"Promotion end date (exclusive)"},"usable_with_voucher_code":{"type":"boolean","default":false,"description":"Whether this promotion can be stacked with a voucher code"}}},"PromotionStatus":{"type":"string","enum":["ACTIVE","PASSIVE","EXPIRED"],"description":"Lifecycle status of a promotion"}}}}
```

## The PaginatedChangeCapturePointerResponse object

```json
{"openapi":"3.0.3","info":{"title":"Bankaci API","version":"1.0.0"},"components":{"schemas":{"PaginatedChangeCapturePointerResponse":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ChangeCapturePointerOut"}}}},"ChangeCapturePointerOut":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"key":{"type":"string","maxLength":255,"description":"Unique CDC pointer key (e.g. `last_modified_date_minute`)"},"value":{"type":"string","nullable":true,"description":"Serialized pointer value (ISO 8601 string for datetime type)"},"value_type":{"type":"string","enum":["int","str","datetime"],"description":"Type hint used to deserialize `value`"},"created_date":{"type":"string","format":"date-time","readOnly":true},"modified_date":{"type":"string","format":"date-time","readOnly":true}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://apidocs.akinon.com/commerce-openapis/dynamic-bin-scheduler/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.