API

Authentication

Merchant server calls use a shared secret API key.


Payment Engine

X-API-KEY: <your-api-key>

Use the API key generated for the target VenPays profile (Sandbox or Live). Keys authenticate server-to-server requests to the Payment Engine.

If authentication or authorization fails, the API returns an error response. Confirm you are using:

  • The correct environment host
  • A key created for that environment’s profile
  • A key that has not expired or been deleted

Dashboard

Merchant users sign in to the VenPays dashboard with their account credentials. Dashboard session APIs are for the product UI — they do not replace Payment Engine integration with X-API-KEY.


Native Apple Pay

After native initiation, your mobile app receives a short-lived session token for Apple Pay authorization. The app must never hold the merchant X-API-KEY.