Rutter Supplier Enablement API
Supplier Enablement API for commercial-card programs: enrich merchants and suppliers, score card acceptance, and create and track card activations and activation jobs (10 operations under /supplier_enablement).
Supplier Enablement API for commercial-card programs: enrich merchants and suppliers, score card acceptance, and create and track card activations and activation jobs (10 operations under /supplier_enablement).
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/rutter:rutter-supplier-enablement-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Rutter Supplier Enablement API
version: '2024-08-31'
description: The Universal API for all major e-commerce platforms, accounting systems, and payment processors.
servers:
- url: https://production.rutterapi.com/versioned
description: Production server
- url: https://sandbox.rutterapi.com/versioned
description: Sandbox server
tags:
- name: Supplier Enablement
paths:
/supplier_enablement/card_activations:
post:
summary: Create supplier enablement card activation
operationId: createSupplierEnablementCardActivation
parameters:
- name: access_token
in: query
required: true
description: The access token of the connection.
schema:
$ref: '#/components/schemas/AccessToken/properties/access_token'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSupplierEnablementVendorCardActivationRequest'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SupplierEnablementCardActivationResponse'
x-supported-platforms:
- NETSUITE
- QUICKBOOKS
- SAGE_INTACCT
- XERO
x-sandbox-supported-platforms: []
tags:
- Supplier Enablement
x-summary-source: derived
get:
summary: List supplier enablement card activations
operationId: listSupplierEnablementCardActivations
parameters:
- name: access_token
in: query
required: true
description: The access token of the connection.
schema:
$ref: '#/components/schemas/AccessToken/properties/access_token'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ListSupplierEnablementCardActivationResponse'
x-supported-platforms:
- NETSUITE
- QUICKBOOKS
- SAGE_INTACCT
- XERO
x-sandbox-supported-platforms:
- NETSUITE
- QUICKBOOKS
tags:
- Supplier Enablement
x-summary-source: derived
/supplier_enablement/card_activations/{id}:
get:
summary: Fetch supplier enablement card activation
operationId: fetchSupplierEnablementCardActivation
parameters:
- name: id
in: path
required: true
description: The Rutter generated unique ID of the object.
schema:
$ref: '#/components/schemas/RutterIdPathParams/properties/id'
- name: access_token
in: query
required: true
description: The access token of the connection.
schema:
$ref: '#/components/schemas/AccessToken/properties/access_token'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SupplierEnablementCardActivationResponse'
x-supported-platforms:
- NETSUITE
- QUICKBOOKS
- SAGE_INTACCT
- XERO
x-sandbox-supported-platforms:
- NETSUITE
- QUICKBOOKS
tags:
- Supplier Enablement
x-summary-source: derived
patch:
summary: Update supplier enablement card activation
operationId: updateSupplierEnablementCardActivation
parameters:
- name: id
in: path
required: true
description: The unique ID of the object.
schema:
$ref: '#/components/schemas/IdPathParam/properties/id'
- name: access_token
in: query
required: true
description: The access token of the connection.
schema:
$ref: '#/components/schemas/AccessToken/properties/access_token'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSupplierEnablementCardActivationRequest'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SupplierEnablementCardActivationResponse'
x-supported-platforms:
- '*'
x-sandbox-supported-platforms: []
tags:
- Supplier Enablement
x-summary-source: derived
/supplier_enablement/enrichments:
get:
summary: List supplier enablement enrichments
operationId: listSupplierEnablementEnrichments
parameters:
- name: access_token
in: query
required: true
description: The access token of the connection.
schema:
$ref: '#/components/schemas/AccessToken/properties/access_token'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ListSupplierEnablementEnrichmentsResponse'
x-supported-platforms:
- NETSUITE
- QUICKBOOKS
- SAGE_INTACCT
- XERO
x-sandbox-supported-platforms:
- NETSUITE
- QUICKBOOKS
tags:
- Supplier Enablement
x-summary-source: derived
post:
summary: Create supplier enablement enrichment
operationId: createSupplierEnablementEnrichment
parameters:
- name: access_token
in: query
required: true
description: The access token of the connection.
schema:
$ref: '#/components/schemas/AccessToken/properties/access_token'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSupplierEnablementEnrichmentResponseResponse'
x-supported-platforms:
- NETSUITE
- QUICKBOOKS
- SAGE_INTACCT
- XERO
x-sandbox-supported-platforms: []
tags:
- Supplier Enablement
x-summary-source: derived
/supplier_enablement/merchants/{id}/card_activations:
post:
summary: Create supplier enablement card activation job
operationId: createSupplierEnablementCardActivationJob
parameters:
- name: id
in: path
required: true
description: The unique ID of the object.
schema:
$ref: '#/components/schemas/IdPathParam/properties/id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSupplierEnablementMerchantCardActivationRequest'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SupplierEnablementCardActivationResponse'
x-supported-platforms:
- '*'
x-sandbox-supported-platforms: []
tags:
- Supplier Enablement
x-summary-source: derived
/supplier_enablement/merchants/{id}/enrichments:
get:
summary: Fetch supplier enablement merchant
operationId: fetchSupplierEnablementMerchant
parameters:
- name: id
in: path
required: true
description: The unique ID of the object.
schema:
$ref: '#/components/schemas/IdPathParam/properties/id'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GetSupplierEnablementMerchantEnrichmentResponse'
x-supported-platforms:
- '*'
x-sandbox-supported-platforms:
- NETSUITE
- QUICKBOOKS
tags:
- Supplier Enablement
x-summary-source: derived
/supplier_enablement/merchants/card_activations/{id}:
patch:
summary: Update supplier enablement merchant card activation
operationId: updateSupplierEnablementMerchantCardActivation
parameters:
- name: id
in: path
required: true
description: The unique ID of the object.
schema:
$ref: '#/components/schemas/IdPathParam/properties/id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSupplierEnablementCardActivationRequest'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SupplierEnablementCardActivationResponse'
x-supported-platforms:
- '*'
x-sandbox-supported-platforms: []
tags:
- Supplier Enablement
x-summary-source: derived
components:
schemas:
CreateSupplierEnablementMerchantCardActivation:
type: object
properties:
card:
type: object
properties:
exp_date:
type: string
cvc:
type: string
pan:
type: string
cardholder_name:
type: string
city:
type: string
phone:
type: string
state:
type: string
street:
type: string
zip:
type: string
required:
- exp_date
- cvc
- pan
additionalProperties: false
SupplierEnablementEnrichmentResponseResponse:
type: object
properties:
enrichment:
$ref: '#/components/schemas/SupplierEnablementEnrichmentResponse'
required:
- enrichment
AccessToken:
type: object
properties:
access_token:
type: string
format: uuid
description: The access token of the connection.
required:
- access_token
ListSupplierEnablementCardActivationResponse:
type: object
properties:
card_activations:
type: array
items:
type: object
properties:
id:
type: string
card_activation_type:
type: string
enum:
- billing_portal
- payment_link
- unknown
status:
type: string
enum:
- pending_setup
- pending_card
- pending_auth
- pending_switch
- success
- failure
user_action_needed:
type: boolean
user_action_url:
type:
- string
- 'null'
created_at:
type: string
description: The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the card activation job was created.
required:
- id
- card_activation_type
- status
- user_action_needed
- user_action_url
- created_at
additionalProperties: false
required:
- card_activations
UpdateSupplierEnablementCardActivation:
type: object
properties:
card:
type: object
properties:
exp_date:
type: string
cvc:
type: string
pan:
type: string
cardholder_name:
type: string
city:
type: string
phone:
type: string
state:
type: string
street:
type: string
zip:
type: string
required:
- exp_date
- cvc
- pan
additionalProperties: false
required:
- card
CreateSupplierEnablementEnrichmentResponseResponse:
anyOf:
- $ref: '#/components/schemas/SupplierEnablementEnrichmentResponseResponse'
- $ref: '#/components/schemas/AsyncResponsePayload'
CreateSupplierEnablementVendorCardActivationRequest:
type: object
properties:
card_activation:
$ref: '#/components/schemas/CreateSupplierEnablementVendorCardActivation'
required:
- card_activation
CreateSupplierEnablementMerchantCardActivationRequest:
type: object
properties:
card_activation:
$ref: '#/components/schemas/CreateSupplierEnablementMerchantCardActivation'
required:
- card_activation
SupplierEnablementEnrichmentResponse:
type: object
properties:
id:
type: string
description: The Rutter generated unique ID of the supplier enablement enrichment report.
analysis_end_date:
type:
- string
- 'null'
description: End date of the analysis date range.
analysis_start_date:
type:
- string
- 'null'
description: Start date of the analysis date range.
source:
type: string
enum:
- rutter
- upload
description: Source of the enrichment request.
status:
type: string
enum:
- completed
- failed
- in_progress
description: Status of the enrichment request.
progress:
type: object
properties:
completion_percentage:
type: number
minimum: 0
maximum: 100
description: Completion percentage (0-100).
estimated_time_remaining:
type: number
minimum: 0
description: Estimated time remaining in seconds.
processed_vendors:
type: integer
minimum: 0
description: Number of vendors already processed.
total_vendors:
type: integer
minimum: 0
description: Total number of vendors to process.
required:
- completion_percentage
- estimated_time_remaining
- processed_vendors
- total_vendors
additionalProperties: false
description: Progress tracking information for the enrichment request.
files:
type: array
items:
type: object
properties:
id:
type: string
description: The Rutter generated unique ID of the supplier enablement enrichment file.
uploaded_at:
type: string
description: Timestamp when the file was uploaded.
name:
type: string
description: Name of the enrichment file.
required:
- id
- uploaded_at
- name
additionalProperties: false
description: Supplier enablement source file.
description: Array of source files.
vendors:
type: array
items:
type: object
properties:
id:
type: string
description: The Rutter generated unique ID of the vendor.
latest_bill_issue_date:
type:
- string
- 'null'
description: Timestamp of most recent bill issued.
latest_expense_transaction_date:
type:
- string
- 'null'
description: Timestamp of most recent expense transaction.
eligible_card_spend:
type: number
minimum: 0
description: Amount of spend that is eligible for card payments.
total_spend:
type: number
minimum: 0
description: Total spend with this vendor over the last two years.
vendor_address:
type: string
description: Address of the vendor.
vendor_name:
type: string
description: Name of the vendor.
accepts_card:
type:
- boolean
- 'null'
description: Whether the vendor accepts credit card payments.
billing_portal_link:
type:
- string
- 'null'
description: Billing portal link for this vendor, extracted from OCR or other sources.
card_activation_flow:
type:
- string
- 'null'
enum:
- merchant_auth_link
- generic_job
- payment_link
- 'null'
description: The recommended card activation flow for this vendor. 'merchant_auth_link' requires user to login via browser session, 'generic_job' queues job for manual action, 'payment_link' uses direct payment link.
card_fee:
type:
- number
- 'null'
description: Amount of card payment fees.
current_payment_account:
type:
- string
- 'null'
description: Current payment account used for this vendor.
current_payment_method:
type:
- string
- 'null'
description: Current payment method used for this vendor.
current_payment_source:
type:
- string
- 'null'
description: Current payment source used for this vendor.
has_card_fees:
type:
- boolean
- 'null'
description: Whether the vendor has card payment fees.
manual_activation_instructions:
type:
- string
- 'null'
description: User-facing instructions on how to pay this vendor by card. To be used in the case when automated card switching is unable to complete successfully. Generated when the vendor accepts cards via billing portal or invoice link.
merchant_code:
type:
- string
- 'null'
description: The supported vendor identifier if this vendor matches a known supported vendor (e.g., AWS, VGS).
payment_link:
type:
- string
- 'null'
description: Payment link for this vendor, extracted from OCR or other sources.
total_bills_count:
type: integer
minimum: 0
description: Total number of bills associated with this vendor.
total_expenses_count:
type: integer
minimum: 0
description: Total number of expenses associated with this vendor.
accepts_card_sources:
type:
- array
- 'null'
items:
type: string
description: Sources of information for this card acceptance method.
card_accept_options_sources:
type:
- array
- 'null'
items:
type: string
description: Sources of information for this card acceptance options.
card_fee_sources:
type:
- array
- 'null'
items:
type: string
description: Sources of information for this card payment fees.
historical_payment_methods:
type:
- array
- 'null'
items:
type: string
description: Historical payment methods used with this vendor.
card_accept_options:
type:
- array
- 'null'
items:
type: object
properties:
description:
type: string
description: Description of how to use this card acceptance method.
type:
type: string
enum:
- billing_portal
- invoice_link
- online_checkout
- agent
- phone
- email
- unknown
description: The type of card acceptance method available.
sources:
type: array
items:
type: string
description: Sources of information for this card acceptance method.
required:
- description
- type
- sources
additionalProperties: false
description: Available options for setting up card payments with this vendor.
required:
- id
- latest_bill_issue_date
- latest_expense_transaction_date
- eligible_card_spend
- total_spend
- vendor_address
- vendor_name
- accepts_card
- billing_portal_link
- card_activation_flow
- card_fee
- current_payment_account
- current_payment_method
- current_payment_source
- has_card_fees
- manual_activation_instructions
- merchant_code
- payment_link
- accepts_card_sources
- card_accept_options_sources
- card_fee_sources
- historical_payment_methods
- card_accept_options
additionalProperties: false
description: Array of vendor enrichment data.
required:
- id
- analysis_end_date
- analysis_start_date
- source
- status
- progress
- vendors
IdPathParam:
type: object
properties:
id:
type: string
description: The unique ID of the object.
required:
- id
UpdateSupplierEnablementCardActivationRequest:
type: object
properties:
card_activation:
$ref: '#/components/schemas/UpdateSupplierEnablementCardActivation'
required:
- card_activation
RutterIdPathParams:
type: object
properties:
id:
type: string
format: uuid
description: The Rutter generated unique ID of the object.
required:
- id
CreateSupplierEnablementVendorCardActivation:
type: object
properties:
vendor_id:
type: string
card:
type: object
properties:
exp_date:
type: string
cvc:
type: string
pan:
type: string
cardholder_name:
type: string
city:
type: string
phone:
type: string
state:
type: string
street:
type: string
zip:
type: string
required:
- exp_date
- cvc
- pan
additionalProperties: false
required:
- vendor_id
AsyncResponsePayload:
type: object
properties:
async_response:
type: object
properties:
id:
type: string
response_url:
type: string
status:
type: string
enum:
- prequeued
- pending
- success
- failure
platform_rate_limit_details:
type: object
properties:
lookback_window_seconds:
type: number
platform_rate_limited_basis:
type: string
enum:
- platform
- connection
- hybrid
recent_connection_rate_limited_job_count:
type: number
recent_platform_rate_limited_job_count:
type: number
recent_rate_limited_job_count:
type: number
required:
- lookback_window_seconds
- platform_rate_limited_basis
- recent_connection_rate_limited_job_count
- recent_platform_rate_limited_job_count
- recent_rate_limited_job_count
additionalProperties: false
required:
- id
- response_url
- status
additionalProperties: false
GetSupplierEnablementMerchantEnrichmentResponse:
anyOf:
- $ref: '#/components/schemas/AsyncResponsePayload'
- type: object
properties:
enrichment:
type: object
properties:
vendor_address:
type: string
description: Address of the vendor.
vendor_name:
type: string
description: Name of the vendor.
accepts_card:
type:
- boolean
- 'null'
description: Whether the vendor accepts credit card payments.
billing_portal_link:
type:
- string
- 'null'
description: Billing portal link for this vendor, extracted from OCR or other sources.
card_activation_flow:
type:
- string
- 'null'
enum:
- merchant_auth_link
- generic_job
- payment_link
- 'null'
description: The recommended card activation flow for this vendor. 'merchant_auth_link' requires user to login via browser session, 'generic_job' queues job for manual action, 'payment_link' uses direct payment link.
card_fee:
type:
- number
- 'null'
description: Amount of card payment fees.
has_card_fees:
type:
- boolean
- 'null'
description: Whether the vendor has card payment fees.
manual_activation_instructions:
type:
- string
- 'null'
description: User-facing instructions on how to pay this vendor by card. To be used in the case when automated card switching is unable to complete successfully. Generated when the vendor accepts cards via billing portal or invoice link.
merchant_code:
type:
- string
- 'null'
description: The supported vendor identifier if this vendor matches a known supported vendor (e.g., AWS, VGS).
accepts_card_sources:
type:
- array
- 'null'
items:
type: string
description: Sources of information for this card acceptance method.
card_accept_options_sources:
type:
- array
- 'null'
items:
type: string
description: Sources of information for this card acceptance options.
card_fee_sources:
type:
- array
- 'null'
items:
type: string
description: Sources of information for this card payment fees.
card_accept_options:
type:
- array
- 'null'
items:
type: object
properties:
description:
type: string
description: Description of how to use this card acceptance method.
type:
type: string
enum:
- billing_portal
- invoice_link
- online_checkout
- agent
- phone
- email
- unknown
description: The type of card acceptance method available.
sources:
type: array
items:
type: string
description: Sources of information for this card acceptance method.
required:
- description
- type
- sources
additionalProperties: false
description: Available options for setting up card payments with this vendor.
required:
- vendor_address
- vendor_name
- accepts_card
- billing_portal_link
- card_activation_flow
- card_fee
- has_card_fees
- manual_activation_instructions
- merchant_code
- accepts_card_sources
- card_accept_options_sources
- card_fee_sources
- card_accept_options
additionalProperties: false
required:
- enrichment
additionalProperties: false
SupplierEnablementCardActivationResponse:
type: object
properties:
card_activation:
type: object
properties:
id:
type: string
card_activation_type:
type: string
enum:
- billing_portal
- payment_link
- unknown
status:
type: string
enum:
- pending_setup
- pending_card
- pending_auth
- pending_switch
- success
- failure
user_action_needed:
type: boolean
user_action_url:
type:
- string
- 'null'
created_at:
type: string
description: The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp that the card activation job was created.
required:
- id
- card_activation_type
- status
- user_action_needed
- user_action_url
- created_at
additionalProperties: false
required:
- card_activation
ListSupplierEnablementEnrichmentsResponse:
anyOf:
- $ref: '#/components/schemas/AsyncResponsePayload'
- type: object
properties:
enrichments:
type: array
items:
$ref: '#/components/schemas/SupplierEnablementEnrichmentResponse'
required:
- enrichments
additionalProperties: false