Core Account Types
UsePOST /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.
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. UsePOST /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 /accountssupports 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.