Create a receive ruleset

​

Create an immutable receive ruleset and provision dedicated deposit addresses. The recipient must be an ACTIVE wallet registered to the owning account. Optional senderUserId links a user with a saved location in that exact account; the link is immutable and uses the Receive creation entitlement. Pass subaccountId to create one for a direct child. Addresses start PENDING and provision asynchronously. INSTANT creation requires a configured delivery asset and operational wallet. With forceInstant: true, deposits wait for instant settlement when the corridor or pool is unavailable. Without it, an unavailable corridor or pool falls back to NETTED. A disabled payout asset is held in either mode. Deposits over the applicable account threshold are held.

Body

required
application/json
  • deliveredAsset
    Type: string
    min length:  
    1
    required
  • deliveredChain
    Type: string
    min length:  
    1
    required
  • toAddress
    Type: string
    min length:  
    1
    required
  • forceInstant
    Type: boolean
  • idempotencyKey
    Type: string
    min length:  
    1
    max length:  
    255
  • metadata
    Type: object
    Properties: 1
  • mode
    Type: "NETTED" or "INSTANT"enum
  • name
    Type: string
    min length:  
    1
    max length:  
    120
  • senderUserId
    Type: stringFormat: uuid
  • subaccountId
    Type: stringFormat: uuid

    Create this under one of your subaccounts instead of the authenticated account. Must be a direct child of the authenticated account.

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/api/v1/rulesets
curl https://api.bettermoney.com/api/v1/rulesets \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "",
  "senderUserId": "",
  "deliveredAsset": "",
  "deliveredChain": "",
  "toAddress": "",
  "mode": "NETTED",
  "forceInstant": true,
  "metadata": {
    "additionalProperty": "anything"
  },
  "idempotencyKey": "",
  "subaccountId": ""
}'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "senderUserId": null,
  "name": null,
  "status": "ACTIVE",
  "deliveredAsset": "string",
  "deliveredChain": "string",
  "toAddress": "string",
  "mode": "NETTED",
  "forceInstant": false,
  "metadata": {
    "additionalProperty": "anything"
  },
  "addresses": [
    {
      "chain": "string",
      "failureReason": "string",
      "status": "PENDING",
      "address": null
    }
  ],
  "createdAt": "2026-10-05T14:25:44.290Z"
}

Default Response