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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.vendor_id | string | Required within parent | Format: uuid |
body | Model | Required within parent | Expand 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
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Add to a vendor’s bank account details — response body |
Referenced models: Add to a vendor’s bank account details — response body
Schemas
Section titled “Schemas”Add to a vendor's bank account details — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_nickname | string | Optional | Optional nickname for the payment account |
ach_details | Model | Optional | Expand Add to a vendor's bank account details — request body — body ach details ACH payment details |
crypto_details | Model | Optional | Expand Add to a vendor's bank account details — request body — body crypto details Crypto wallet (stablecoin) payout details |
is_default | boolean | Optional | Whether this should be the default payment method Default: false |
wire_details | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
payment_method_id | JSON | Optional | |
payment_method_id (anyOf 1) | string | Alternative | Unique identifier of the created payment method. Null when the update requires approval (status is pending_approval). Format: uuid |
payment_method_id (anyOf 2) | null | Alternative | |
payment_method_type | JSON | Optional | |
payment_method_type (anyOf 1) | string | Alternative | Type 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) | null | Alternative | |
proposal_id | JSON | Optional | |
proposal_id (anyOf 1) | string | Alternative | Unique identifier of the approval proposal, if approval is required. Format: uuid |
proposal_id (anyOf 2) | null | Alternative | |
status | string | Required within parent | Status of the bank account update operation. Known values: approved, pending_approval |
vendor_id | string | Required within parent | Unique identifier of the vendor. Format: uuid |
Add to a vendor's bank account details — request body — body ach details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_name | string | Optional | Account name Default: Checking Account |
account_number | string | Required within parent | ACH account number |
account_owner_type | string | Optional | Account owner type Default: BUSINESS One of: BUSINESS, INDIVIDUAL |
account_type | string | Optional | Account type Default: Checking One of: Checking, Savings |
routing_number | string | Required within parent | ACH routing number |
Add to a vendor's bank account details — request body — body crypto details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_name | JSON | Optional | |
account_name (anyOf 1) | string | Alternative | Name of the wallet's account holder. Default: null |
account_name (anyOf 2) | null | Alternative | |
network | string | Required within parent | Blockchain 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_address | string | Required within parent | Destination crypto wallet address. |
Add to a vendor's bank account details — request body — body wire details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_name | string | Optional | Account holder name. If omitted, the account is labeled Checking Account and any saved beneficiary address uses the vendor name. |
account_number | string | Required within parent | Wire account number |
beneficiary_address | Model | Optional | Expand 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_number | string | Required within parent | Wire 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address_line_1 | string | Required within parent | Primary address line of the vendor. |
address_line_2 | JSON | Optional | |
address_line_2 (anyOf 1) | string | Alternative | Secondary address line or suite number of the vendor. |
address_line_2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | City of the recipient address. Pattern: \S |
country | string | Required within parent | Two-letter ISO 3166-1 country code of the recipient address. |
postal_code | string | Required within parent | Postal or ZIP code of the recipient address. Pattern: \S |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | Address 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) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]