Skip to main content
When building the integration that connects your organization to Payward Services, user and account name resources in the API.

User vs. account

A user is the API resource associated with one or more Payward accounts. In a client-facing integration, it represents a client. An account holds that user’s balances and activity. A new user starts with one account; you can create additional accounts for the same user. Within the Get user response’s data object, id is the user ID and accounts[].id contains the account IDs. Use an account ID for account-scoped calls; a user ID isn’t interchangeable with it.

Payward account vs. bank account or wallet

A Payward account is separate from an external bank account or blockchain wallet. An API request can identify a Payward account while using funds from an external wallet, as on-chain swaps do. With Bank links, a bank_link_id identifies a connection to a bank. An account_link_id identifies one bank account shared through that connection. Neither is a Payward account_id.

Account scope vs. ownership checks

Your credentials authenticate your integration. The user or account ID selects the resource the request acts on. The operation still has its own ownership and permission requirements; knowing an ID doesn’t grant access. See Verification, permissions, and eligibility.