Skip to content

Ramp: Update a fund

Ramp fund.patchFundUpdate: arguments, response, policy and SDK examples.

← Fund operations · Get started

Operation ramp.patch_fund_update

Provider route: PATCH /developer/v1/funds/{fund_id}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["fund"]["patchFundUpdate"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.fund.patchFundUpdate(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_ramp import RampIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.fund.patch_fund_update(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.fund_idstringRequired within parent
headersobjectOptionalAdditional keys: not allowed
headers.X-Idempotency-KeystringOptionalMaximum length: 255
Minimum length: 1
bodyModelRequired within parentExpand Update a fund — request body — body

Referenced models: Update a fund — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Fetch a fund — response body

Referenced models: Fetch a fund — response body

7 more schemas are linked from the tables above, on the schema pages.

Update a fund — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
accounting_rulesarrayOptionalAccounting rules (full replace).
accounting_rules[]ModelEach itemExpand Create a fund — request body — body accounting rules item
display_namestringOptionalDisplay name for the fund.
is_exempt_from_policy_agentbooleanOptionalWhether the fund is exempt from policy agent review.
is_shareablebooleanOptionalWhether the fund supports multiple members.
permitted_spend_typesModelOptionalExpand Create a fund — request body — body permitted spend types
Permitted spend types (full replace).
spend_program_idJSONOptional
spend_program_id (anyOf 1)stringAlternativeSpend program to link (null to detach).
Format: uuid
spend_program_id (anyOf 2)nullAlternative
spending_restrictionsModelOptionalExpand Update a fund — request body — body spending restrictions
Spending restriction overrides (partial merge). When the fund is linked to a spend program, provided sub-fields override the program's default values.

Referenced models: Create a fund — request body — body accounting rules item, Create a fund — request body — body permitted spend types, Update a fund — request body — body spending restrictions

Fetch a fund — response body
FieldTypePresenceDescription and constraints
$objectRoot
balanceJSONRequired within parent
balance (anyOf 1)ModelAlternativeExpand Fetch a fund — response body — balance cleared, pending, total
Current balance of the fund.
Read only: true
balance (anyOf 2)nullAlternative
cardsarrayRequired within parentCards linked to this fund.
cards[]ModelEach itemExpand Fetch a fund — response body — cards item
created_atstringRequired within parentTime at which the fund was created, in ISO 8601 format.
Format: date-time
display_namestringRequired within parentDisplay name of the fund.
entity_idJSONRequired within parent
entity_id (anyOf 1)stringAlternativeAssociated business entity of the fund.
Format: uuid
entity_id (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier of the fund.
Format: uuid
is_exempt_from_policy_agentbooleanRequired within parentWhether this fund is exempt from policy agent review.
is_shareablebooleanRequired within parentWhether this fund is shareable among multiple users.
membersarrayRequired within parentMembers who can spend from the fund.
members[]ModelEach itemExpand Fetch a fund — response body — members item
overrides_spend_programbooleanRequired within parentWhether the fund's settings override those of its spend program.
permitted_spend_typesModelRequired within parentExpand Fetch a fund — response body — permitted spend types
Permitted spend types for this fund.
spend_program_idJSONRequired within parent
spend_program_id (anyOf 1)stringAlternativeUnique identifier of the associated spend program.
Format: uuid
spend_program_id (anyOf 2)nullAlternative
spending_restrictionsJSONRequired within parent
spending_restrictions (anyOf 1)ModelAlternativeExpand Fetch a fund — response body — spending_restrictions / interval: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
Spending restrictions on this fund.
Read only: true
spending_restrictions (anyOf 2)nullAlternative
statestringRequired within parentCurrent state of the fund: ACTIVE, SUSPENDED, or TERMINATED.
Known values: ACTIVE, ARCHIVED, SUSPENDED, TERMINATED
Read only: true
suspensionJSONRequired within parent
suspension (anyOf 1)ModelAlternativeExpand Fetch a fund — response body — suspension suspended at, suspended by ramp, suspended by user id
Suspension details at the fund level, or null if the fund is not suspended.
Read only: true
suspension (anyOf 2)nullAlternative

Referenced models: Fetch a fund — response body — cards item, Fetch a fund — response body — members item, Fetch a fund — response body — permitted spend types, Fetch a fund — response body — suspension suspended at, suspended by ramp, suspended by user id, Fetch a fund — response body — balance cleared, pending, total, Fetch a fund — response body — spending_restrictions / interval: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY

Create a fund — request body — body accounting rules item
FieldTypePresenceDescription and constraints
$objectRoot
field_idstringRequired within parentUUID of the accounting field.
Format: uuid
field_option_idstringRequired within parentUUID of the accounting field option.
Format: uuid
Create a fund — request body — body permitted spend types
FieldTypePresenceDescription and constraints
$objectRoot
physical_cardbooleanRequired within parentWhether the user's physical card can be linked to this fund.
reimbursementsbooleanRequired within parentWhether reimbursements can be submitted against this fund.
virtual_cardbooleanRequired within parentWhether virtual cards can be linked to this fund.
Update a fund — request body — body spending restrictions
FieldTypePresenceDescription and constraints
$objectRoot
allowed_category_codesarrayOptionalList of allowed Ramp category codes.
allowed_category_codes[]integerEach itemOne of: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 4, 40, 41, 42, 43, 44, 5, 6, 7, 8, 9
allowed_vendor_idsarrayOptionalList of allowed vendor IDs.
allowed_vendor_ids[]stringEach itemFormat: uuid
blocked_category_codesarrayOptionalList of blocked Ramp category codes.
blocked_category_codes[]integerEach itemOne of: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 4, 40, 41, 42, 43, 44, 5, 6, 7, 8, 9
blocked_mcc_codesarrayOptional
blocked_mcc_codes[]stringEach item
blocked_vendor_idsarrayOptionalList of blocked vendor IDs.
blocked_vendor_ids[]stringEach itemFormat: uuid
convert_to_entity_currencybooleanOptionalConvert limits to the currency of the fund's entity at Ramp's daily rate. Not supported for fixed-amount spend programs.
Default: false
intervalstringOptionalTime interval to apply limit to.
One of: ANNUAL, DAILY, MONTHLY, QUARTERLY, TERTIARY, TOTAL, WEEKLY, YEARLY
is_temporary_increasebooleanOptionalWhether this limit change is temporary.
Default: false
limitModelOptionalExpand Create a fund — request body — body spending restrictions limit
Total amount limit per interval denominated in the smallest currency unit (e.g. cents for USD).
lock_dateJSONOptional
lock_date (anyOf 1)stringAlternativeDate to automatically suspend the fund. If lock date has passed, set to a future date or to null to unsuspend.
Format: date-time
lock_date (anyOf 2)nullAlternative
transaction_amount_limitModelOptionalExpand Create a fund — request body — body spending restrictions limit
Max amount per transaction denominated in the smallest currency unit (e.g. cents for USD).

Referenced models: Create a fund — request body — body spending restrictions limit

Fetch a fund — response body — cards item
FieldTypePresenceDescription and constraints
$objectRoot
card_idstringRequired within parentUnique identifier of the card.
Format: uuid
created_atstringRequired within parentTime the card was created.
Format: date-time
display_namestringRequired within parentDisplay name of the card.
expirationstringRequired within parentExpiration date in MMYY format. Redacted if the card has not been activated.
Read only: true
last_fourstringRequired within parentLast four digits of the card number. Redacted if the card has not been activated.
Read only: true
user_idstringRequired within parentUnique identifier of the cardholder.
Format: uuid

SDK function policy ID: ramp.patch_fund_update. Catalog operation: patch_fund_update. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["funds:write"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.