Skip to content

Ramp: Remove members from a fund

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

← Fund operations · Get started

Operation ramp.delete_fund_remove_members

Provider route: DELETE /developer/v1/funds/{fund_id}/members. 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"]["deleteFundRemoveMembers"]>[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.deleteFundRemoveMembers(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.delete_fund_remove_members(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
bodyModelRequired within parentExpand Add members to a fund — request body — body

Referenced models: Add members to 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

1 more schema is linked from the tables above, on the schema pages.

Add members to a fund — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
user_idsarrayRequired within parentList of user ids to add or remove.
Maximum items: 100
Minimum items: 1
user_ids[]stringEach item
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

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
Fetch a fund — response body — members item
FieldTypePresenceDescription and constraints
$objectRoot
suspensionJSONRequired within parent
suspension (anyOf 1)ModelAlternativeExpand Fetch a fund — response body — suspension suspended at, suspended by ramp, suspended by user id
Suspension details for this member, or null if not suspended.
Read only: true
suspension (anyOf 2)nullAlternative
user_idstringRequired within parentUnique identifier of the fund member.
Format: uuid

Referenced models: Fetch a fund — response body — suspension suspended at, suspended by ramp, suspended by user id

Fetch a fund — response body — permitted spend types
FieldTypePresenceDescription and constraints
$objectRoot
physical_card_enabledbooleanRequired within parentWhether the user's physical card can be linked to this fund.
reimbursements_enabledbooleanRequired within parentWhether reimbursements can be submitted against this fund.
virtual_card_enabledbooleanRequired within parentWhether virtual cards can be linked to this fund.
Fetch a fund — response body — suspension suspended at, suspended by ramp, suspended by user id
FieldTypePresenceDescription and constraints
$objectRoot
suspended_atJSONRequired within parent
suspended_at (anyOf 1)stringAlternativeDate and time at which the suspension was placed.
Format: date-time
suspended_at (anyOf 2)nullAlternative
suspended_by_rampbooleanRequired within parentWhether the suspension was placed by Ramp.
Read only: true
suspended_by_user_idJSONRequired within parent
suspended_by_user_id (anyOf 1)stringAlternativeUnique identifier of the user who placed the suspension.
Format: uuid
Read only: true
suspended_by_user_id (anyOf 2)nullAlternative
Fetch a fund — response body — balance cleared, pending, total
FieldTypePresenceDescription and constraints
$objectRoot
clearedModelRequired within parentExpand Hold Bill — response body — amount
Cleared amount on this fund.
Read only: true
pendingModelRequired within parentExpand Hold Bill — response body — amount
Pending amount towards this fund.
Read only: true
totalModelRequired within parentExpand Hold Bill — response body — amount
Total amount spent on this fund.
Read only: true

Referenced models: Hold Bill — response body — amount

Hold Bill — response body — amount
FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)integerAlternativethe amount of money represented in the smallest denomination of the currency. For example, when the currency is USD, then the amount is expressed in cents.
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency_codestringRequired within parentThe type of currency, in ISO 4217 format. e.g. USD for US dollars
Default: USD
minor_unit_conversion_rateJSONRequired within parent
minor_unit_conversion_rate (anyOf 1)JSONAlternative
minor_unit_conversion_rate (anyOf 1) (anyOf 1)integerAlternativeThe conversion factor to convert from the integer amount to the actual currency value. Divide amount by this value to get the real currency amount. For USD, this is 100 (e.g., 12034 / 100 = 120.34 USD). See https://docs.ramp.com/developer-api/v1/monetary-values for more information.
Read only: true
minor_unit_conversion_rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
minor_unit_conversion_rate (anyOf 2)nullAlternative

SDK function policy ID: ramp.delete_fund_remove_members. Catalog operation: delete_fund_remove_members. 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.