Ramp: Fetch a vendor bank account
Ramp vendor.getVendorBankAccountResource: arguments, response, policy and SDK examples.
← Vendor operations · Get started
Operation ramp.get_vendor_bank_account_resource
Provider route: GET /developer/v1/vendors/{vendor_id}/accounts/{bank_account_id}. 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"]["getVendorBankAccountResource"]>[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.getVendorBankAccountResource(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.get_vendor_bank_account_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.bank_account_id | string | Required within parent | Format: uuid |
path.vendor_id | string | Required within parent | Format: uuid |
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 Fetch a vendor bank account — response body |
Referenced models: Fetch a vendor bank account — response body
Schemas
Section titled “Schemas”Fetch a vendor bank account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_nickname | string | Optional | Nickname of the vendor bank account. |
account_number_last_four | JSON | Required within parent | |
account_number_last_four (anyOf 1) | string | Alternative | Last four digits of the bank account number. Read only: true |
account_number_last_four (anyOf 2) | null | Alternative | |
currency | string | Required within parent | Currency of the vendor bank account. Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL |
id | string | Required within parent | Unique identifier of the vendor bank account. Format: uuid |
is_default | boolean | Required within parent | Whether this is the payee's default bank account. For a pending account, whether its vendor edit makes it the default. Read only: true |
payment_method | string | Required within parent | Supported payment method for the vendor bank account. Known values: ACH, AUTOMATIC_CARD_PAYMENT, CARD, CHECK, CRYPTO_WALLET_TRANSFER, DIRECT_DEBIT, DOMESTIC_WIRE, EARLY_PAYMENT_DISCOUNT, FED_NOW, INTERNATIONAL, LOCAL_BANK_TRANSFER, ONE_TIME_CARD, ONE_TIME_CARD_DELIVERY, PAID_MANUALLY, RTP, SWIFT, UNSPECIFIED, VENDOR_CREDIT |
proposal_id | JSON | Required within parent | |
proposal_id (anyOf 1) | string | Alternative | Current approval proposal for the vendor edit that adds this bank account. Further changes submitted to the same pending edit replace it, so it may differ from the proposal_id returned on submission. Null unless status is pending_approval. Format: uuid Read only: true |
proposal_id (anyOf 2) | null | Alternative | |
status | string | Required within parent | Approval status of the vendor bank account. Known values: active, pending_approval, pending_deletion Read only: true |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.get_vendor_bank_account_resource. Catalog operation: get_vendor_bank_account_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:read"]