Endpoints: 28,729MCP servers: 18,413Payout addresses: 2,071Paid calls: 1,537Letters: 14Defects: 1,323counted 2 min ago
teppi

Server definition

Hash
sha256:38f4eddb4df8b29e1a2ea913a686d0b917fe65c085f7d7d6b1755c1344784f12
What it is
What a remote MCP server returned when asked what it offers: 10 tools

The blob, as servednamed by its sha256

{ "instructions": null, "tools": [ { "description": "Submit a new order with selected products and payment method", "inputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "properties": { "body": { "$ref": "#/definitions/CreateOrderRequest" } }, "type": "object" }, "name": "createOrder", "outputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "properties": { "result": { "$ref": "#/definitions/MultiProductsOrderResponse" } }, "required": [ "result" ], "type": "object" } }, { "description": "Fetch supported crypto currencies", "inputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "type": "object" }, "name": "getCurrencies", "outputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "properties": { "result": { "items": { "$ref": "#/definitions/BaseCurrency" }, "type": "array" } }, "required": [ "result" ], "type": "object" } }, { "description": "Retrieve the status and details of a submitted order", "inputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "properties": { "order_id": { "type": "string" } }, "required": [ "order_id" ], "type": "object" }, "name": "getOrderStatus", "outputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "properties": { "result": { "$ref": "#/definitions/MultiProductsOrderResponse" } }, "required": [ "result" ], "type": "object" } }, { "description": "Fetch possible payment methods and supported currencies/networks", "inputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "type": "object" }, "name": "getPaymentViasWithCurrencies", "outputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "properties": { "result": { "items": { "$ref": "#/definitions/PaymentViaWithCurrencies" }, "type": "array" } }, "required": [ "result" ], "type": "object" } }, { "description": "Get pricing for range-based products where customer can select face value within min/max range", "inputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "properties": { "brand_name": { "description": "Brand name of the product", "type": "string" }, "coin": { "description": "Cryptocurrency to get price in (e.g., BTC, ETH, USDT, SOL)", "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "face_value": { "description": "Selected face value amount within the product's min/max range", "type": "number" } }, "required": [ "brand_name", "country_code", "face_value", "coin" ], "type": "object" }, "name": "getProductPrice", "outputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "properties": { "result": { "$ref": "#/definitions/ProductResponse" } }, "required": [ "result" ], "type": "object" } }, { "description": "Fetch available gift-card and mobile top-ups brands for a given country", "inputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "properties": { "cid": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" } }, "required": [ "country_code" ], "type": "object" }, "name": "listBrands", "outputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "properties": { "result": { "properties": { "all_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "categories": { "items": { "$ref": "#/definitions/CategoryModel" }, "type": "array" }, "country_code": { "type": "string" }, "last_user_purchases": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "suggestions": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "country_code", "categories", "all_brands", "last_user_purchases", "suggestions" ], "type": "object" } }, "required": [ "result" ], "type": "object" } }, { "description": "List all products in a country, optionally filtering by brand, family, coin, payment method, or language", "inputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "properties": { "brand_name": { "type": "string" }, "coin": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "family_name": { "type": "string" }, "lang": { "type": "string" }, "payment_method": { "type": "string" } }, "required": [ "country_code" ], "type": "object" }, "name": "listProductsForCountry", "outputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "properties": { "result": { "items": { "$ref": "#/definitions/ProductsForBrandResponse" }, "type": "array" } }, "required": [ "result" ], "type": "object" } }, { "description": "Interactive, stateful endpoint to guide small-footprint AI agents through a purchase flow for gift cards or mobile top-ups. Call repeatedly with the same session_token until 'status' is 'complete' or 'error'. For the first call, provide an empty 'body': {} (session_token will be generated and returned). Provide 'answer' in the body to respond to the current question. Use 'action: back' in the body to go to the previous step. Handles product type selection, country, brand, amount, beneficiary, coin, network, user email, and final confirmation/validation/order creation.", "inputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "properties": { "body": { "properties": { "action": { "description": "Optional action like 'back' to revert to the previous step.", "enum": [ "back" ], "type": "string" }, "answer": { "description": "User's response to the current question (e.g., 'giftcard', 'IT', 'Amazon.it', '50', '[email protected]', 'USDC', 'SOLANA', 'yes').", "type": "string" }, "session_token": { "description": "Unique token for the session (returned in first response; required for subsequent calls).", "type": "string" } }, "required": [], "type": "object" } }, "type": "object" }, "name": "purchaseElicitation", "outputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "properties": { "result": { "else": { "else": { "required": [ "status", "next_step", "payment_details" ] }, "if": { "properties": { "status": { "const": "continue" } } }, "then": { "required": [ "status", "session_token", "question", "expected_format", "previous_answers" ] } }, "if": { "properties": { "status": { "const": "error" } } }, "properties": { "error": { "description": "Error message (if status=error).", "type": "string" }, "expected_format": { "description": "Expected format for the answer (if status=continue).", "type": "string" }, "fix": { "description": "Suggestion to fix the error (if status=error).", "type": "string" }, "next_step": { "description": "Instructions for payment/polling (if status=complete).", "type": "string" }, "options": { "description": "Suggested options for the answer (if applicable, for status=continue).", "items": { "type": "string" }, "type": "array" }, "payment_details": { "description": "Payment info (if status=complete).", "properties": { "coinAmount": { "type": "string" }, "coinSymbol": { "type": "string" }, "network": { "type": "string" }, "walletAddress": { "type": "string" } }, "type": "object" }, "previous_answers": { "description": "Map of data collected so far (e.g., {'country': 'IT', 'brand': 'Amazon.it'}).", "type": "object" }, "question": { "description": "Next question to ask the user (if status=continue).", "type": "string" }, "session_token": { "description": "Token for this session (returned for continue; may be null for complete or error).", "type": [ "string", "null" ] }, "status": { "description": "'continue' = more questions; 'complete' = order created; 'error' = validation or execution failed.", "enum": [ "continue", "complete", "error" ], "type": "string" }, "suggestions": { "description": "Alternative suggestions (if status=error).", "items": { "type": "string" }, "type": "array" } }, "required": [ "status" ], "then": { "required": [ "status", "error", "fix" ] }, "type": "object" } }, "required": [ "result" ], "type": "object" } }, { "description": "Search products by text query across brands and categories in a given country", "inputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "properties": { "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "lang": { "examples": [ "en", "it", "de", "zh" ], "type": "string" }, "q": { "description": "Search query", "type": "string" } }, "required": [ "country_code", "q" ], "type": "object" }, "name": "searchProducts", "outputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "properties": { "result": {} }, "required": [ "result" ], "type": "object" } }, { "description": "Validate a potential order against minimum amount and business rules", "inputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "properties": { "body": { "$ref": "#/definitions/DetailedMultiProductsOrderValidationRequest" } }, "type": "object" }, "name": "validateOrder", "outputSchema": { "definitions": { "Acquisition": { "additionalProperties": false, "properties": { "cid": { "type": [ "string", "null" ] }, "click_id": { "type": [ "string", "null" ] }, "conversion_flow": { "type": [ "string", "null" ] }, "gclid": { "type": [ "string", "null" ] }, "referer": { "type": [ "string", "null" ] }, "session_id": { "type": [ "string", "null" ] }, "utm_campaign": { "type": [ "string", "null" ] }, "utm_content": { "type": [ "string", "null" ] }, "utm_medium": { "type": [ "string", "null" ] }, "utm_source": { "type": [ "string", "null" ] }, "utm_term": { "type": [ "string", "null" ] } }, "type": "object" }, "AcquisitionOptional": { "oneOf": [ { "$ref": "#/definitions/Acquisition" }, { "type": "null" } ] }, "Amount": { "properties": { "base": { "$ref": "#/definitions/IAmount" }, "promotion_bonus": { "$ref": "#/definitions/IAmount" }, "total_excluding_tax": { "$ref": "#/definitions/IAmount" }, "total_including_tax": { "$ref": "#/definitions/IAmount" } }, "required": [ "base", "promotion_bonus", "total_excluding_tax", "total_including_tax" ], "type": "object" }, "BaseCurrency": { "additionalProperties": false, "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "examples": [ "BTC, ETH, USDT, USDC, SOL" ], "type": "string" } }, "required": [ "name", "logo_url", "is_suspended" ], "type": "object" }, "Benefit": { "properties": { "additional_information": { "type": "string" }, "amount": { "$ref": "#/definitions/Amount" }, "type": { "type": "string" }, "unit": { "type": "string" }, "unit_type": { "type": "string" } }, "required": [ "type", "unit_type", "unit", "amount", "additional_information" ], "type": "object" }, "BrandModel": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "bg_color": { "type": "string" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "max": { "type": [ "string", "null" ] }, "min": { "type": [ "string", "null" ] }, "product_type": { "type": "string" }, "promotion": { "type": [ "object", "null" ] } }, "required": [ "family", "brand_id", "brand", "logo_url", "category", "is_out_of_stock", "country_code", "product_type" ], "type": "object" }, "CampaignReward": { "properties": { "campaign_description": { "type": "string" }, "campaign_name": { "type": "string" }, "reward": { "additionalProperties": true, "type": "object" } }, "required": [ "campaign_name", "reward" ], "type": "object" }, "CategoryModel": { "properties": { "brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" }, "category": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "popular_brands": { "items": { "$ref": "#/definitions/BrandModel" }, "type": "array" } }, "required": [ "kind", "brands", "popular_brands" ], "type": "object" }, "CreateOrderRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/User" } }, "required": [ "user", "payment", "deliveries" ], "type": "object" }, "CurrencyWithNetwork": { "properties": { "is_suspended": { "type": "boolean" }, "logo_url": { "type": "string" }, "name": { "type": "string" }, "networks": { "items": { "$ref": "#/definitions/PaymentNetwork" }, "type": "array" }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name", "logo_url", "networks", "is_suspended" ], "type": "object" }, "CustomerSpecific": { "properties": { "account": { "type": "string" }, "face_value": { "type": "number" } }, "required": [ "account", "face_value" ], "type": "object" }, "Delivery": { "properties": { "deliverable": { "$ref": "#/definitions/ProductDeliverable" }, "delivery_state": { "type": "string" }, "id": { "type": "string" }, "kind": { "type": "string" }, "sandbox_mode": { "type": [ "boolean", "null" ] } }, "required": [ "id", "delivery_state", "kind", "deliverable" ], "type": "object" }, "DetailedMultiProductsOrderValidationRequest": { "additionalProperties": false, "properties": { "acquisition": { "$ref": "#/definitions/AcquisitionOptional" }, "binance_sku": { "type": [ "string", "null" ] }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/ProductDeliverable" }, "type": "array" }, "external_store": { "$ref": "#/definitions/ExternalStoreOptional" }, "lang": { "type": [ "string", "null" ] }, "nft_codes": { "items": { "$ref": "#/definitions/NFTCode" }, "type": [ "array", "null" ] }, "payment": { "$ref": "#/definitions/IPayment" }, "promo_code": { "type": [ "string", "null" ] }, "refund_wallet_address": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "format": "uri", "type": [ "string", "null" ] }, "time_zone": { "type": [ "string", "null" ] }, "user": { "$ref": "#/definitions/UserOptional" } }, "required": [ "payment", "deliveries" ], "type": "object" }, "DetailedMultiProductsOrderValidationResponse": { "additionalProperties": false, "properties": { "coin": { "type": "string" }, "coin_amount": { "type": "string" }, "coupon_code": { "type": [ "string", "null" ] }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "original_coin_amount": { "type": "string" }, "payment_fee": { "$ref": "#/definitions/PaymentFee" }, "points": { "$ref": "#/definitions/Points" }, "problems": { "items": { "$ref": "#/definitions/IEnrichedProblem" }, "type": "array" }, "summary": { "$ref": "#/definitions/OrderSummary" } }, "required": [ "coin", "coin_amount", "original_coin_amount", "deliveries", "payment_fee", "points", "summary", "is_payment_processor_external" ], "type": "object" }, "ExternalStore": { "additionalProperties": false, "properties": { "coin_amount": { "type": "number" }, "coin_name": { "type": "string" } }, "required": [ "coin_name", "coin_amount" ], "type": "object" }, "ExternalStoreOptional": { "oneOf": [ { "$ref": "#/definitions/ExternalStore" }, { "type": "null" } ] }, "FaceValue": { "properties": { "amount": { "oneOf": [ { "$ref": "#/definitions/Fixed" }, { "$ref": "#/definitions/FaceValueRange" } ] }, "currency_code": { "type": "string" } }, "required": [ "currency_code", "amount" ], "type": "object" }, "FaceValueRange": { "properties": { "max": { "type": "string" }, "min": { "type": "string" } }, "required": [ "min", "max" ], "type": "object" }, "Fixed": { "properties": { "price": { "description": "Display label for fixed denomination (e.g., '5 EUR', '3 months subscription', '100 diamonds + 10 free').", "type": "string" } }, "required": [ "price" ], "type": "object" }, "IAmount": { "additionalProperties": true, "type": "object" }, "IEnrichedProblem": { "additionalProperties": true, "type": "object" }, "IPayment": { "oneOf": [ { "additionalProperties": false, "description": "User pays directly from an on-chain wallet", "properties": { "coin": { "examples": [ "USDC", "USDT", "BTC", "SOL", "WLD" ], "type": "string" }, "network": { "examples": [ "Solana", "Polygon (Matic)", "Mainnet" ], "type": "string" }, "payment_via": { "examples": [ "USER_WALLET" ], "type": "string" }, "type": { "const": "via" } }, "required": [ "type", "payment_via", "coin", "network" ] }, { "additionalProperties": false, "description": "User pays through Binance Pay", "properties": { "coin": { "examples": [ "USD1" ], "type": "string" }, "type": { "const": "binance_pay" } }, "required": [ "type", "coin" ] } ], "type": "object" }, "ISmartContract": { "properties": { "address": { "type": "string" }, "decimals": { "type": "integer" }, "symbol": { "type": "string" } }, "required": [ "address", "decimals", "symbol" ], "type": "object" }, "MultiProductsOrderResponse": { "additionalProperties": false, "description": "Full payload returned after creating an order or polling its status.", "properties": { "campaign_rewards": { "items": { "$ref": "#/definitions/CampaignReward" }, "type": [ "array", "null" ] }, "checkout_url": { "description": "when present, redirect the use here to start the payment", "format": "uri", "type": [ "string", "null" ] }, "coin": { "description": "Ticker of the settlement currency", "type": "string" }, "coin_amount": { "type": "string" }, "created_at": { "description": "Unix epoch (seconds) when the order was created", "format": "int64", "type": "integer" }, "deliveries": { "items": { "$ref": "#/definitions/Delivery" }, "type": "array" }, "is_payment_processor_external": { "type": "boolean" }, "missing_amount": { "type": [ "string", "null" ] }, "missing_amount_qr_text": { "type": [ "string", "null" ] }, "missing_amount_qr_url": { "format": "uri", "type": [ "string", "null" ] }, "network": { "description": "Blockchain / network (e.g. 'Solana')", "type": "string" }, "nft_codes": { "$ref": "#/definitions/NFTCodeSpendingSummary" }, "order_id": { "description": "UUID v4 that uniquely identifies the order", "type": "string" }, "order_state": { "enum": [ "WaitingForPayment", "PaymentStarted", "PaymentFailed", "WaitingForNFTCards", "NFTCardsSpent", "WaitingForDelivery", "WaitingForCoupon", "Refunded", "Completed", "WaitingForManualAction", "Done", "Expired", "Canceled" ], "type": "string" }, "original_price": { "type": "string" }, "payment_id": { "type": "string" }, "payment_method": { "type": "string" }, "payment_method_protocol": { "type": "string" }, "payment_requested_at": { "type": [ "integer", "null" ] }, "payment_state": { "enum": [ "WalletRequested", "WalletCreated", "PaymentRequested", "PaymentStarted", "WaitingForComplianceReport", "PaymentQuarantined", "PaymentReceived", "PartialPaymentStarted", "Failed", "WaitingForExpiry", "WaitingForExpiryAfterPaymentDetection", "Expired", "ExpiredAfterPaymentDetection", "PaymentCanceled" ], "type": "string" }, "payment_transactions": { "description": "Blockchain TX hashes or processor IDs", "items": { "type": "string" }, "type": "array" }, "payment_value": { "type": "string" }, "payment_via": { "type": "string" }, "qr_text": { "type": "string" }, "qr_url": { "description": "uri to retrieve a QR code that can be used to start the payment", "format": "uri", "type": "string" }, "received_amount": { "type": [ "string", "null" ] }, "sandbox_mode": { "type": [ "boolean", "null" ] }, "sent_coin_amount": { "type": [ "string", "null" ] }, "state_transition_notification_url": { "type": [ "string", "null" ] }, "store_type": { "type": [ "string", "null" ] }, "summary": { "$ref": "#/definitions/OrderSummary" }, "user": { "$ref": "#/definitions/User" }, "wallet_address": { "description": "Destination wallet address (if applicable)", "type": "string" } }, "required": [ "order_id", "created_at", "payment_state", "order_state", "is_payment_processor_external" ], "type": "object" }, "NFTCode": { "additionalProperties": false, "properties": { "contract_address": { "type": "string" }, "network": { "type": "string" }, "permit": { "$ref": "#/definitions/PermitOptional" }, "tokenId": { "type": "string" } }, "required": [ "tokenId", "contract_address", "network" ], "type": "object" }, "NFTCodeSpendingSummary": { "additionalProperties": true, "type": "object" }, "OrderSummary": { "properties": { "coin_amount_after_discount": { "type": "string" }, "coin_amount_before_discount": { "type": "string" }, "coin_amount_to_pay_in_crypto": { "type": "string" }, "coin_amount_to_pay_via_coupon": { "type": "string" }, "coin_amount_to_pay_via_nft": { "type": "string" } }, "required": [ "coin_amount_before_discount", "coin_amount_after_discount", "coin_amount_to_pay_in_crypto", "coin_amount_to_pay_via_nft", "coin_amount_to_pay_via_coupon" ], "type": "object" }, "PaymentFee": { "additionalProperties": true, "type": "object" }, "PaymentNetwork": { "properties": { "base_token": { "examples": [ "ETH", "SOL" ], "type": [ "string", "null" ] }, "chain_id": { "type": [ "integer", "null" ] }, "estimated_transfer_cost": { "type": [ "string", "null" ] }, "logo_url": { "type": [ "string", "null" ] }, "name": { "examples": [ "Base", "Ethereum", "Mainnet", "Solana" ], "type": "string" }, "smart_contract": { "type": [ "object", "null" ] }, "smart_contract_engine": { "type": [ "string", "null" ] }, "threshold": { "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "PaymentViaWithCurrencies": { "properties": { "currencies": { "items": { "$ref": "#/definitions/CurrencyWithNetwork" }, "type": "array" }, "logo_url": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "required": [ "name", "currencies" ], "type": "object" }, "Permit": { "additionalProperties": false, "properties": { "deadline": { "type": "integer" }, "signature": { "type": "string" } }, "required": [ "signature", "deadline" ], "type": "object" }, "PermitOptional": { "oneOf": [ { "$ref": "#/definitions/Permit" }, { "type": "null" } ] }, "Points": { "additionalProperties": true, "type": "object" }, "ProductDeliverable": { "properties": { "barcode_image_url": { "type": [ "string", "null" ] }, "beneficiary_account": { "description": "A string formatted as an email (if delivery_type requires email) or a phone number (if delivery_type requires phone).", "oneOf": [ { "description": "Email format when delivery_type indicates email-based delivery.", "format": "email" }, { "description": "Phone number format (E.164, up to 15 digits, optional leading +) when delivery_type indicates phone-based delivery.", "pattern": "^\\+?[1-9]\\d{1,14}$" } ], "type": "string" }, "brand_bg_color": { "type": "string" }, "brand_logo": { "type": "string" }, "brand_name": { "type": "string" }, "coin_amount": { "type": "string" }, "country_code": { "type": "string" }, "currency_code": { "type": [ "string", "null" ] }, "delivery_type": { "type": "string" }, "denomination": { "type": "string" }, "error_description": { "type": [ "string", "null" ] }, "failure_reason": { "type": [ "string", "null" ] }, "family": { "type": "string" }, "localized_denomination": { "type": "string" }, "original_coin_amount": { "type": "string" }, "original_price": { "type": "string" }, "pin_code": { "oneOf": [ { "description": "URL the user must open to reveal / activate the code.", "format": "uri", "type": "string" }, { "description": "The gift-card code itself.", "pattern": "^[A-Za-z0-9-]{4,}$", "type": "string" } ] }, "pin_serial": { "description": "Serial number (shown on some physical/virtual cards).", "type": [ "string", "null" ] }, "pin_usage_instructions": { "description": "HTML instructions on how to redeem the code.", "type": [ "string", "null" ] }, "points": { "type": "string" }, "product_value": { "type": [ "string", "null" ] }, "promotion": { "type": [ "object", "null" ] }, "qr_image_url": { "type": [ "string", "null" ] }, "redeem_instructions": { "type": [ "string", "null" ] }, "security_code": { "description": "Extra security / CVV code if required by the brand.", "type": [ "string", "null" ] }, "terms_and_conditions": { "type": [ "string", "null" ] } }, "required": [ "denomination", "brand_name", "beneficiary_account", "country_code" ], "type": "object" }, "ProductResponse": { "properties": { "additional_details": { "type": [ "object", "null" ] }, "benefits": { "items": { "$ref": "#/definitions/Benefit" }, "type": [ "array", "null" ] }, "coin": { "type": "string" }, "coin_amount": { "type": [ "string", "null" ] }, "customer_specific": { "$ref": "#/definitions/CustomerSpecific" }, "delivery_type": { "type": "string" }, "denomination": { "type": [ "string", "null" ] }, "face_value": { "$ref": "#/definitions/FaceValue" }, "is_dynamic": { "type": "boolean" }, "localized_denomination": { "type": [ "string", "null" ] }, "original_coin_amount": { "type": [ "string", "null" ] }, "payment_method": { "type": "string" }, "points": { "type": "string" }, "product_id": { "type": "string" }, "product_type": { "type": "string" }, "range": { "$ref": "#/definitions/Range" }, "valid_regions": { "items": { "type": "string" }, "type": "array" } }, "required": [ "product_id", "is_dynamic", "coin", "payment_method", "delivery_type", "points", "product_type" ], "type": "object" }, "ProductsForBrandResponse": { "properties": { "additional_categories": { "items": { "type": "string" }, "type": "array" }, "brand": { "type": "string" }, "brand_id": { "type": "string" }, "category": { "type": "string" }, "country_code": { "description": "ISO 3166-1 alpha-2 country code", "examples": [ "US", "GB", "FR", "DE" ], "type": "string" }, "default_denomination": { "type": "string" }, "family": { "type": "string" }, "is_out_of_stock": { "type": "boolean" }, "kind": { "type": "string" }, "logo_base_url": { "format": "uri", "type": "string" }, "logo_url": { "format": "uri", "type": "string" }, "product_tc": { "type": "string" }, "product_type": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/ProductResponse" }, "type": "array" }, "promotion": { "type": [ "object", "null" ] }, "redeem_method": { "items": { "type": "string" }, "type": "array" }, "rich_description": { "$ref": "#/definitions/RichDescription" } }, "required": [ "country_code", "category", "additional_categories", "kind", "default_denomination", "products", "family", "brand_id", "brand", "is_out_of_stock", "logo_url", "logo_base_url", "product_tc", "redeem_method", "product_type" ], "type": "object" }, "Range": { "properties": { "currency": { "type": "string" }, "default": { "type": "string" }, "max": { "type": "number" }, "min": { "type": "number" }, "step_size": { "type": "number" } }, "required": [ "min", "max", "currency", "step_size", "default" ], "type": "object" }, "RichDescription": { "properties": { "country_code": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "how_to_redeem": { "type": [ "string", "null" ] }, "locale": { "type": "string" }, "markup": { "type": "string" }, "note": { "type": [ "string", "null" ] }, "redeem_geo": { "type": [ "string", "null" ] }, "term_and_conditions": { "type": [ "string", "null" ] } }, "required": [], "type": "object" }, "User": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "has_accepted_newsletter": { "type": "boolean" }, "referral_code": { "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "UserOptional": { "oneOf": [ { "$ref": "#/definitions/User" }, { "type": "null" } ] } }, "properties": { "result": { "$ref": "#/definitions/DetailedMultiProductsOrderValidationResponse" } }, "required": [ "result" ], "type": "object" } } ] }
Verify it yourselfcurl -s https://api.teppi.xyz/v1/evidence/sha256:38f4eddb4df8b29e1a2ea913a686d0b917fe65c085f7d7d6b1755c1344784f12 | sha256sum