Skip to main content
Version: 1.0.0

Peak Gateway Internal API

Internal OpenAPI reference for private Peak Gateway endpoints.

Conventions:

  • All IDs are UUIDs unless noted otherwise.
  • Most responses use the standard ApiResponse wrapper.
  • Role hierarchy: super_admin > admin > merchant_admin > merchant_user > readonly.

Authentication​

OAuth2 bearer token authentication.

Security Scheme Type:

oauth2

OAuth Flow (clientCredentials):

Scopes:

  • merchant:activate: Activate merchant payment processor transit

  • provision:request: Create/read/manage provisioning jobs

  • internal:credentials:read: Read internal merchant credentials

  • internal:credentials:rotate: Rotate internal merchant credentials