Disable a SDK installation
Temporarily disable a SDK installation. This will prevent the installation from being able to make API calls like tokenizing cards or creating payments.
Common reasons to disable an installation:
- You're decommissioning an old version of your application
- You want to temporarily stop accepting payments on a specific platform
- You suspect unauthorized or malicious use from a specific installation
- You're performing maintenance or updates on your application
You can re-enable a disabled installation at any time using the
enable-installation endpoint.
Note that disabling an installation only affects its ability to make API calls - it does not delete the installation or any of its settings. The installation ID remains valid and can be used again once re-enabled.
installation_id
string
Required. The unique identifier of the installation to disable. 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.
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/disable-installation" \
-X POST
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer $(RESERVEPAY_API_KEY)" \
-d '{
"installation_id": "ins_xhBi6ypq9G"
}'