Skip to main content
GET
/
v1
/
velocity
/
rules
List applicable velocity rules
curl --request GET \
  --url http://localhost:8080/v1/velocity/rules \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "type": "max_amount_per_txn",
      "scope": "global",
      "merchant_id": "<string>",
      "action": "block",
      "threshold": "<string>",
      "currency": "<string>",
      "window_secs": 123,
      "enabled": true,
      "priority": 123,
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123,
    "has_more": true
  }
}

Authorizations

Authorization
string
header
required

Merchant API key: ak_live_... or ak_test_...

Response

200 - application/json

Applicable velocity rules

data
object[]
pagination
object