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

Changelog

Date
Section
Details

10 February 2025

4.1.1 Attributes

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

29 November 2024

3.1 In event of leaked API key

API keys do not expire at the moment.

In the event of a leaked API key:

  • For test environment, you may revoke the leaked key and create a new key via developer's portal

  • For live environment, email team@redeem.gov.sg for a new key

1 Oct 2024

4.1. POST /v1/vouchers/redeem

SKU: and receipt_number: are only required for Climate Vouchers programme. It is mandatory, and the format should follow the above example specifically for these 2 details. Do note to only include eligible items’ SKUs.

20 Sep 2024

4.1. POST /v1/vouchers/redeem

SKU: and receipt_number: are only required for Climate Vouchers programme. It is mandatory, and the format should follow the following example specifically for these 2 details: e.g. receipt_number:789,SKU:001,002

13 Aug 2024

6.2 Error codes

For all campaigns - You should show the error.message below as-is on your POS

27 June 2024

4.1. POST /v1/vouchers/redeem

For Climate Vouchers only - Additional requirement to include receipt_number:xxx in metadata

14 May 2024

4.2.1 Introduction

For all campaigns - Compulsory to include idempotency key whenever making a redemption call to RedeemSG API

PreviousError codesNextTech requirement

Last updated 4 months ago