Skip to content
Last updated

MCP Tool Reference (Partner)

Tools available to partner accounts. Every tool here mirrors the equivalent Partner REST API endpoint (partner-v1) and is named with a partner_ prefix. For merchant accounts see the Tool Reference (Merchant).

Access indicates the minimum permission required:

  • Read — any read-capable partner role (marketplace_partner:read or single_merchant_partner:read scope for M2M keys)
  • Write — a write-capable partner role (marketplace_partner:write or single_merchant_partner:write scope for M2M keys)

Both partner types — marketplace and single-merchant — get the same tools. What differs is data ownership: under marketplace, buyers belong to the partner and share one credit line across sub-merchants; under single-merchant, each sub-merchant owns its own buyers and credit lines. This changes how merchant_id behaves on some tools, noted below. See the Partner API Integration guide.

list_resolve_accounts returns a partner_type of marketplace or single_merchant on the account — call it first to know which rules apply.

General

These tools are shared with merchant accounts and are not partner_-prefixed.

ToolAccessDescription
list_resolve_accountsReadList the Resolve accounts available to the authenticated login. Call this first when a login has access to multiple accounts.
searchReadSemantic search over Resolve's published help articles — ask "how does X work in Resolve".
create_temp_fileWriteMint a presigned S3 upload URL for a file (e.g. an invoice PDF) so it can be attached to an invoice without passing the file through the LLM. Not available in ChatGPT or Codex — see note below.
list_temp_filesReadList previously uploaded temp files and mint fresh download URLs. Not available in ChatGPT or Codex — see note below.

File handling in ChatGPT and Codex: these clients attach files directly to the conversation instead of using the temp-file tools. Tool parameters that expect a file URL (such as merchant_invoice_url on partner_create_invoice) accept the conversation attachment directly, and the MCP server resolves it for the Resolve API. The temp-file tools are hidden for these connections.

Sub-merchants

The merchants beneath your partner account. These endpoints have no merchant-API equivalent.

ToolAccessDescription
partner_list_merchantsReadList the sub-merchants under the partner account.
partner_get_merchantReadFetch a single sub-merchant by ID.
partner_create_merchantWriteCreate a new sub-merchant under the partner account.
partner_update_merchantWriteUpdate a sub-merchant's details.

Customers

ToolAccessDescription
partner_list_customersReadList customers across your sub-merchants, with exact-match filters on business_name, email, and more.
partner_get_customerReadFetch a single customer, including credit status and available credit.
partner_create_customerWriteCreate a new customer (buyer). Single-merchant partners must pass merchant_id for the owning sub-merchant; marketplace partners must omit it — the customer belongs to the partner.
partner_update_customerWriteUpdate a customer's details.
partner_create_customer_documentWriteAttach a supporting document to an existing customer using a presigned upload or remote download. Requires partner write access.
partner_request_credit_checkWriteSubmit a customer for credit underwriting.
partner_enroll_customerWriteEnroll an approved customer in net terms.

Customer supporting documents

Find or create the customer first, then call partner_create_customer_document with its ID as merchant_customer_id. This is separate from customer creation and is available to partner accounts; regular merchant v5 tools do not expose it.

Supply document_type, filename (including extension), and filetype (matching MIME type). Supported types are bank_statements, credit_references, financial_statements, payment_history, and other. Bank statements require PDF; other types accept PDF, PNG, JPEG, CSV, XLS, or XLSX.

  • ChatGPT: pass the conversation attachment as download_url, with filename and filetype supplied separately. The MCP adapter resolves the attachment URL and Resolve queues a remote download.
  • Claude / other clients: omit download_url to receive a presigned upload_url. PUT the bytes to that URL before upload_expires_at, including all returned upload_headers. Alternatively, pass an already hosted public HTTP(S) URL as download_url.

additional_data_request_id is optional only for bank_statements and must refer to an open banking-data request for the same customer.

Keep the returned document_id. Transfer and validation are asynchronous; a successful response does not confirm validation. In remote-download mode, check queue_dispatch_status: queued means dispatched, while failed signals a dispatch failure even with HTTP 200. The response has no status field, and customer credit status alone does not prove that this document validated.

See the Partners API document endpoint for the full request and response contract.

Invoices

ToolAccessDescription
partner_list_invoicesReadList invoices across your sub-merchants, with filters on number, PO number, customer, balance, and status.
partner_get_invoiceReadFetch a single invoice.
partner_create_invoiceWriteCreate an invoice for a customer. merchant_id is required — the sub-merchant the invoice belongs to.
partner_update_invoiceWriteUpdate an invoice (e.g. set terms and advance_requested before sending).
partner_send_invoiceWriteSend the invoice to the customer.
partner_capture_invoiceWriteCapture an authorized invoice.
partner_void_invoiceWriteVoid a sent invoice.
partner_cancel_invoiceWriteCancel an invoice.
partner_delete_invoiceWriteDelete a draft (unsent) invoice.
partner_delete_invoicesWriteDelete several draft invoices in one call.

Orders

Partner API keys hold no order write permissions, so only reads are available.

ToolAccessDescription
partner_list_ordersReadList orders.
partner_get_orderReadFetch a single order.

Charges

Partner API keys hold no charge write permissions, so only reads are available.

ToolAccessDescription
partner_list_chargesReadList charges.
partner_get_chargeReadFetch a single charge.

Shipments

ToolAccessDescription
partner_list_shipmentsReadList shipments.
partner_get_shipmentReadFetch a single shipment.
partner_create_shipmentWriteAdd a shipment (tracking number, courier, fulfillment method) to an invoice.
partner_update_shipmentWriteUpdate a shipment.
partner_delete_shipmentWriteDelete a shipment.
partner_sync_shipment_trackingWritePull real-time tracking status from the courier.
partner_get_shipment_signed_upload_urlWriteMint a signed URL for uploading proof-of-delivery files, required for non-shipping-provider fulfillment methods.

Payments & Payouts

ToolAccessDescription
partner_list_paymentsReadList payments received from customers.
partner_get_paymentReadFetch a single payment, including which invoices it applied to.
partner_create_paymentWriteRecord a payment against an invoice.
partner_list_payoutsReadList payouts from Resolve.
partner_get_payoutReadFetch a single payout.
partner_list_payout_transactionsReadList individual transactions within payouts.
partner_get_payout_transactionReadFetch a single payout transaction.

Credit Notes

ToolAccessDescription
partner_list_credit_notesReadList credit notes.
partner_get_credit_noteReadFetch a single credit note.
partner_create_credit_noteWriteIssue a credit note against a sent invoice.
partner_void_credit_noteWriteVoid a credit note.

Webhooks

ToolAccessDescription
partner_list_webhooksReadList webhook endpoints and their subscribed events.
partner_upsert_webhookWriteCreate or update a webhook endpoint and its subscribed events.
partner_delete_webhookWriteDelete a webhook endpoint.