Skip to main content

Authentication

The Partner API uses HTTP Basic Authentication with API keys to secure all requests.

Getting Credentials​

Contact your Paytient account manager to receive:

  • Client ID - Your unique API identifier
  • Client Secret - Your authentication secret (keep this secure!)
Keep Your Secrets Safe

Never commit your client secret to version control or share it publicly. Treat it like a password.

API Versioning​

All requests must include the api-version header specifying which API version to use.

api-version: 2024-01-16
Current Version

The current API version is 2024-01-16.

Requests without this header will fail with a 400 Bad Request error.

Learn more about API versioning →

Security Best Practices​

Store Credentials Securely​

  • check_circle Use environment variables
  • check_circle Use secret management services (AWS Secrets Manager, HashiCorp Vault, etc.)
  • cancel Don't hardcode credentials in source code
  • cancel Don't commit credentials to version control

Next Steps​

Now that you understand authentication: