Jump to Content
Virtual IncentivesDOCUMENTATIONHome
HomeREST APIBATCH API
DOCUMENTATIONHomeVirtual Incentives

REST V6

  • Introduction
  • Security
  • Implementation
  • Authentication
  • API Reference
  • Health Check
  • Orders
    • Create Orders
    • Get Orders
    • Get Orders by Status
    • Get Orders by Program ID
    • Get Orders by Client ID
    • Get Orders by Date
    • Get Order by Order Number
  • Brands
    • Get Brands
    • Get Brand
    • Get Brand Faceplate
    • Get Brand Marketing
    • Get Brand Terms and Conditions
  • Balances
    • Get Master Funding Account Balances
    • Get Program Account Balances
    • Get Program Account Balance
  • Programs
    • Get Programs
    • Get Program Brands
    • Get Program Brand
  • Recipients
    • Get Recipients
    • Get Recipients by Email
    • Get Recipients by UDF
    • Get Recipients by Order Number
    • Get Recipient by Recipient ID
    • Get Recipient Events
    • Redact Recipient Data
    • Cancel
    • Cancel and Reissue
    • Extend Link
    • Resend Link
    • Multi-Factor Authentication Reset
    • Fraud Monitor Override
    • Update PIN
    • Get Card by PAN
    • Get Card by Barcode
    • Get Recipient Card
    • Get Recipient Card Balance
    • Get Recipient Transactions
  • Activate
    • Activate by PAN (Prepaid)
    • Activate by PAN (Post-paid)
    • Activate by Barcode (Post-paid)
  • Error Handling
  • Appendices
    • Appendix A: Order Status Types
    • Appendix B: Error Codes
    • Appendix C: Reward DNA Status
  • Technical Support

REST V5

  • Introduction
  • Security
  • Implementation
  • Authentication
  • API Reference
  • Health Check
  • Orders
    • Create Orders
    • Get Orders
    • Get Orders by Status
    • Get Orders by Program ID
    • Get Orders by Client ID
    • Get Orders by Date
    • Get Order by Order Number
  • Brands
    • Get Brands
    • Get Brand
    • Get Brand Faceplate
    • Get Brand Marketing
    • Get Brand Terms and Conditions
  • Balances
    • Get Master Funding Account Balances
    • Get Program Account Balances
    • Get Program Account Balance
  • Programs
    • Get Programs
    • Get Program Brands
    • Get Program Brand
  • Recipients
    • Get Recipients
    • Get Recipients by Email
    • Get Recipients by UDF
    • Get Recipients by Order Number
    • Get Recipient by Recipient ID
    • Get Recipient Events
    • Redact Recipient Data
  • Error Handling
  • Appendices
    • Appendix A: Order Status Types
    • Appendix B: Error Codes
    • Appendix C: Reward DNA Status
  • Technical Support

REST V4

  • Introduction
  • Implementation
  • Authentication
  • API Reference
  • Health Check
  • Orders
    • Create Orders
    • Get Orders
    • Get Orders by Status
    • Get Orders by Program ID
    • Get Orders by Client ID
    • Get Orders by Date
    • Get Order by Order Number
  • Brands
    • Get Brands
    • Get Brand
    • Get Brand Faceplate
    • Get Brand Marketing
    • Get Brand Terms and Conditions
  • Balances
    • Get Master Funding Account Balances
    • Get Program Account Balances
    • Get Program Account Balance
  • Programs
    • Get Programs
    • Get Program Brands
    • Get Program Brand
  • Error Handling
  • Appendices
    • Appendix A: Order Status Types
    • Appendix B: Error Codes
  • Technical Support

REST V3

  • Introduction
  • Security
  • Implementation
  • Authentication
  • API Reference
  • Order
    • Create Order
    • List Orders
    • Listing Orders by Order Status
    • Get Order by Order Number
  • Error Handling
  • Appendices
    • Appendix A: Order Status Types
    • Appendix B: Error Codes
  • Technical Support

Orders

Suggest Edits

Ready to start ordering? Use the following endpoints to create orders and obtain order information:

  • Create Orders
  • Get Orders
  • Get Orders by Status
  • Get Order by Order Number
  • Get Order by Client ID

Updated almost 3 years ago