DIVE Online API - Transaction Management

The transaction mangaement API endpoints allow the DIVE Online account to programmatically maintain it's subaccount transaction limits.

This includes enabling transactions for subaccounts, viewing transaction balances, depositing transactions, and retrieving transaction history.

/api/v2/public/TransactionManagement/balances

[GET] /api/v2/public/TransactionManagement/balances

Use Case - See an accounts transaction balance.

Token - secret API Token (sk)

Required Parameters

None

Optional Parameters

  • Page - specifies the page number to return. The value must be between 1 and 2147483647.
  • PageSize - specifies the number of items to return per page. The value must be greater than 10.
  • SortField - The value must be one of the following: accountName, remainingAmount, updateDate.
  • Order - can be either asc or desc to specify the order of the results.
  • TextFilter - specifies a text string to filter the account names by.
  • Active (boolean) - when set to true, only accounts with transactions enabled will be returned. When set to false, only accounts with transactions disabled will be returned.

Request Body

None

Response Body

{
  "page": 0,
  "pageSize": 0,
  "total": 0,
  "totalPages": 0,
  "items": [
    {
      "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "accountName": "string",
      "transactionsEnabled": true,
      "remainingAmount": 0,
      "updateDate": "2026-01-07T21:17:02.165Z",
      "contactName": "string"
    }
  ]
}

Response Fields

  • page The current page number.
  • pageSize The number of items per page.
  • total The total number of items.
  • totalPages The total number of pages.
items — An array of transactions.
  • accountId (string) - The unique identifier for the account.
  • accountName (string) - The name of the account.
  • transactionsEnabled (boolean) - Indicates if transactions are enabled for the account.
  • remainingAmount (int) - The remaining transaction amount available for the account.
  • updateDate (string) - The date and time when the transaction balance was last updated in ISO 8601 format.
  • contactName (string) - The name of the primary contact for the account.

/api/v2/private/TransactionManagement/balance/{subaccountId}

[GET] /api/v2/private/TransactionManagement/balance/{subaccountId}

Use Case - See a specific subaccount's transaction balance.

Token - secret API Token (sk)

Required Parameters

  • subaccountId The unique identifier for the subaccount.

Optional Parameters None

Request Body None

Response Body

{
  "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "accountName": "string",
  "transactionsEnabled": true,
  "remainingAmount": 0,
  "updateDate": "2026-01-07T21:21:38.366Z"
}

Response Fields

  • accountId (string) - The unique identifier for the account.
  • accountName (string) - The name of the account.
  • transactionsEnabled (boolean) - Indicates if transactions are enabled for the account.
  • remainingAmount (int) - The remaining transaction amount available for the account.
  • updateDate (string) - The date and time when the transaction balance was last updated in ISO 8601 format.

/api/v2/private/TransactionManagement/enable/{subaccountId}

[POST] /api/v2/private/TransactionManagement/enable/{subaccountId}

Use Case - Enable transactions for a specific subaccount.

Token - secret API Token (sk)

Required Parameters

  • subaccountId The unique identifier for the subaccount.

Optional Parameters None

Request Body

{
    "enabled": true
}
  • enabled (boolean) - Indicates if transactions have been successfully enabled for the subaccount.

Response Body

A successful response will return an HTTP status code of 200.


/api/v2/private/TransactionManagement/deposit/{subaccountId}

[POST] /api/v2/private/TransactionManagement/deposit/{subaccountId}

Use Case - Deposit transactions into a specific subaccount.

Token - secret API Token (sk)

Required Parameters

  • subaccountId The unique identifier for the subaccount.

Optional Parameters None

Request Body

{
    "transactionAmount": 0
}
  • transactionAmount (int) - The amount of transactions to deposit into the subaccount.

Response Body

{
  "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "updateDate": "2026-01-07T21:27:53.192Z",
  "remainingAmount": 0
}

Response Fields

  • accountId (string) - The unique identifier for the account.
  • transactionId (string) - The unique identifier for the deposit transaction.
  • updateDate (string) - The date and time when the transaction balance was last updated in ISO 8601 format.
  • remainingAmount (int) - The remaining transaction amount available for the account after the deposit.

/api/v2/private/TransactionManagement/history/{subaccountId}

[GET] /api/v2/private/TransactionManagement/history/{subaccountId}

Use Case - Retrieve the transaction history for a specific subaccount.

Token - secret API Token (sk)

Required Parameters

  • subaccountId The unique identifier for the subaccount.

Optional Parameters

  • Page specifies the page number to return. The value must be between 1 and 2147483647.
  • PageSize specifies the number of items to return per page. The value must be between 1 and 400.
  • CreatedFrom specifies the start date for filtering transactions. The value must be in ISO 8601 format.
  • CreatedTo specifies the end date for filtering transactions. The value must be in ISO 8601 format.
  • TransactionType :
    • 0 - Opened
    • 1 - Deposit
    • 2 - Charge
    • 3 - Chargeback
  • ResponseId specifies a specific transaction ID to filter by.

Response Body

{
  "page": 0,
  "pageSize": 0,
  "total": 0,
  "totalPages": 0,
  "items": [
    {
      "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "responseId": 0,
      "created": "2026-01-07T21:30:26.278Z",
      "amount": 0,
      "remainingAmount": 0,
      "previousAmount": 0,
      "transactionType": 0
    }
  ]
}

Response Fields

  • page The current page number.
  • pageSize The number of items per page.
  • total The total number of items.
  • totalPages The total number of pages.
items — An array of transactions.
  • items.transactionId (string) - The unique identifier for the transaction.
  • items.responseId (int) - The response identifier associated with the transaction.
  • items.created (string) - The date and time when the transaction was created in ISO 8601 format.
  • items.amount (int) - The amount of the transaction.
  • items.remainingAmount (int) - The remaining transaction amount available for the account.
  • items.previousAmount (int) - The previous transaction amount before the current transaction.
  • items.transactionType (int) - The type of transaction, represented as an integer.