Create a mandate directly (ALPHA)

curl --request POST \
  --url https://api.platform.dakota.xyz/mandates \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "payment_agent_id": "2vWxAgent0000000000000000000",
  "rule": {
    "target_type": "recipient",
    "targets": [
      "Alice"
    ],
    "network_id": "base-sepolia",
    "asset": "USDC",
    "max_per_tx": "100",
    "window": "MONTHLY",
    "max_count_per_target_in_window": 1
  },
  "valid_until": 1798761599
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    payment_agent_id: '2vWxAgent0000000000000000000',
    rule: {
      target_type: 'recipient',
      targets: ['Alice'],
      network_id: 'base-sepolia',
      asset: 'USDC',
      max_per_tx: '100',
      window: 'MONTHLY',
      max_count_per_target_in_window: 1
    },
    valid_until: 1798761599
  })
};

fetch('https://api.platform.dakota.xyz/mandates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.platform.dakota.xyz/mandates"

payload = {
    "payment_agent_id": "2vWxAgent0000000000000000000",
    "rule": {
        "target_type": "recipient",
        "targets": ["Alice"],
        "network_id": "base-sepolia",
        "asset": "USDC",
        "max_per_tx": "100",
        "window": "MONTHLY",
        "max_count_per_target_in_window": 1
    },
    "valid_until": 1798761599
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.platform.dakota.xyz/mandates"

	payload := strings.NewReader("{\n  \"payment_agent_id\": \"2vWxAgent0000000000000000000\",\n  \"rule\": {\n    \"target_type\": \"recipient\",\n    \"targets\": [\n      \"Alice\"\n    ],\n    \"network_id\": \"base-sepolia\",\n    \"asset\": \"USDC\",\n    \"max_per_tx\": \"100\",\n    \"window\": \"MONTHLY\",\n    \"max_count_per_target_in_window\": 1\n  },\n  \"valid_until\": 1798761599\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "2vWxMandate00000000000000000",
  "status": "pending",
  "bound_signer_id": "2vWxSigner000000000000000000",
  "rule": {
    "target_type": "recipient",
    "targets": [
      "2vWxRecipient000000000000000"
    ],
    "network_id": "base-sepolia",
    "asset": "USDC",
    "max_per_tx": "100",
    "window": "MONTHLY",
    "max_count_per_target_in_window": 1
  },
  "valid_until": 1798761599
}

{
  "type": "https://docs.dakota.xyz/api-reference/errors#invalid-request",
  "title": "Invalid Request",
  "status": 400,
  "detail": "target \"Bob\": recipient not found for this customer"
}

{
  "type": "https://docs.dakota.xyz/api-reference/errors#not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "agent not found"
}

Mandates

Create a mandate directly (ALPHA)

Alpha — early access.

Drafts a PENDING mandate from a direct user interaction - no instruction back-link. The mandate binds the agent’s signer; the rule is the one the customer will approve (POST /mandates//approve, a recognized signer other than the bound one, §8). Recipient targets may be recipient ids or payee names - names resolve to the customer’s existing recipients before anything is stored. Schedule payments under it by mandate_id; they arm the moment it activates.

POST

mandates

curl --request POST \
  --url https://api.platform.dakota.xyz/mandates \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "payment_agent_id": "2vWxAgent0000000000000000000",
  "rule": {
    "target_type": "recipient",
    "targets": [
      "Alice"
    ],
    "network_id": "base-sepolia",
    "asset": "USDC",
    "max_per_tx": "100",
    "window": "MONTHLY",
    "max_count_per_target_in_window": 1
  },
  "valid_until": 1798761599
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    payment_agent_id: '2vWxAgent0000000000000000000',
    rule: {
      target_type: 'recipient',
      targets: ['Alice'],
      network_id: 'base-sepolia',
      asset: 'USDC',
      max_per_tx: '100',
      window: 'MONTHLY',
      max_count_per_target_in_window: 1
    },
    valid_until: 1798761599
  })
};

fetch('https://api.platform.dakota.xyz/mandates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.platform.dakota.xyz/mandates"

payload = {
    "payment_agent_id": "2vWxAgent0000000000000000000",
    "rule": {
        "target_type": "recipient",
        "targets": ["Alice"],
        "network_id": "base-sepolia",
        "asset": "USDC",
        "max_per_tx": "100",
        "window": "MONTHLY",
        "max_count_per_target_in_window": 1
    },
    "valid_until": 1798761599
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.platform.dakota.xyz/mandates"

	payload := strings.NewReader("{\n  \"payment_agent_id\": \"2vWxAgent0000000000000000000\",\n  \"rule\": {\n    \"target_type\": \"recipient\",\n    \"targets\": [\n      \"Alice\"\n    ],\n    \"network_id\": \"base-sepolia\",\n    \"asset\": \"USDC\",\n    \"max_per_tx\": \"100\",\n    \"window\": \"MONTHLY\",\n    \"max_count_per_target_in_window\": 1\n  },\n  \"valid_until\": 1798761599\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "2vWxMandate00000000000000000",
  "status": "pending",
  "bound_signer_id": "2vWxSigner000000000000000000",
  "rule": {
    "target_type": "recipient",
    "targets": [
      "2vWxRecipient000000000000000"
    ],
    "network_id": "base-sepolia",
    "asset": "USDC",
    "max_per_tx": "100",
    "window": "MONTHLY",
    "max_count_per_target_in_window": 1
  },
  "valid_until": 1798761599
}

{
  "type": "https://docs.dakota.xyz/api-reference/errors#invalid-request",
  "title": "Invalid Request",
  "status": 400,
  "detail": "target \"Bob\": recipient not found for this customer"
}

{
  "type": "https://docs.dakota.xyz/api-reference/errors#not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "agent not found"
}

Authorizations

x-api-key

string

header

required

Body

application/json

payment_agent_id

string

required

The mandate binds this agent's signer.

rule

object

required

Show child attributes

valid_from

integer<int64>

valid_until

integer<int64>

Response

The pending mandate, targets resolved to ids.

string

status

enum<string>

expired is DERIVED, never stored - a pending or active mandate whose valid_until has passed. It cannot authorize payments and cannot be approved; it can still be cancelled.

Available options:

pending,

active,

expired,

rejected,

revoked,

done

bound_signer_id

string

target_names

string[]

DERIVED, display-only - the rule's recipient targets resolved to names, parallel to rule.targets (raw id on a miss). Absent for address/any target kinds. The ids in the rule remain the grant.

instruction_id

string

rule

object

Show child attributes

valid_from

integer<int64>

valid_until

integer<int64>

approved_by_signer_id

string

approved_at

integer<int64>

Unix time of the §8 approval; absent until approved.

rejected_by_signer_id

string

The signer that cancelled the mandate while it was still pending (§8); absent otherwise.

revoked_by_signer_id

string

The signer that cancelled the mandate after activation (§8); absent otherwise.

List the calling client's mandates (ALPHA)Get a mandate (ALPHA)

⌘I

API documentation

Customers

Wallets

Transactions

Recipients

Accounts

Auto Transactions

Onboarding

Policies

Signer Groups

Authentication

Users

Webhooks

Events

Info

Sandbox

Self Serve

Agentic Payments

Mandates

Insights

Payouts

Create a mandate directly (ALPHA)

Authorizations

Body

Response