Documentation
Test environmentLive environmentStatusContact us
  • Overview
    • Get started
    • Resource guides
      • For business users
      • For finance teams
      • For integration teams
    • Stripe onboarding
    • Live use cases
      • Usage overview
  • Start using the dashboard
    • Access
    • Payment services
    • Collaborators and access control
    • One-time payment links
      • Single link creation
      • Bulk link creation
      • Send payment links
      • Payment link page
      • Payment receipt email
    • Subscriptions
      • Set-up
      • View subscriptions
      • Manage subscriptions
    • Payments and refunds
      • Payment methods
      • Dashboard
      • Refunds
    • Payouts
    • Reports
    • Payment workflows with Plumber
      • Set-up
      • Testing
    • Payment forms
      • Set-up
      • Testing
      • Resources
  • Start an API integration
    • Get started
    • Endpoints
    • Integrating with your e-services
    • Errors
    • Idempotency
    • Pagination
    • Go-live checklist
  • API RESOURCES
    • Events
      • The event object
      • Types of events
    • Payments
      • Create a payment
      • Retrieve payments
      • Send email for payment
      • Cancel a payment
      • Refund a payment
      • Get all payments from payment service
  • WEBHOOKS
    • Introduction
    • Set-up
      • Events
      • Best practices
  • FAQ
    • Access
    • Costs
    • Timeline
    • API keys
    • API integration
    • Payments
    • Payment methods
    • Payouts and transaction fees
    • Refunds
    • Security and compliance
    • Downtime and maintenance
  • Policies
    • Privacy Policy
    • Terms of Use
Powered by GitBook
On this page
  • How do I get an API key?
  • Why doesn't my API key work?
  • Do I need a new API key for each payment service?
  • Does the API key expire?
  • What email address should I use for the API key?
  • What happens to the API key if the API key holder leaves the organisation?

Was this helpful?

  1. FAQ

API keys

PreviousTimelineNextAPI integration

Last updated 26 days ago

Was this helpful?

How do I get an API key?

Contact us at with a valid gov.sg email for an API key to be provisioned. Please ensure that the email address has been used to log in to and before. Note that the API key holder must be added as a Billing collaborator on the payment service.

Why doesn't my API key work?

Ensure that the email address the API key was issued to is added as a Billing collaborator to the payment service.

Do I need a new API key for each payment service?

No, API keys are associated with email addresses, not payment services. As long as the API key holder is added as a Billing collaborator on the relevant payment service, the API key can be used to create payments via API.

Does the API key expire?

No, our API keys do not currently expire.

What email address should I use for the API key?

We typically suggest teams to use a group email address (e.g. agency-finance-team@agency.gov.sg).

What happens to the API key if the API key holder leaves the organisation?

The API key will still remain valid. However, we strongly suggest the team either use a group email for the API key, or ensure that a new API key is issued to someone within the organisation.

go.gov.sg/contact-paysg
staging.pay.gov.sg
pay.gov.sg