HEhevn-inc
transactions

Inflow and outflow totals for the same filters

Changed on

Its own route: an aggregate is never folded into a page.

get/transactions/summary

Request

Query parameters

typestring nullable

Comma-separated transaction types

statusstring nullable

Comma-separated statuses

tagstring nullable

Comma-separated tags

contactIdstring nullable
bankIdstring nullable
incomeOnlyboolean nullable
qstring nullable
fromstring date-time nullable
tostring date-time nullable

Headers

X-Hevn-Accountstring nullable

The client account to act for, as a cl_… id. Omit it to act as yourself.

Example:cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41

Response

Successful Response

inflowUsdstring required

Settled incoming value converted to USD for the selected period.

inflowCountinteger required

Number of settled incoming transactions in the selected period.

outflowUsdstring required

Settled outgoing value converted to USD for the selected period.

outflowCountinteger required

Number of settled outgoing transactions in the selected period.

pendingInflowUsdstring required

Pending incoming value converted to USD.

pendingInflowCountinteger required

Number of pending incoming transactions.

pendingOutflowUsdstring required

Pending outgoing value converted to USD.

pendingOutflowCountinteger required

Number of pending outgoing transactions.

Example response

{
  "inflowUsd": "500.00",
  "outflowUsd": "500.00",
  "pendingInflowUsd": "500.00",
  "pendingOutflowUsd": "500.00"
}

Changes

  • 299a3aa6f521Revision changes
    • warning

      added the new verification_not_applicable enum value to the / response property for the response status

    • info

      removed the phone_required enum value from the / response property for the response status

    • info

      removed the rail_requirements_unmet enum value from the / response property for the response status

  • a02795de2d2bRevision changes
    • warning

      deleted the header request parameter x-api-key

    • warning

      added the new client_already_linked enum value to the / response property for the response status

    • warning

      added the new kyb_documents_processing enum value to the / response property for the response status

    • warning

      added the new link_code_expired enum value to the / response property for the response status

    • warning

      added the new link_code_invalid enum value to the / response property for the response status

    • warning

      added the new payout_not_awaiting_signature enum value to the / response property for the response status

    • warning

      added the new redirect_uri_not_allowed enum value to the / response property for the response status

    • warning

      added the new sandbox_amount_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new sandbox_faucet_balance_too_high enum value to the / response property for the response status

    • info

      removed the client_policy_not_enabled enum value from the / response property for the response status

    • info

      removed the client_request_conflict enum value from the / response property for the response status

    • info

      removed the email_in_use enum value from the / response property for the response status

    • info

      removed the integrator_inactive enum value from the / response property for the response status

    • info

      removed the name_in_use enum value from the / response property for the response status