ORBT is a B2B2C platform built by Ncentiva that enables businesses (Partners) to distribute digital incentives, gift cards, controlled budgets, and benefits to Consumers through a modern and scalable interface.
\n✅ Simplify how companies distribute digital value
\n✅ Centralize incentive and benefit management
\n✅ Deliver a modern experience for end-users
\n✅ Leverage Ncentiva's robust gift card processing engine
\n💼 Employee rewards and benefits
\n🎁 Customer incentives and loyalty programs
\n📢 Promotional campaigns
\n🎫 Digital gift card distribution
\n💳 Budget-controlled purchasing
\n🏪 Automated payouts in branded stores
\n💸 Refunding alternatives platform
\nCompanies of any size
\nAgencies and corporate programs
\nLoyalty platforms
\nRetailers and marketplaces
\nAny business wanting to reach end-customers with digital value
\nBefore you begin, ensure you have:
\n✅ API Key - Your unique authentication key
\n✅ Client ID - Your partner identifier
\n✅ HMAC Secret - Your signing secret key
\n✅ Environment Access - UAT or Production URL
\nStep 1: Configure your authentication (see Authentication)
\nStep 2: Create your first customer:
\nPOST https://api-uat.ncentiva.com/api/partner/v1/customer\n\nStep 3: Review the response and retrieve wallet details
\nStep 4: Fund the customer wallet or assign campaigns
\nORBT uses HMAC-SHA256 signature-based authentication to ensure secure API communication.
\nEvery authenticated request must include these four headers:
\nThe signature ensures request integrity and authenticity.
\ndataToSign = METHOD + \"\\n\" + TIMESTAMP + \"\\n\" + CLIENT_ID + \"\\n\" + BODY\nsignature = HMAC-SHA256(dataToSign, HMAC_SECRET).toBase64()\n\nconst method = pm.request.method; // e.g., \"POST\"\nconst timestamp = new Date().toISOString();\nconst body = pm.request.data ? \n (typeof pm.request.data === 'string' ? \n pm.request.data : \n JSON.stringify(pm.request.data)) : \"\";\n// Replace with your actual credentials\nconst apiKey = 'YOUR_API_KEY_HERE';\nconst clientId = 'YOUR_CLIENT_ID_HERE';\nconst hmacSecret = 'YOUR_HMAC_SECRET_HERE';\nconst dataToSign = `${method}\\n${timestamp}\\n${clientId}\\n${body}`;\nconst crypto = require('crypto-js');\nconst signature = crypto.HmacSHA256(dataToSign, hmacSecret)\n .toString(crypto.enc.Base64);\n// Set environment variables\npm.environment.set('x-api-key', apiKey);\npm.environment.set('x-client-id', clientId);\npm.environment.set('x-signature', signature);\npm.environment.set('x-timestamp', timestamp);\n\nimport hmac\nimport hashlib\nimport base64\nfrom datetime import datetime\ndef generate_signature(method, client_id, body, hmac_secret):\n timestamp = datetime.utcnow().isoformat() + 'Z'\n data_to_sign = f\"{method}\\n{timestamp}\\n{client_id}\\n{body}\"\n signature = hmac.new(\n hmac_secret.encode('utf-8'),\n data_to_sign.encode('utf-8'),\n hashlib.sha256\n ).digest()\n return base64.b64encode(signature).decode('utf-8'), timestamp\n\n🔒 Never expose your HMAC secret in client-side code
\n🔄 Rotate API keys regularly
\n📝 Log API key usage for audit trails
\n⏱️ Implement timestamp validation to prevent replay attacks
\n🚫 Revoke compromised keys immediately
\nEndpoint: POST /api/partner/v1/customer
Creates a new customer with an initial wallet balance.
\nRequest Body:
\n{\n \"fullName\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"currency\": \"usd\",\n \"initialFunds\": 100.00\n}\n\nRequest Parameters:
\nSuccess Response (200 OK):
\n{\n \"success\": true,\n \"data\": {\n \"id\": 51,\n \"walletId\": \"51\",\n \"fullName\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"walletBalance\": 100.00,\n \"currency\": \"USD\"\n }\n}\n\nResponse Fields:
\nA Partner is the business entity registered in ORBT that manages Consumers, Team Members, funds, campaigns, and catalog access.
\nCapabilities:
\nManage consumer accounts
\nDistribute funds and incentives
\nCreate and assign campaigns
\nConfigure brand catalogs
\nAccess reporting and analytics
\nAn internal user of a Partner account with defined roles and permissions (admin, operator, viewer).
\nRoles:
\nAdmin - Full access to all features
\nOperator - Can manage consumers and transactions
\nViewer - Read-only access to reports
\nAn end-user who receives funds, benefits, or incentives from a Partner and uses those balances to purchase digital products.
\nConsumer Journey:
\nCreated by Partner (Portal, CSV, or API)
\nReceives email with login credentials
\nSets password on first login
\nBrowses available brands
\nMakes purchases using wallet balance
\nReceives digital products via email
\nThe final receiver of a digital order (email address where gift card is delivered). The Recipient may be the Consumer or an external person.
\nA rule-based budget configuration that defines spending limits, allowed brands, time windows, and eligibility rules.
\nCampaign Features:
\nBudget allocation
\nBrand restrictions
\nTime-based activation
\nConsumer eligibility rules
\nMulti-currency support
\nA gift card provider or digital service available in the ORBT catalog.
\nThe unique digital code representing the gift card's primary identifier.
\nA secure PIN code (when applicable) used to redeem the gift card on the Brand's platform.
\nDigital balances assigned to a Consumer. ORBT supports multiple wallets per Consumer, enabling multi-currency functionality.
\nWallet Types:
\nGeneral wallet balance
\nCampaign-specific balances
\nCurrency-specific wallets
\nAny movement of funds including credit, debit, rebate, refund, or adjustments.
\nYes. Partners can create Team Members with specific roles and access levels.
\nTeam Members can:
\n✅ Manage Consumers
\n✅ Add or deduct funds
\n✅ Create and assign Campaigns
\n✅ Review and filter transactions
\n✅ Enable or disable brands
\n✅ Configure pricing adjustments and bonuses
\n✅ Manage API keys and integrations
\n✅ Access reporting tools
\n✅ Update account settings and branding
\nYes. Partners can create, deactivate, or modify Team Member roles at any time.
\nYes. Deactivated Consumers cannot place new orders. Deactivation can be done individually or via CSV bulk upload.
\nTo ensure all business customers follow the same processing, reporting, and API standards. This consistency:
\nImproves reliability
\nReduces errors
\nAllows seamless choice between Ncentiva bulk processing or ORBT direct-to-consumer flows
\nA Consumer is an individual who receives incentives, benefits, or wallet funds from a Partner through ORBT.
\nConsumers can be created via:
\nPartner Portal - Manual creation through UI
\nBulk Upload - CSV file upload
\nAPI - Automated creation via /api/partner/v1/customer endpoint
The Recipient is the person who receives the final digital item (gift card email). The Recipient may be the Consumer themselves or any external person selected by the Consumer during checkout.
\nConsumers receive an email notification containing:
\nLogin credentials (temporary password)
\nLink to ORBT platform
\nInstructions for first-time login
\nFirst Login Requirements:
\nMust update temporary credentials
\nMust set a trusted password
\nMust accept terms and conditions
\nThrough the \"Forgot Password\" link on the ORBT login page, which sends a password reset email.
\nConsumers receive a confirmation email with redemption information:
\n✉️ Brand name
\n🔢 GC number (gift card code)
\n🔐 PIN or PIN-less instructions
\n📋 Additional redemption steps (if required by brand)
\n🔗 Direct redemption link (when applicable)
\nYes. Consumers may assign an order to an external Recipient by entering their email address during checkout.
\nPartner funds are deducted when:
\nFunds are transferred to Consumers
\nGift cards are purchased under Partner-level transactions
\nCampaign budgets are allocated
\nFunds are deducted from a Consumer's wallet at the moment they purchase digital products in the ORBT marketplace.
\nDeduction Priority:
\nCampaign-specific balance (if applicable)
\nGeneral wallet balance
\nBonus credit (if available)
\nYes. Partners can:
\n➕ Add funds directly
\n➖ Remove funds
\n🔄 Adjust balances via bulk processes
\n📊 Track all modifications in transaction logs
\nYes. Campaign budgets can be:
\nIncreased or decreased
\nDisabled completely
\nModified at any time without affecting past transactions
\nA Campaign defines budget rules including:
\n💵 Spending limits
\n🏷️ Allowed brands
\n👥 Eligible Consumers
\n⏰ Time windows
\n💱 Available currencies
\nCreate Campaign in the Campaign module
\nDefine rules and budget
\nAssign to one or multiple Consumers
\nMonitor usage and adjust as needed
\nYes. A Consumer may have multiple active Campaigns simultaneously. ORBT will combine available balances based on campaign rules and priorities.
\nCampaigns inherit the Partner's available currencies (e.g., USD, EUR, GBP). Once a Partner enables additional currencies, Campaigns may be configured in those currencies.
\nYes. Disabling a Campaign:
\nRemoves rules immediately
\nStops any further usage
\nDoes not affect historical transactions
\nYes. Campaigns support:
\n⏰ Activation schedules
\n⌛ Expiration windows
\n📅 Conditional time-based restrictions
\n🔄 Recurring campaign patterns
\nThe ORBT/Ncentiva team enables available brands for each Partner based on:
\nCommercial agreements
\nGeographic availability
\nPartner tier/category
\nPartners can then:
\nActivate or deactivate brands
\nConfigure pricing adjustments
\nSet bonus percentages
\nControl brand visibility
\nYes. Based on commercial agreements with Ncentiva, Partners can:
\n💰 Adjust pricing
\n🎁 Configure bonuses
\n📊 Set margin rules
\n🏷️ Create promotional offers
\nThese adjustments are automatically reflected for Consumers in the marketplace.
\nContact ORBT Support Team for:
\nVerification of order status
\nEscalation to brand provider
\nManual intervention if required
\n🔄 Retry the order - Use \"Retry\" button (if available)
\n💰 Check Consumer's wallet - Ensure sufficient balance
\n✉️ Confirm Recipient information - Verify email is correct
\n🆘 Contact support - If issue persists
\nYes, for all brands that support retry functionality. The retry feature is available in the Partner Portal.
\nBonuses represent added value given to Consumers, improving their purchasing power.
\nThe bonus is added directly to the gift card value.
\nExample:
\nBase gift card: $50
\nBonus: 10%
\nFinal gift card value: $55
\nConsumer receives gift card value plus bonus separately as wallet cash.
\nExample:
\nGift card: $50 (stays $50)
\nBonus: 10% = $5
\n$5 added to wallet for future purchases
\nPartners can enable bonuses that:
\nApply to specific brands
\nActivate during promotional periods
\nTarget specific Consumer segments
\nStack with existing campaign rules
\n{\n \"success\": false,\n \"error\": {\n \"error\": \"ERROR_CODE\",\n \"message\": \"Human-readable error description\"\n }\n}\n\nResponse:
\n{\n \"Message\": \"User is not authorized to access this resource with an explicit deny in an identity-based policy\"\n}\n\nCauses:
\nInvalid API key
\nIncorrect signature
\nExpired timestamp
\nRevoked credentials
\nSolutions:
\n✅ Verify API key and Client ID
\n✅ Regenerate signature
\n✅ Check timestamp is current
\n✅ Confirm credentials are active
\nResponse:
\n{\n \"success\": false,\n \"error\": {\n \"error\": \"VALIDATION_ERROR\",\n \"message\": \"Some customers already have wallets in the requested currency\"\n }\n}\n\nCauses:
\nEmail already exists for this Partner
\nCustomer already has wallet in requested currency
\nSolutions:
\n✅ Use different email address
\n✅ Update existing customer instead
\n✅ Check for duplicate entries
\nResponse:
\n{\n \"success\": false,\n \"error\": {\n \"error\": \"BUSINESS_RULE_ERROR\",\n \"message\": \"Unable to pre-charge all currency groups\"\n }\n}\n\nCauses:
\nPartner balance too low
\nCannot allocate requested initial funds
\nSolutions:
\n✅ Add funds to Partner account
\n✅ Reduce initialFunds amount
\n✅ Contact finance team
\nPartners can customize:
\nYes. Notifications can adopt:
\nPartner branding
\nCustom colors
\nPartner logos
\nBranded email templates
\nThis creates a seamless white-label experience for Consumers.
\nYes. ORBT provides comprehensive APIs for:
\nInside the Partner Portal under the \"API & Security\" section.
\nYou can also find it in this Postman collection.
\nYes. Partners can integrate ORBT directly into:
\nTheir own systems
\nCustomer portals
\nMobile apps
\nWeb applications
\nThird-party platforms
\nYes. ORBT security features include:
\n🔐 Encrypted API keys
\n🔄 Key rotation capabilities
\n🚫 Key revocation
\n📊 Usage monitoring and logging
\n✅ HMAC-SHA256 request signing
\nYes. Team Members receive individually defined roles and permissions:
\nFull access (Admin)
\nLimited access (Operator)
\nRead-only access (Viewer)
\nCustom role combinations
\nYes. Keys are:
\nEncrypted at rest
\nCan be created on-demand
\nCan be revoked immediately
\nCan be rotated regularly
\nMonitored for unusual activity
\nORBT:
\nStores minimal PII
\nFollows Ncentiva's security standards
\nComplies with data handling regulations
\nImplements encryption for sensitive data
\nProvides audit trails
\nCommon Reasons:
\nDelays from Brand provider
\nTemporary processing queues
\nPayment verification in progress
\nHigh-volume processing periods
\nRecommended Action:
\nWait 15-30 minutes
\nCheck order status
\nContact support if status doesn't change after 1 hour
\nCommon Reasons:
\nStep-by-Step:
\nRetry the order - Use retry button in Portal
\nReview logs - Check transaction details
\nCheck wallet balances - Ensure sufficient funds
\nVerify customer details - Confirm email and currency
\nContact ORBT Support - If issue persists
\nQ: What is the difference between a Partner and a Consumer?
\nA: A Partner is a business using ORBT to distribute value. A Consumer is an end-user receiving that value.
\nQ: Can one email address be used for multiple Consumers?
\nA: No. Each Consumer must have a unique email address per Partner.
\nQ: What happens if a Consumer forgets their password?
\nA: They can use the \"Forgot Password\" link to receive a reset email.
\nQ: How long is the HMAC signature valid?
\nA: Signatures should be generated fresh for each request. Timestamps older than 5 minutes may be rejected.
\nQ: Can I use the same API key for UAT and Production?
\nA: No. UAT and Production have separate credentials for security.
\nQ: What's the rate limit for API calls?
\nA: Contact your account manager for specific rate limits based on your tier.
\nQ: How quickly are funds reflected in Consumer wallets?
\nA: Immediately upon successful API call or Partner action.
\nQ: Can I bulk-create Consumers via API?
\nA: Yes, you can make multiple API calls or use the CSV bulk upload feature.
\nQ: What happens to unused Campaign funds?
\nA: They remain in the Campaign budget and can be reallocated or returned to Partner balance.
\n🕐 Monday - Friday: 9 AM - 6 PM EST
\n📧 Email support: 24/7 (response within 24 hours)
\n🚨 Critical issues: Immediate escalation
\nPlease have ready:
\nPartner ID
\nConsumer ID (if applicable)
\nTransaction ID or Order ID
\nError messages (screenshots helpful)
\nSteps to reproduce the issue
\n📚 Full API Documentation: Partner Portal
\n🎥 Video Tutorials: Available in Partner Portal
\n📖 Integration Guides: Coming soon
\n💡 Best Practices: Check Partner Resources section
\nDocument Version: 1.0
Last Updated: February 12, 2026
Maintained By: ORBT Product Team
Generated from cURL: curl --location 'Https://api-staging.ncentiva.com/api/partner/v1/customer'
--header 'x-api-key: {{x-api-key}}'
--header 'x-client-id: {{x-client-id}}'
--header 'x-signature: {{x-signature}}'
--header 'x-timestamp: {{x-timestamp}}'
--header 'Content-Type: application/json'
--data-raw '{\n \"fullName\": \"White test\",\n \"email\": \"amir+api3@ncentiva.com\",\n \"currency\": \"usd\",\n \"initialFunds\": 101.50\n}'