API Keys
Ansa uses API keys to authenticate and authorize access to the Ansa platform.
Keep your API keys safe
If you think that a key might be lost or compromised, please contact
[email protected]right away to deactivate the old key and generate a new one.
Merchant Secret Key
When you onboard with Ansa, you will receive merchant API secret keys that are used to authenticate with live and sandbox environments, respectively.
Certain API endpoints must be invoked with a merchant secret key to authorize access to merchant-scoped functionalities.
Keep merchant secret keys secure
Ansa strongly recommends that Merchant Secret Keys are never accessible to client devices or applications, and remain only in the context of secret management within your application backend.
Client Secret Key
The client secret is a credential that is valid for a short period of time which provides access to customer-scoped endpoints.
To enable your app or frontend client to use Ansa's payment/balance APIs directly, you need to create an endpoint on your server. This endpoint should allow clients to call the backend to create a Payment Session using the merchant secret key.
Merchant Publishable Key
When you onboard with Ansa, you will receive a merchant publishable key.
This key can be publicly accessible in your web or mobile app's client-side code. It is used to initialize the client-side SDKs and is authorized to invoke selected API endpoints.
Request Authentication
Ansa uses an Authorization request header to authenticate API calls. Ansa requires the API key to be present in the Authorization header for all API requests to our platform. All unauthorized requests will receive a 401 Unauthorized response.
Sandbox and Live Environments
Ansa API keys have prefixes to easily identify their environment and usage.
ansa_sk_live_{identifier} // live merchant secret key prefix
ansa_sk_sandbox_{identifier} // sandbox merchant secret key prefix
ansa_cs_live_{identifier} // live customer secret key prefix
ansa_cs_sandbox_{identifier} // sandbox customer secret key prefix