Skip to content

Ramp: Add to a vendor's bank account details

Ramp vendor.postVendorBankAccountUpdateResource: arguments, response, policy and SDK examples.

← Vendor operations · Get started

Operation ramp.post_vendor_bank_account_update_resource

Provider route: POST /developer/v1/vendors/{vendor_id}/update-bank-accounts. 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["vendor"]["postVendorBankAccountUpdateResource"]>[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.vendor.postVendorBankAccountUpdateResource(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.vendor.post_vendor_bank_account_update_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.vendor_idstringRequired within parentFormat: uuid
bodyModelRequired within parentExpand Add to a vendor’s bank account details — request body — body

Referenced models: Add to a vendor’s bank account details — 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 Add to a vendor’s bank account details — response body

Referenced models: Add to a vendor’s bank account details — response body

Add to a vendor's bank account details — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
account_nicknamestringOptionalOptional nickname for the payment account
ach_detailsModelOptionalExpand Add to a vendor's bank account details — request body — body ach details
ACH payment details
crypto_detailsModelOptionalExpand Add to a vendor's bank account details — request body — body crypto details
Crypto wallet (stablecoin) payout details
is_defaultbooleanOptionalWhether this should be the default payment method
Default: false
wire_detailsModelOptionalExpand Add to a vendor's bank account details — request body — body wire details
Wire payment details

Referenced models: Add to a vendor's bank account details — request body — body ach details, Add to a vendor's bank account details — request body — body crypto details, Add to a vendor's bank account details — request body — body wire details

Add to a vendor's bank account details — response body
FieldTypePresenceDescription and constraints
$objectRoot
payment_method_idJSONOptional
payment_method_id (anyOf 1)stringAlternativeUnique identifier of the created payment method. Null when the update requires approval (status is pending_approval).
Format: uuid
payment_method_id (anyOf 2)nullAlternative
payment_method_typeJSONOptional
payment_method_type (anyOf 1)stringAlternativeType of the created payment method (e.g. ach, wire). Will be null if bank validation fails.
Known values: ach, crypto, wire
payment_method_type (anyOf 2)nullAlternative
proposal_idJSONOptional
proposal_id (anyOf 1)stringAlternativeUnique identifier of the approval proposal, if approval is required.
Format: uuid
proposal_id (anyOf 2)nullAlternative
statusstringRequired within parentStatus of the bank account update operation.
Known values: approved, pending_approval
vendor_idstringRequired within parentUnique identifier of the vendor.
Format: uuid
Add to a vendor's bank account details — request body — body ach details
FieldTypePresenceDescription and constraints
$objectRoot
account_namestringOptionalAccount name
Default: Checking Account
account_numberstringRequired within parentACH account number
account_owner_typestringOptionalAccount owner type
Default: BUSINESS
One of: BUSINESS, INDIVIDUAL
account_typestringOptionalAccount type
Default: Checking
One of: Checking, Savings
routing_numberstringRequired within parentACH routing number
Add to a vendor's bank account details — request body — body crypto details
FieldTypePresenceDescription and constraints
$objectRoot
account_nameJSONOptional
account_name (anyOf 1)stringAlternativeName of the wallet's account holder.
Default: null
account_name (anyOf 2)nullAlternative
networkstringRequired within parentBlockchain network the wallet receives stablecoin payouts on.
One of: ARBITRUM_MAINNET, AVALANCHE_MAINNET, BASE_MAINNET, ETHEREUM_MAINNET, OPTIMISM_MAINNET, PLASMA_MAINNET, POLYGON_MAINNET, SOLANA_MAINNET, STELLAR_MAINNET, SUI_MAINNET, TEMPO_MAINNET
wallet_addressstringRequired within parentDestination crypto wallet address.
Add to a vendor's bank account details — request body — body wire details
FieldTypePresenceDescription and constraints
$objectRoot
account_namestringOptionalAccount holder name. If omitted, the account is labeled Checking Account and any saved beneficiary address uses the vendor name.
account_numberstringRequired within parentWire account number
beneficiary_addressModelOptionalExpand Add to a vendor's bank account details — request body — body wire details beneficiary address
Recipient's mailing address, not the bank's address. If omitted and automatic address copying is enabled for your business, the vendor's default mailing address is copied when complete and valid. If copying is disabled or no usable default exists, wire details are saved without an address. Later vendor address changes do not update this copy.
routing_numberstringRequired within parentWire routing number

Referenced models: Add to a vendor's bank account details — request body — body wire details beneficiary address

Add to a vendor's bank account details — request body — body wire details beneficiary address
FieldTypePresenceDescription and constraints
$objectRoot
address_line_1stringRequired within parentPrimary address line of the vendor.
address_line_2JSONOptional
address_line_2 (anyOf 1)stringAlternativeSecondary address line or suite number of the vendor.
address_line_2 (anyOf 2)nullAlternative
citystringRequired within parentCity of the recipient address.
Pattern: \S
countrystringRequired within parentTwo-letter ISO 3166-1 country code of the recipient address.
postal_codestringRequired within parentPostal or ZIP code of the recipient address.
Pattern: \S
stateJSONOptional
state (anyOf 1)stringAlternativeAddress state/province abbreviation. For US addresses, use the two-letter state abbreviation, such as VA. Required for addresses in US, CA, and AU. Ignored for other countries.
state (anyOf 2)nullAlternative

SDK function policy ID: ramp.post_vendor_bank_account_update_resource. Catalog operation: post_vendor_bank_account_update_resource. 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: ["vendors: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.