PayJoy · Authentication Profile

Payjoy Authentication

Authentication

PayJoy secures its APIs with apiKey and http across 2 declared security schemes, as derived from its OpenAPI definitions.

CompanyFintechPaymentsLendingBuy Now Pay LaterPoint of SaleEmerging MarketsFinancial InclusionPartner API
Methods: apiKey, http Schemes: 2 OAuth flows: API key in: header

Security Schemes

PayJoyApiKeyAuth apiKey
· in: header (X-PayJoy-ApiKey)
EcommerceBearerAuth http
scheme: bearer

Source

Authentication Profile

Raw ↑ 
generated: '2026-07-20'
method: searched
source: openapi/payjoy-partner-api-openapi.yml
docs: https://developers.payjoy.com/sales-integration/basics/authentication
summary:
  types:
  - apiKey
  - http
  api_key_in:
  - header
  model: >-
    PayJoy uses API keys for machine-to-machine authentication. Each partner generates a unique
    key in the Partner Console (Admin Console) under the API menu. The Partner API V2 sends the
    key in the `X-PayJoy-ApiKey` header. The separate E-commerce API uses a bearer token plus a
    symmetric Base64 "E-commerce Key" used to encrypt customer PII. There is no OAuth surface.
schemes:
- name: PayJoyApiKeyAuth
  type: apiKey
  in: header
  parameter: X-PayJoy-ApiKey
  api: PayJoy Partner API V2 (Sales Integration)
  description: API key required to authenticate all requests. Include this key in the request
    header as `X-PayJoy-ApiKey`.
  provisioning: Partner Console (https://app.payjoy.com/admin-console/login) -> API -> New
  sources:
  - openapi/payjoy-partner-api-openapi.yml
- name: EcommerceBearerAuth
  type: http
  scheme: bearer
  api: PayJoy E-commerce API
  description: >-
    PayJoy-issued API key passed in an Authorization bearer header. A separate symmetric Base64
    "E-commerce Key" is used to encrypt customer data sent to PayJoy (not an auth credential).
  source_docs: https://developers.payjoy.com/ecommerce/basics/authentication
  sources:
  - docs