Enable a SDK installation
Re-enable a previously disabled SDK installation. Once enabled, the installation can resume making API calls like tokenizing cards or creating payments.
Common reasons to re-enable an installation:
- You've completed maintenance or updates on your application
- You're ready to resume accepting payments on a specific platform
- You've resolved any security concerns about unauthorized usage
- You're bringing a previously decommissioned application back online
Note that enabling an installation takes effect immediately and restores the
exact same configuration and settings from before it was disabled. This also
does not require any changes to your integration code and can be reversed at any
time by using the disable-installation endpoint.
For security best practices, we recommend only enabling installations that are actively being used.
installation_id
string
Required. The unique identifier of the installation to enable. This is the ID that was returned when you created the installation.
NOT_FOUND
This error occurs when no installation with the provided ID exists in your merchant account. Double check that you're using the correct installation ID.
UNHANDLED_ERROR
This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.
INVALID_ARGUMENTS
This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.
BAD_VERSION
This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.
curl "https://api.reservepay.com/merchants/enable-installation" \
-X POST
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer $(RESERVEPAY_API_KEY)" \
-d '{
"installation_id": "ins_xhBi6ypq9G"
}'
