RedeemSG Integration Guide
  • Overview
  • PHASE 1: GETTING STARTED
    • Submit interest to NEA
    • Information provided
  • PHASE 2: INTEGRATION
    • Overview
    • API documentation
      • Introduction
      • Environment
      • Authentication
        • In event of leaked API key
      • Redeeming a QR code Voucher
        • POST /v1/vouchers/redeem
          • Attributes
          • Returns
        • Making Idempotent Redemption Requests
          • Introduction
          • Implementation and Details
      • Retrieving transactions
        • GET /v1/transactions
        • Request
        • Response
      • Errors
        • Overview
        • Error codes
      • Changelog
    • Tech requirement
      • Overall flow
      • Sales System Requirements
      • Reconciliation requirements
      • Changelog
    • Generate API keys
      • Login
      • Create API key
  • PHASE 3: UAT
    • Overview
    • Complete test cases
      • Create vouchers
      • Download test cases
    • UAT self-review
      • Review UAT results
    • Inform NEA
    • UAT with RedeemSG
      • UAT submission
    • What should I do if I have questions?
      • FAQs
      • Weekly office hours
  • PHASE 4: PRODUCTION TESTING
    • Production testing
      • Arrange date for prod testing
      • Test cases conducted
      • Items to prepare
      • FAQs
    • Ops readiness check
Powered by GitBook
On this page
  1. PHASE 2: INTEGRATION
  2. API documentation
  3. Redeeming a QR code Voucher
  4. POST /v1/vouchers/redeem

Returns

4.1.2 Returns

Returns a transaction object and a campaign object.

The campaign object refers to which campaign the vouchers you sent belong to, e.g. CDC Vouchers 2022, NEA Climate-Friendly Household Package, or CDC Vouchers 2023.

The transaction object will be referenced for financial reconciliation.

PreviousAttributesNextMaking Idempotent Redemption Requests

Last updated 5 months ago