API keys

How do I get an API key?

Contact us at [e-mail] 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 staging.pay.gov.sg and pay.gov.sg before. Note that the API key holder must be added as a collaborator on 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 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?

For testing purposes, you may use your individual gov.sg email address. For our production environment, we typically suggest teams to use a group email address (e.g. [e-mail]).

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.