Cancel one scheduled payment (ALPHA)

curl --request POST \
  --url https://api.platform.dakota.xyz/scheduled-payments/{scheduled_payment_id}/cancel \
  --header 'x-api-key: <api-key>'

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.platform.dakota.xyz/scheduled-payments/{scheduled_payment_id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.platform.dakota.xyz/scheduled-payments/{scheduled_payment_id}/cancel"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)

package main

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

func main() {

	url := "https://api.platform.dakota.xyz/scheduled-payments/{scheduled_payment_id}/cancel"

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

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

{
  "id": "2vWxScheduled000000000000000",
  "wallet_id": "2vWxWallet000000000000000000",
  "amount": "10000",
  "asset": "USDC",
  "address": "0xa11ce00000000000000000000000000000000001",
  "network_id": "base-sepolia",
  "status": "cancelled",
  "scheduled_at": 1781481600
}

{
  "type": "https://docs.dakota.xyz/api-reference/errors#invalid-request",
  "title": "Invalid Request",
  "status": 400,
  "detail": "scheduled payment is executed, not cancellable"
}

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

Agentic Payments

Cancel one scheduled payment (ALPHA)

Alpha — early access.

Finalizes a single still-scheduled payment as cancelled. No signature is required - schedule rows are bookkeeping, not authorization (they are created by a plain API-key call); the signed grant is the MANDATE, which this does not touch. New payments can be instructed under the same mandate at any time. Executed, failed, and already-cancelled rows are not cancellable; a cancel racing the cron at the exact fire moment loses cleanly (the status guard never overwrites an executed payment).

POST

scheduled-payments

{scheduled_payment_id}

cancel

Cancel one scheduled payment (ALPHA)

curl --request POST \
  --url https://api.platform.dakota.xyz/scheduled-payments/{scheduled_payment_id}/cancel \
  --header 'x-api-key: <api-key>'

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.platform.dakota.xyz/scheduled-payments/{scheduled_payment_id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.platform.dakota.xyz/scheduled-payments/{scheduled_payment_id}/cancel"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)

package main

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

func main() {

	url := "https://api.platform.dakota.xyz/scheduled-payments/{scheduled_payment_id}/cancel"

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

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

{
  "id": "2vWxScheduled000000000000000",
  "wallet_id": "2vWxWallet000000000000000000",
  "amount": "10000",
  "asset": "USDC",
  "address": "0xa11ce00000000000000000000000000000000001",
  "network_id": "base-sepolia",
  "status": "cancelled",
  "scheduled_at": 1781481600
}

{
  "type": "https://docs.dakota.xyz/api-reference/errors#invalid-request",
  "title": "Invalid Request",
  "status": 400,
  "detail": "scheduled payment is executed, not cancellable"
}

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

Authorizations

x-api-key

string

header

required

Path Parameters

scheduled_payment_id

string

required

Response

The cancelled scheduled payment.

string

signer_id

string

The signer (hosted agent) this payment fires under. Updatable via PATCH while scheduled.

wallet_id

string

The funding wallet this payment spends from (the customer's choice at acceptance; updatable via PATCH while scheduled).

mandate_id

string

AUDIT — the mandate that covered this payment at fire time. Absent until the payment executes (coverage is decided at fire time, not bound at rest).

wallet_transaction_id

string

AUDIT — the money-path transaction created when this payment fired. Absent until the payment executes.

amount

string

asset

string

failure_reason

string

Why the payment failed (e.g. the mandate gate's denied dimensions); absent unless status is failed.

recipient_id

string

The recipient this payment pays, when it was created from a destination. Absent for a direct-address payment (which carries no recipient).

destination_id

string

The REAL destination this payment settles to — a bank (for an offramp) or a crypto destination. For an auto-account (convert-and-forward) payment, address is the crypto DEPOSIT actually paid while this names the bank/crypto target, so a client can show which account the scheduled payment is for. Absent for a direct-address payment.

destination_type

enum<string>

The kind of the REAL destination (see destination_id). bank marks an offramp (the payment converts crypto to fiat and forwards via a bank rail); crypto a direct or cross-family crypto payout. Absent for a direct-address payment with no destination.

Available options:

bank,

crypto

destination_label

string

A human label for the real destination — e.g. "Chase ••••5432" for a bank, or a shortened address for crypto — so a client can show which account the payment settles to without a second lookup. Absent when unresolved.

destination_rail

string

For a bank destination, the payout rail (e.g. ach, fedwire, swift). Absent for crypto.

output_asset

string

The asset the recipient ULTIMATELY receives. For an offramp this is the fiat currency (e.g. USD) the deposit converts to; for a direct crypto payment it equals asset. Stablecoin conversion is 1:1, so the output AMOUNT equals amount.

output_network

string

For a crypto destination, the network the recipient ULTIMATELY receives on — for a cross-family swap this differs from network_id (the DEPOSIT network the wallet pays), e.g. output_network solana-devnet while network_id is base-sepolia. Equals network_id for a direct crypto payment; absent for a bank offramp (fiat has no network).

address

string

network_id

string

status

enum<string>

Available options:

scheduled,

cancelled,

executed,

failed

executed_at

integer<int64>

scheduled_at

integer<int64>

Draft payment proposals from a conversation (ALPHA)List the calling client's mandates (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

Cancel one scheduled payment (ALPHA)

Authorizations

Path Parameters

Response