Create rule

Create a standing instruction: when funds become available on the trigger account, transfer them to the target. At most one non-archived rule may watch a given trigger account.

cURL

sweep

curl --request POST \
  --url https://platform.swipelux.com/v3/customers/{customerId}/rules \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "trigger": {
    "type": "funds_received",
    "accountId": "acc_6dV8xN2pQ4rT7mA9sL1kBc"
  },
  "action": {
    "type": "transfer",
    "target": {
      "type": "destination",
      "id": "dst_7mA9sL1kBc6dV8xN2pQ4rT"
    }
  },
  "label": "Operating wallet sweep"
}
'

201

sweep

{
  "data": {
    "id": "rul_8Q2mVtP0aXk1LzR4nJ6b7c",
    "customerId": "cus_4rT7mA9sL1kBc6dV8xN2pQ",
    "status": "active",
    "trigger": {
      "type": "funds_received",
      "accountId": "acc_6dV8xN2pQ4rT7mA9sL1kBc"
    },
    "action": {
      "type": "transfer",
      "target": {
        "type": "destination",
        "id": "dst_7mA9sL1kBc6dV8xN2pQ4rT"
      }
    },
    "label": "Operating wallet sweep",
    "createdAt": "2026-07-10T09:15:00.000Z",
    "updatedAt": "2026-07-10T09:15:00.000Z",
    "archivedAt": null
  }
}

Authorizations

X-API-Key · string · header · required

Headers

Idempotency-Key · string · required

Required for effectful v3 requests (POST, PATCH, PUT, DELETE). Reuse the same key with the same body to replay the cached response.

Required string length: 1 - 255

Path Parameters

customerId · string · required

Body

application/json

trigger · object · required

Show child attributes

action · object · required

Show child attributes

label · string

Maximum string length: 255

metadata · object

Show child attributes

Response

201

application/json

Rule created

data · object · required

Show child attributes