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

Attributes

4.1.1 Attributes

qr code content required

All RedeemSG Voucher QRs begin with either the prefix rsg: or rsg-cfhp:. You should not remove the prefix. Instead, send the entire QR code content as is.

Vouchers from NEA PUB Enhanced Climate Friendly Households Programme (CFHP) will begin with prefix rsg-cfhp:, while all other RedeemSG vouchers will begin with prefix rsg:.

The QR code content grows according to the number of vouchers selected, but will not exceed a maximum of 500 characters. This limit is imposed to prevent the QR from becoming too dense, which increases the likelihood of scan errors.

metadata

An arbitrary string which you can attach to this redemption request. The maximum length of the string is 1000 characters. This will be available in the transaction data which can be used for the merchant’s reconciliation purposes.

We highly recommend the inclusion of the following information if available for better visibility and dispute resolution scenarios:

  1. Branch / store ID

  2. POS / Terminal / Counter ID

  3. Cashier / staff ID

  4. Cashier / staff Name

  5. Verifier ID

  6. Receipt number required

  7. SKU required

Example:

"metadata": "branch_code:123,pos_ID:456,cashier_ID:001,receipt_number:789,SKU:001,002"
PreviousPOST /v1/vouchers/redeemNextReturns

Last updated 4 months ago