API Reference
Get transaction volume
Returns the sum of the matching amounts. It adds up every currency, direction and status you do not filter out, so filter by an account and status=completed. There is no date filter.
Query Parameters
One or more channels, comma-separated, such as ach,wire. See the channel values on the transaction. An unknown value returns nothing.
Possible values: in, out
One or more of pending, completed, failed, waiting_approval and paused, comma-separated
One or more transaction types, comma-separated. See the transaction_type values on the transaction. An unknown value returns nothing.
Responses
| Status | Description |
|---|---|
200 |
The total |
400 |
The request failed. Every transactions error is a 400, including not-found. |
200 response
Sum of the matching amounts, as a decimal string
{
"data": {
"total_volume": "12450.75"
},
"error": null
}
400 response
{
"data": null,
"error": "invalid request params"
}
Authorization
- ApiKeyAuth
Was this page helpful?