Skip to main content

Accounts Guide

The Accounts section allows you to create and manage virtual accounts for your users. Using these APIs, you can open accounts, view balances, track transactions, and close accounts when required.

Each account is created in a specific country and currency and can be used to receive funds through supported transfer methods.

What You Can Do with Accounts​

With the Accounts APIs, you can:

  • Create a virtual account for a user
  • View all accounts linked to a user
  • Get account details and status
  • Check balances across all currencies
  • Track transactions and balance changes
  • Permanently close an account

Operations​

> POST {{baseUrl}}/zoqq/api/v1/account
> GET {{baseUrl}}/zoqq/api/v1/account
> GET {{baseUrl}}/zoqq/api/v1/account/balance
> GET {{baseUrl}}/zoqq/api/v1/account/transactions
> GET {{baseUrl}}/zoqq/api/v1/account/balance/history
> DELETE {{baseUrl}}/zoqq/api/v1/account

Create Account​

Create a new virtual account for a user in a specific country and currency.

You must define:

  • Account type (virtual account)
  • Country and currency
  • Required transfer features (for example, LOCAL transfers)

Once created, the account becomes ACTIVE and ready to receive funds.

Use this when: You want to give a user a new virtual account to receive money.

Get All Accounts​

Retrieve all accounts linked to a user.

You can optionally filter accounts by:

  • Account ID
  • Currency
  • Account status (ACTIVE, INACTIVE, CLOSED)

Each account includes:

  • Account number
  • Account holder name
  • Bank details
  • Supported transfer methods

Use this when: You want to list all user accounts or find a specific account.

Get Account Details​

Retrieve detailed information about a specific account.

The response includes:

  • Account status
  • Bank and institution details
  • Supported transfer features
  • Routing and clearing information

Use this when: You need full account information for display or reconciliation.

Get Balance (All Accounts)​

Retrieve balance details for all currencies linked to a user.

For each currency, you’ll receive:

  • Available balance
  • Pending amount
  • Reserved amount

Use this when: You want to show wallet balances or check available funds before transactions.

Get Account Transactions​

Retrieve the transaction history for a specific account.

You can:

  • Paginate results
  • Filter transactions by date range (up to 31 days)

Each transaction includes:

  • Amount and currency
  • Transaction type (CREDIT or DEBIT)
  • Status
  • Timestamp and description

Use this when: You need transaction history for reporting, auditing, or reconciliation.

Get Balance History​

Retrieve a detailed history of balance changes for an account.

This shows how the balance changed over time due to:

  • Deposits
  • Payouts
  • Currency conversions

You can filter results by date range (up to 7 days).

Use this when: You want to track balance movements or investigate balance changes.

Close Account​

Permanently close an account.

Once closed:

  • The account cannot be used again
  • This action cannot be undone

Use this when: An account is no longer needed or must be disabled permanently.

Important Notes​

  • All APIs require a valid access token
  • All requests must include required headers (API key, product ID, user ID)
  • Closed accounts cannot be reopened
  • Date filters must be provided together (from_date and to_date)