Ramp: List available payment methods for a vendor
Ramp vendor.getVendorPaymentMethodListResource: arguments, response, policy and SDK examples.
← Vendor operations · Get started
Operation ramp.get_vendor_payment_method_list_resource
Provider route: GET /developer/v1/vendors/{vendor_id}/payment-methods. 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"]["getVendorPaymentMethodListResource"]>[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.getVendorPaymentMethodListResource(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_payment_method_list_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 | |
query | object | Optional | Additional keys: not allowed |
query.start | string | Optional | |
query.page_size | integer | Optional | Default: 20 |
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 List available payment methods for a vendor — response body |
Referenced models: List available payment methods for a vendor — response body
Schemas
Section titled “Schemas”List available payment methods for a vendor — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand List available payment methods for a vendor — response body — data item |
page | Model | Required within parent | Expand List bills — response body — page Pagination details for this response. |
Referenced models: List bills — response body — page, List available payment methods for a vendor — response body — data item
List bills — response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination details for a Developer API response. |
next | JSON | Required within parent | |
next (anyOf 1) | string | Alternative | the query to get to the next page; it is in the format of <BASE_URL>?<new_params> |
next (anyOf 2) | null | Alternative |
List available payment methods for a vendor — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | discriminator: {"mapping": {"ACH": "#/components/schemas/ApiVendorAchPaymentMethodResource", "CHECK": "#/components/schemas/ApiVendorCheckPaymentMethodResource"}, "propertyName": "type"} |
$ (anyOf 1) | Model | Alternative | Expand List available payment methods for a vendor — response body — data item type ACH |
$ (anyOf 2) | Model | Alternative | Expand List available payment methods for a vendor — response body — data item type CHECK |
Referenced models: List available payment methods for a vendor — response body — data item type ACH, List available payment methods for a vendor — response body — data item type CHECK
List available payment methods for a vendor — response body — data item type ACH
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_number_last_four | string | Required within parent | Last four digits of the bank account number. Maximum length: 4 Minimum length: 4 |
fee | Model | Required within parent | Expand Hold Bill — response body — amount The fee charged for using this payment method. |
id | string | Required within parent | Unique identifier of the payment method. Format: uuid |
routing_number_last_four | string | Required within parent | Last four digits of the routing number. Maximum length: 4 Minimum length: 4 |
type | string | Required within parent | The type of payment method. Must equal: ACH |
Referenced models: Hold Bill — response body — amount
List available payment methods for a vendor — response body — data item type CHECK
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fee | Model | Required within parent | Expand Hold Bill — response body — amount The fee charged for using this payment method. |
id | string | Required within parent | Unique identifier of the payment method. Format: uuid |
mailing_address | Model | Required within parent | Expand List available payment methods for a vendor — response body — data item type CHECK mailing address The mailing address for check delivery. |
type | string | Required within parent | The type of payment method. Must equal: CHECK |
Referenced models: List available payment methods for a vendor — response body — data item type CHECK mailing address, Hold Bill — response body — amount
Hold Bill — response body — amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | the 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency_code | string | Required within parent | The type of currency, in ISO 4217 format. e.g. USD for US dollars Default: USD |
minor_unit_conversion_rate | JSON | Required within parent | |
minor_unit_conversion_rate (anyOf 1) | JSON | Alternative | |
minor_unit_conversion_rate (anyOf 1) (anyOf 1) | integer | Alternative | The 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minor_unit_conversion_rate (anyOf 2) | null | Alternative |
List available payment methods for a vendor — response body — data item type CHECK mailing address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address_line_1 | string | Required within parent | Primary address line. |
address_line_2 | JSON | Required within parent | |
address_line_2 (anyOf 1) | string | Alternative | Secondary address line. Default: null |
address_line_2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | City name. |
country | string | Required within parent | Two-letter ISO 3166-1 country code. |
postal_code | string | Required within parent | Postal or ZIP code. |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | State or province abbreviation. Default: null Maximum length: 2 Minimum length: 2 |
state (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.get_vendor_payment_method_list_resource. Catalog operation: get_vendor_payment_method_list_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"]