update_partner_payout_details
Write how the token's creator is paid as a partner — the rail, what it pays to and the tax declaration. The destination is stored encrypted and never returned.
Choose the rail and give it what it pays to, the way the dashboard's payout dialog does. credit
takes nothing and is accepted while the Subscriby Credit rail is open; paypal and crypto take
their one details (the PayPal email, the USDT TRC20 wallet address); wise and remitly take the
bank account (bank_holder, bank_name, bank_country, bank_account_number, and bank_swift,
bank_branch_code, bank_address when the transfer needs them). Every cash rail needs the tax
declaration: legal_name and tax_country, with us_person when it applies.
The arguments are typed in the tool (the rail as a word, each text bounded, the account number and
the codes in their alphabets, the declaration required on a cash rail); whether the terms were
accepted, whether the credit rail is open and whether the account is complete are the service's
rules, answered as VALIDATION_FAILED with the dashboard's own sentence.
Synchronous. Answers the partner object as
get_partner_program describes it. Emits no
event.
The terms come first
A rail cannot be saved until the partner has accepted the Partner Program
Terms. Pass accept_terms: true with the save, or call
accept_partner_terms
first; otherwise the call is refused and nothing is written.
Only the chosen rail's destination is kept
A rail the partner leaves behind keeps nothing on file, and no tool ever
returns what was written: the partner object says only payout_method and
payout_details_complete.
Requires ability
The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.
Runs the same action as
The REST endpoint and this tool share one action, so validation, permissions and events are identical.
Annotations
A client that honours annotations asks a person before running it. Sending the same arguments twice changes nothing the second time.
Arguments
method*stringThe rail: "credit", "paypal", "wise", "remitly" or "crypto".
detailsstringoptionalThe PayPal email for "paypal" or the USDT TRC20 wallet address for "crypto"; at most 190 characters. Ignored on the other rails.
bank_holderstringoptionalThe name on the bank account, for "wise" and "remitly"; at most 120 characters.
bank_namestringoptionalThe bank, for "wise" and "remitly"; at most 120 characters.
bank_countrystringoptionalWhere the bank is, as a two-letter ISO country code, for "wise" and "remitly".
bank_account_numberstringoptionalThe account number or IBAN, for "wise" and "remitly": letters, digits, spaces and dashes, at most 40 characters.
bank_swiftstringoptionalOptional SWIFT or BIC code, 8 or 11 characters.
bank_branch_codestringoptionalOptional branch, routing, sort or IFSC code: letters, digits, spaces and dashes, at most 20 characters.
bank_addressstringoptionalOptional account holder's address, at most 200 characters.
legal_namestringoptionalThe name a payment is made out to; required on every cash rail, at most 120 characters.
tax_countrystringoptionalThe country of tax residence, as a two-letter ISO country code; required on every cash rail.
us_personbooleanoptionalWhether the creator is a US person for tax purposes.
accept_termsbooleanoptionalTrue to accept the Partner Program Terms with this save.
What it returns
{ "data": { "id": "4b7e2d19-5c3a-4f80-9e6b-1d2c3b4a5f60", "status": "active", "payout_method": "wise", "payout_details_complete": true, "legal_name": "Ada Lovelace", "tax_country": "GB", "us_person": false, "terms_accepted_at": "2026-10-02T09:14:02+00:00", "terms_version": "2026-10-10" }}The partner object, with payout_method, payout_details_complete, legal_name, tax_country,
us_person and, when the terms were accepted with the save, terms_accepted_at and terms_version
updated. See get_partner_program for the whole
shape.
How it fails
VALIDATION_FAILEDa field is invalid, the detail or the account is missing for the rail, the
RESOURCE_NOT_FOUNDthe creator never applied to the programme.
AUTHENTICATION_REQUIREDno authenticated user on the request.
TOKEN_MISSING_ABILITYtoken lacks account:write.
How is this guide?
Last updated on
list_partner_rewards
List the token's creator's Partner Program commission ledger — one row per paid invoice of a referred creator, plus the clawbacks, each with its state from held to settled or reversed. Read-only.
Payment Tools
A project sells through one or more payment providers, each connected in test or live mode.