get_transfer
Get Transfer
Retrieve a Natural transfer by ID.
get_transfer
Retrieve a Natural transfer by ID.
revoke_agent_customer
DEPRECATED — use `revoke_customer_agent` instead. Revoke a Natural agent's access to act for one customer using the legacy agent-side endpoint. Provide an idempotency key and reuse it when retrying. Returns the revoked relationship status, customer and agent references, raw customer record, and deletion metadata.
update_party
Update the authenticated Natural party's display name, or clear it with null. Returns the updated identity, status, contact details, address, lifecycle timestamps, relationships, and raw metadata.
rotate_agent_key
Rotate a Natural agent key and return the one-time replacement secret only in output.agentKey, together with its complete lifecycle and ownership metadata. Requires confirmation and an idempotency key; reuse the same key when retrying the same rotation.
revoke_api_key
Revoke a Natural API key by ID so it can no longer authenticate. Requires confirmation and an idempotency key; reuse the same key when retrying the same revocation.
revoke_party_invitation
Revoke a pending Natural party invitation by ID. This destructive operation requires confirmation and an idempotency key; reuse the same key when retrying the same revocation.
list_wallets
List wallets for the authenticated Natural party, or for an authorized delegated party when partyId is provided. Returns stable wallet, balance, ownership, lifecycle, and deposit fields plus each raw wallet resource.
approve_approval
Approve a Natural payment or transfer under review. This can release money movement, is not documented as idempotent, and requires confirmation.
delete_webhook
Delete a Natural webhook by ID. Requires explicit confirmation and an idempotency key, and returns the deleted webhook ID, status, non-secret raw resource, and response metadata.
list_webhooks
List Natural webhooks with optional status filtering.
get_approval
Retrieve a Natural approval by ID, including its status, target, reasons, and resolution timestamps.
get_api_key
Retrieve non-secret metadata for a Natural API key by its apy_* ID, including its name, status, scopes, prefix, environment, and lifecycle timestamps. The key secret is never returned.
list_customers
List Natural customers. Natural defaults this endpoint to 20 records.
list_external_accounts
List linked Natural external bank accounts visible to the authenticated party. Returns stable lifecycle, connection-health, bank, account-mask, ownership, and raw resource fields with cursor pagination.
get_webhook
Retrieve a Natural webhook by ID, including its delivery URL, status, subscribed events, tags, timestamps, and owning party. Signing secrets are never returned.
create_agent_key
Create a Natural agent key bound to an existing agent and return its lifecycle and ownership metadata plus the one-time secret only in output.agentKey. Requires confirmation.
list_agent_keys
List Natural agent keys. Secrets are not returned by this list endpoint.
create_party_invitations
Create 1-100 Natural party invitations for email recipients with ADMIN, MEMBER, or VIEWER access. Returns actionable invitation IDs, lifecycle fields, raw resources, and per-recipient failures. This endpoint is not documented as idempotent.
delete_agent
Delete a Natural agent by ID and revoke the agent's active customer authorizations and pending invitations. Provide an idempotency key and reuse it when retrying the same deletion.
list_party_invitations
List Natural invitations to join the authenticated party, with optional party, recipient email, status, and cursor pagination filters. Returns actionable invitation IDs, roles, lifecycle timestamps, pagination metadata, and raw invitation resources.
cancel_payment_request
Cancel an open Natural payment request your party created and return its complete canceled resource plus response metadata. This mutates live state; set confirm to true, verify the current status before retrying, and reuse the same idempotency key for every retry.
create_payment
Create a Natural payment. This moves money or starts money movement; set confirm to true and reuse the same idempotency key on retries.
get_party
Retrieve the authenticated caller's Natural party identity, including names, status, contact details, address, lifecycle timestamps, relationships, and raw metadata.
list_events
List Natural party events with optional event-type and created-time filters, returning stable event and resource IDs, payload snapshots, ownership metadata, raw provider records, and cursor pagination.
revoke_customer_invitation
Cancel a pending Natural customer delegation invitation by its adi_* ID. Returns the canceled invitation, its ID and status, and deletion metadata. This endpoint is not documented as idempotent.
get_customer
Retrieve a Natural customer who has authorized one of your agents by party ID, including delegation and connected-agent details.
create_agent
Create a Natural agent for the authenticated party. Provide an idempotency key and reuse it when retrying.
revoke_customer_agent
Remove one Natural agent's access to a customer by pty_* customer ID and agt_* agent ID. This destructive action requires confirmation, sends a bodyless DELETE, and has no documented idempotency key. Returns the customer and agent IDs, current customer delegation status, raw customer resource, and deletion metadata.
list_counterparties
List aggregated counterparties through Natural provider-deprecated legacy directional endpoints. Choose sent for recipients of payments from your agents or received for senders to your agents. Returns aggregate payment activity, identity fields, raw resources, and raw response metadata with cursor pagination.
create_webhook
Create a Natural webhook, return its delivery and ownership metadata, and expose the one-time signing secret only in output.signingSecret.
invite_agent_customer
DEPRECATED — use `create_customer_invitations` instead. Invite 1-100 customers to authorize a Natural agent with specific permissions and an optional per-transaction limit. Provide an idempotency key and reuse it when retrying the same invitation batch.
list_api_keys
List Natural party API keys. Secrets are not returned by this list endpoint.
remove_party_member
Remove a member from the authenticated Natural party by user ID. This destructive operation requires confirmation and an idempotency key; reuse the same key when retrying the same removal.
decline_payment_request
Decline an open Natural payment request and return its lifecycle, payer, requester, and relationship metadata. This mutates live state; set confirm to true and reuse the same idempotency key on retries.
remove_external_account
Remove (unlink) a linked Natural external account so the current link can no longer be used as a funding source. Requires explicit confirmation, is not documented as idempotent, and returns the removed account resource, lifecycle status, and deletion metadata.
fulfill_payment_request
Fulfill an open Natural payment request from a wallet or external account and return payment lifecycle, money, and relationship metadata. This moves money; set confirm to true and reuse the same idempotency key on retries.
list_agent_invitations
List Natural agent delegation invitations through the provider-deprecated legacy endpoint. Filter by lifecycle status, customer email, or agent ID. Returns raw invitation resources, pagination, and raw provider metadata.
revoke_agent_invitation
DEPRECATED — use `revoke_customer_invitation` instead. Cancel a pending Natural agent delegation invitation through the legacy agent-side endpoint. Returns the canceled invitation, its ID and status, and deletion metadata. Provide an idempotency key and reuse it when retrying the same revocation.
update_webhook
Update a Natural webhook by ID, returning its delivery URL, status, subscribed events, tags, timestamps, and owning party. Signing secrets are never returned.
get_transaction
Retrieve one payment or transfer transaction visible to the authenticated Natural party, or to a delegated party when partyId is provided. Returns stable monetary, lifecycle, and relationship fields plus the raw transaction resource.
update_agent
Update a Natural agent's name, description, handle slug, or owner spending limits. Provide an idempotency key and reuse it when retrying the same update. Omitted top-level fields remain unchanged.
list_payments
List Natural payments with optional party filtering and cursor pagination.
get_payment_request
Retrieve a Natural payment request your party created or was asked to pay, including lifecycle, payer, requester, wallet, payment, and transaction metadata.
list_agent_customers
DEPRECATED — use `list_customers` instead. List customers delegated to a Natural agent.
get_wallet
Retrieve one Natural wallet by ID. Returns stable lifecycle, balance, claims, deposit, ownership, and raw wallet fields.
list_customer_invitations
List pending Natural customer delegation invitations grouped by recipient, including the actionable per-agent invitation IDs. Natural defaults the page size to 20.
rotate_webhook_secret
Rotate a Natural webhook signing secret and return the one-time new secret only in output.signingSecret, together with the previous-secret expiry and owning-party metadata. Requires confirmation.
list_party_members
List active members of the authenticated Natural party with cursor pagination. Returns Natural user IDs, names, email addresses, roles, statuses, lifecycle timestamps, raw member resources, and response metadata.
list_transactions
List payment and transfer transactions visible to the authenticated Natural party; these are not payment request records. Supports type, counterparty, wallet, delegated-customer, delegated-only filters, and cursor pagination.
list_incoming_payment_requests
List open Natural payment requests that the effective party has been asked to pay.
list_transfers
List Natural transfers for the authenticated party, or an authorized delegated party, with cursor pagination. Returns transfer direction, money, lifecycle state, relationship IDs, timestamps, failure or return details, and the raw transfer resource.
deposit_funds
Initiate a Natural deposit from a linked external account into a wallet. This moves money; set confirm to true and reuse the same idempotency key when retrying the same deposit.
list_approvals
List Natural approvals for payment, deposit, or withdrawal decisions.
revoke_agent_key
Revoke a Natural agent key by its agk_* ID so it can no longer authenticate. Other active keys for the same agent keep working. Requires confirmation and an idempotency key; reuse the same key when retrying the same revocation.
deny_approval
Deny a Natural payment or transfer under review. This blocks money movement, is not documented as idempotent, and requires confirmation.
list_agents
List Natural agents with optional status filtering and cursor pagination.
get_event
Retrieve a Natural event by ID, including the triggering resource, point-in-time payload snapshot, timestamp, owning party, relationships, and raw provider metadata.
cancel_payment
Cancel a Natural payment before the recipient begins claiming it. This destructive state transition requires confirm=true and an idempotency key; reuse the same key when retrying the same cancellation.
get_agent
Retrieve a Natural agent by ID, including its name, handle, status, owner limits, timestamps, owning party, and raw provider record.
list_payment_requests
List Natural payment requests created by the effective party.
create_payment_request
Create a Natural payment request for an email, phone, party, agent, or handle payer and return its payment link plus lifecycle metadata. This creates an externally actionable request; set confirm to true and reuse the same idempotency key on retries.
withdraw_funds
Initiate a Natural withdrawal from a wallet to a linked external account. This moves money; set confirm to true and reuse the same idempotency key when retrying the same withdrawal.
create_customer_invitations
Create Natural customer delegation invitations for 1-100 email, phone, or party recipients and 1-50 agents. Returns one actionable invitation ID per recipient-agent pair plus failed-recipient metadata. This endpoint is not documented as idempotent.
who_am_i
Get the Natural party, effective acting party, acting agent, credential resolution details, and permissions associated with the authenticated connection.
create_api_key
Create a Natural party API key and return the one-time key secret in output.apiKey. Requires confirmation.
get_payment
Retrieve a Natural payment by ID.
Manage Natural agentic payments workflows through the REST API. List and manage agents, customer delegations, wallets, counterparties, payments, transfers, payment requests, approvals, party members, API keys, agent keys, webhooks, and events with explicit confirmation gates for high-risk money movement and destructive actions.
Common questions about connecting Natural to AI agents with Metorial.