Future Pay
CMS Developer DocumentationPartner API

Generated reference

MCP Tools

Every tool is read-only. Visibility depends on the explicit product scopes assigned to the connecting API key.

search_transactions

Requires reports scope and an integration user.

Search this corporate's existing payout transactions. Use it for payment status, failures, reconciliation, or finding a transaction id. Do not use it to create or approve payments; this server is read-only. Amounts are decimal strings with explicit currency. Dates accept YYYY-MM-DD, or a relative window; omitted dates default to the last 30 days and the maximum span is 6 months. If hasMore is true, pass nextCursor to continue. Example: {"relativeWindow":"last_7_days","state":"failed"}

transactionIdstringoptional
Exact transaction identifier.
dateRangeobjectoptional
Inclusive date range with YYYY-MM-DD bounds.
relativeWindowone of: last_7_days, last_30_days, this_month, last_quarteroptional
Relative date window; cannot be combined with dateRange.
statestringoptional
Transaction state to match.
searchstringoptional
Free-text transaction search.
packageCodestringoptional
Payment package code to match.
paymentMethodstringoptional
Payment method to match.
debitAccountIdstringoptional
Debit account identifier to match.
sourcestringoptional
Transaction source to match.
amountvalueoptional
Amount filter in major currency units.
limitnumberoptional
Maximum results to return; capped at 100.
cursorstringoptional
Opaque cursor returned by the previous page.

get_payment

Requires payments scope.

Get one payout transaction and its payment lines by transaction id. Use this after search_transactions for line-level detail; do not call it in a loop. Full bank account numbers and IFSC codes are never returned. Amounts are decimal strings with explicit currency. A queued result is normal for a newly accepted transaction; wait briefly and call again.

transactionIdstringrequired
Transaction identifier returned by another payment tool.

get_job

Requires payments scope.

Get a bulk payment job's processing status and record counts. Poll only while it remains in progress, with a pause between calls. This server is rate limited. Amounts are decimal strings with explicit currency.

jobIdstringrequired
Bulk payment job identifier returned by the payment API.

list_packages

Requires payments scope and an integration user.

List payment packages this corporate can use. Call it when you need valid packageCode values, not before every search because configuration changes rarely. If hasMore is true, pass nextCursor to continue.

limitnumberoptional
Maximum results to return; capped at 100.
cursorstringoptional
Opaque cursor returned by the previous page.

search_beneficiaries

Requires beneficiary scope.

Search active beneficiaries this corporate is set up to pay. Use it to check whether a payee exists. This server cannot create beneficiaries; add missing payees in the corporate portal. Only the last four account digits are returned. If hasMore is true, pass nextCursor to continue.

searchstringoptional
Beneficiary name or code to search for.
limitnumberoptional
Maximum results to return; capped at 100.
cursorstringoptional
Opaque cursor returned by the previous page.