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. Retrieving transactions

Request

5.2 Request

Request Parameters

The paginated endpoint takes in the following as optional query parameters

Purpose
Query param
Type
Description

[Filter]

start

String (YYYY-MM-DD)

Filter transactions starting from date (inclusive)

[Filter]

end

String (YYYY-MM-DD)

Filter transactions ending on date (inclusive)

[Pagination]

limit

Number (Default: 1000)

Indicates the number of results per page.

[Pagination]

after

String

Takes reference to this cursor to get to the next page

[Pagination]

before

String

Takes reference to this cursor to get to the previous page

Sample Requests

  1. Request without query params (returns all data, with default page limit of 1000)

    /v1/transactions
  2. Request with filter (returns transactions that occurred between 2022-02-01 and 2022-02-28, inclusive of both dates, with default page limit of 1000)

    /v1/transactions?start=2022-02-01&end=2022-02-28
  3. Request with filter and page limit of 10 (returns transactions that occurred between 2022-02-01 and 2022-02-28, inclusive of both dates, with maximum 10 transactions per page)

    /v1/transactions?start=2022-02-01&end=2022-02-28&limit=10
  4. Request with filter and page limit of 10, with after param, using end_cursor of previous request (returns transactions that occurred between 2022-02-01 and 2022-02-28, inclusive of both dates, with maximum 10 transactions per page, specifying the next page)

    /v1/transactions?start=2022-02-01&end=2022-02-28&limit=10&after=WyIyMDIyLTAyLTI0VDAxOjAxOjAzLjE5MiswODowMCIsInRyYW5zYWN0aW9uX2QxMmZiMGIxLTc4NzktNDU2Yi1iZDliLTNjMzIzOGE5NTkzNSJd

PreviousGET /v1/transactionsNextResponse

Last updated 7 months ago