`paymentMethods.save`

Create or update an organization payment method with kind, label, currency, validated banking details, active flag, and whether it is a default for its currency. Updates need expectedRevision. Administrator only.

POST/api/v1/accounting/paymentMethods.save

Permissions

accounting:readaccounting:writeaccounting:admin

Who can call it

admin

Retries

Idempotency key required, with expectedRevision

MCP

accounting_payment_methods_save

Fields

idstring (ID)
The record's ID.
expectedRevisioninteger
The record's current revision, from the last time you read it. If someone changed the record since, the request is refused with a conflict so you can reload and check before trying again.
at most 9007199254740991 · greater than 0
kindenumRequired
Which kind of record or job this is.
bank_transfer_cadbank_transfer_usdwireinteracpay_linkother
labelstringRequired
1–120 characters
currencystring or null
Three-letter currency code, such as CAD or USD.
detailsmapRequired
activeboolean
Whether the record is turned on.
defaultForCurrencyboolean
sortOrderinteger
0 to 1000
idempotencyKeystringRequired
Any unique text you generate once per intended change, so a retried request only happens once. Send it as the Idempotency-Key header instead if you prefer; if you send both they must match.
8–200 characters

curl https://app.getoatmilk.com/api/v1/accounting/paymentMethods.save \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "kind": "bank_transfer_cad",
  "label": "example",
  "details": {}
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/paymentMethods.save", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "kind": "bank_transfer_cad",
    "label": "example",
    "details": {}
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os
import uuid

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/accounting/paymentMethods.save",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "kind": "bank_transfer_cad",
        "label": "example",
        "details": {},
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Response

{
  "data": { … }
}

Try it

Checks your input with this action’s real schema and answers like the API, with synthetic data. No key needed, and nothing changes.

Input

POST/api/v1/accounting/paymentMethods.save

curl https://app.getoatmilk.com/api/v1/accounting/paymentMethods.save \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "kind": "bank_transfer_cad",
  "label": "example",
  "details": {}
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/paymentMethods.save", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "kind": "bank_transfer_cad",
    "label": "example",
    "details": {}
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os
import uuid

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/accounting/paymentMethods.save",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "kind": "bank_transfer_cad",
        "label": "example",
        "details": {},
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Example

Try it