• Home
  • Definitions
  • API
  • About
    • Intended Audience
    • PIN Validation
    • Logging
    • Transaction Reversal
    • Error handling
    • Request ID
    • Date Format
  • Getting Started
    • Environments
    • API Endpoint Format
  • Certification and Going Live
  • Documentation
    • Authentication
    • Loading
    • Redeeming
      • Basket
        • Basket Scenario 1
        • Basket Scenario 2
        • Basket Scenario 3
        • Basket Scenario 4
    • Balance
    • Reversing
    • Card Actions
    • Understanding Responses
      • Response Codes
      • Common Causes for Non-Zero Response Codes
        • Card Locking
        • Limits
        • Expiry
        • MID Transaction Control
        • Card Range Management
        • Part-Payment/ Insufficient Funds
      • Response Code 20
    • Miscellaneous
      • Start Date
      • User Interface
      • Observations
      • Timeouts, Retries & Rate Limits
      • Card Types and Card Status

Getting Started

All of our REST API endpoints are available only for authenticated users.

We will provide you with:

  • The subscription key

  • Your adminTeamId

  • A merchant ID (or multiple merchant IDs if required)

  • A secret key (one per merchant ID)

The values of these elements typically differ between the test/Sandbox environment and the production environment.

Next Section