Skip to main content
Accounts in Paygen represent the core funding mechanisms and ledgers that enable the rest of your card infrastructure. Before you can issue or fund cards, you must establish an account structure.

Core Account Types

Use POST /accounts to create wallets or ledgers that cards can draw from. When establishing an account, you will typically assign it to a specific owner (ownerType: business or individual) and define its operational purpose. Common account patterns in Paygen include:
  • Fiat Checking Accounts: Used as the primary funding source for deducting card transactions at settlement.
  • Treasury Accounts: Used for internal reconciliation and holding centralized aggregate funds.
  • Provider-Owned Accounts: Managed external accounts mapped to downstream processors or partner banks.
A typical account creation payload:
{
  "ownerType": "business",
  "ownerId": "665f1c4f4a4f4a4f4a4f4a4f",
  "name": "Primary USD Wallet",
  "type": "checking",
  "category": "fiat",
  "currency": "USD"
}

Attaching Account Details

Once an account exists, you often need to store external coordinates, compliance metadata, or provider routing instructions against it. You can manage this via the Account Details sub-resource. Use POST /accounts/{accountId}/details to attach metadata records such as bank account routing numbers, crypto wallet addresses, or payout rails. This enables you to:
  • Store settlement coordinates securely.
  • Keep provider-specific records attached to the ledger without bloating the core account object.
  • Manage multiple sets of details (e.g., ACH instructions vs. Wire instructions) under a single account.

Managing the Account Lifecycle

The API provides traditional RESTful access for querying and updating accounts over time:
  • List and filter: GET /accounts supports robust pagination, search, and sorting.
  • Retrieve balances: GET /accounts/{accountId} returns the current available and ledger balances along with configuration states.
  • Modify settings: PUT /accounts/{accountId} allows you to update the account name, status, or any associated custom metadata.
For a comprehensive list of properties and parameters, consult the Accounts API Reference.