Authenticate every /v1 request with HTTP Basic (API key id + secret).
Log in to see your API keys
| API Key | Label | Last Used | |
|---|---|---|---|
Scheme
All Merchant API routes use HTTP Basic Auth.
| Piece | Header role | Format |
|---|---|---|
| Key id | username | vbk_test_… (sandbox) or vbk_live_… (production) |
| Secret | password | shown once when the key is issued |
Authorization: Basic base64({keyId}:{secret})curl -sS -u "$KEY_ID:$SECRET" "$BASE_URL/v1/accounts"How to get keys
Issue and revoke keys from the dashboard Security page. Enovipay ops can also issue or revoke on your behalf. There is no credential signup on /v1.
Only a hash of the secret is stored. If it is lost, create a new credential and revoke the old one.
Rules
- Do not send dashboard JWT cookies or CSRF tokens.
- Five consecutive failed authentications lock that credential for 15 minutes.
- Revocation is permanent.
- Failed auth returns
401with messageInvalid API credentials(the sharederror.codemay readTOKEN_EXPIRED— that does not mean a JWT expired).
Try It in this reference
In the API Explorer, set the Basic Auth username to your key id and the password to your secret. Use base URL https://viban-api.enovipay.com.
Amounts and scope
- Amounts are major units (e.g.
1250.00). - Every call is scoped to the merchant that owns the credential — never send a merchant id.
- Supported currencies:
USD,AED,EUR,GBP.
More detail: Authentication guide.
