DIVE Online API - Transaction Management

The transaction API endpoints allow for viewing account transaction limits.

These endpoints will reflect the account of whichever API token is used in the time of the request. For example, if the parent accounts API token is used, the transaction limits for the parent account will be returned.

/api/v2/public/Transaction/balance

[GET] /api/v2/public/Transaction/balance

Use Case - See an accounts transaction balance.

Token - public API token (pk_) or secret API Token (sk)

Required Parameters

None

Optional Parameters

None

Request Body

None

Response Body

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

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 (number) - 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/public/Transaction/history

[GET] /api/v2/public/Transaction/history

Use Case - Retrieve the transaction history for an account. For example, seeing recent deposits.

Token - public API token (pk_) or 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 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 specifies the type of transactions to filter by. The value must be one of the following: Credit, Debit.
  • 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-07T17:58:43.875Z",
      "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 (number) - The response ID associated with the transaction.
• items.created (string) - The date and time when the transaction was created in ISO 8601 format.
• items.amount (number) - The amount of the transactions.
• items.remainingAmount (number) - The remaining transaction amount given to the account.
• items.previousAmount (number) - The transaction amount before the transaction was applied.
• items.transactionType (number) -
  • 0 - Opened
  • 1 - Deposit
  • 2 - Charge
  • 3 - Chargeback