Skip to main content
Welcome to the Paygen Cards API documentation. Our RESTful API enables developers to programmatically issue, fund, and manage virtual and physical cards. Whether you are building an operational ledger, a full-scale digital wallet, or an embedded financial product, Paygen provides the infrastructure you need to seamlessly move money and manage spend.

​
What you can do

The API is built around four core resources:
  • Accounts: Provision wallets and settlement checking accounts to hold fiat funds.
  • Card Holders: Create and manage identities, including KYC document uploads.
  • Cards: Issue new cards, fund them from debit accounts, manage status controls, and reliably reveal secure primary account numbers (PAN) via PCI-compliant tokenized flows.
  • Events: Inspect the real-time event catalog and delivery logs for all system activities.

​
How this documentation is organized

  • The Guides tab provides deeper conceptual insight into integration models, authentication strategies, webhooks, and core account or card workflows.
  • The API Reference tab contains our comprehensive OpenAPI-driven documentation, enabling you to explore endpoints, data models, and request/response specifications dynamically.

​
Response format

Most endpoints, including mutations and retrievals, return a standard, predictable envelope. This consistency simplifies your API integrations: 
{
  "statusCode": 200,
  "message": "Data fetched successfully.",
  "data": {},
  "meta": {}
}
The meta object is present on list endpoints that support pagination, sorting, and filtering.

​
Authentication model

We support standard, secure authentication mechanisms. Protected endpoints accept one of the following methods:
  • Bearer Token: Passed via the Authorization: Bearer <token> header, typically used in user-authenticated or ephemeral contexts.
  • API Key: Passed via the x-api-key: <api-key> header, ideal for server-to-server integrations.
Public resource endpoints for cards, accounts, card holders, and events can be called with either credential depending on what is supported by your specific integration type.

​
Base URL

Our sandboxed development environment is the default server for testing: 
https://api-dev.paygen.online