Reorder Routing Rules

POST

/api/:account_id/routing-rules/reorder

POST

/api/:account_id/routing-rules/reorder

curl -X POST https://app.paymentkit.com/api/account_id/routing-rules/reorder \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "rule_ids": [
    "rrule_dev_aaa",
    "rrule_dev_bbb"
  ]
}'

{
  "data": [
    {
      "id": "rrule_dev_a1b2c3d4e5f6g7h8",
      "name": "string",
      "position": 1,
      "match_mode": "all",
      "conditions": [
        {
          "field": "initiator",
          "operator": "equals",
          "value": null
        }
      ],
      "outcome": "route_to",
      "status": "draft",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "route_id": "string",
      "route_distribution": [
        {
          "route_id": "proute_dev_x7k9m2n4p8q1",
          "weight": "80"
        }
      ]
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}

Set the evaluation order. Must list every rule for the account. New positions take effect on the next payment attempt.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Request

This endpoint expects an object.

rule_idslist of stringsRequired

Every rule id for this account, in the desired evaluation order. Position 1 is evaluated first. Partial lists are rejected — an omitted rule would get an ambiguous position.

Response

Successful Response

datalist of objects

totalinteger

limitinteger

offsetinteger

Errors

422

Unprocessable Entity Error