Skip to content

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.

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 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.get_vendor_payment_method_list_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 parent
queryobjectOptionalAdditional keys: not allowed
query.startstringOptional
query.page_sizeintegerOptionalDefault: 20

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List available payment methods for a vendor — response body

Referenced models: List available payment methods for a vendor — response body

List available payment methods for a vendor — response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand List available payment methods for a vendor — response body — data item
pageModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRootPagination details for a Developer API response.
nextJSONRequired within parent
next (anyOf 1)stringAlternativethe query to get to the next page; it is in the format of <BASE_URL>?<new_params>
next (anyOf 2)nullAlternative
List available payment methods for a vendor — response body — data item
FieldTypePresenceDescription and constraints
$JSONRootdiscriminator: {"mapping": {"ACH": "#/components/schemas/ApiVendorAchPaymentMethodResource", "CHECK": "#/components/schemas/ApiVendorCheckPaymentMethodResource"}, "propertyName": "type"}
$ (anyOf 1)ModelAlternativeExpand List available payment methods for a vendor — response body — data item type ACH
$ (anyOf 2)ModelAlternativeExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
account_number_last_fourstringRequired within parentLast four digits of the bank account number.
Maximum length: 4
Minimum length: 4
feeModelRequired within parentExpand Hold Bill — response body — amount
The fee charged for using this payment method.
idstringRequired within parentUnique identifier of the payment method.
Format: uuid
routing_number_last_fourstringRequired within parentLast four digits of the routing number.
Maximum length: 4
Minimum length: 4
typestringRequired within parentThe 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
FieldTypePresenceDescription and constraints
$objectRoot
feeModelRequired within parentExpand Hold Bill — response body — amount
The fee charged for using this payment method.
idstringRequired within parentUnique identifier of the payment method.
Format: uuid
mailing_addressModelRequired within parentExpand List available payment methods for a vendor — response body — data item type CHECK mailing address
The mailing address for check delivery.
typestringRequired within parentThe 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
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
List available payment methods for a vendor — response body — data item type CHECK mailing address
FieldTypePresenceDescription and constraints
$objectRoot
address_line_1stringRequired within parentPrimary address line.
address_line_2JSONRequired within parent
address_line_2 (anyOf 1)stringAlternativeSecondary address line.
Default: null
address_line_2 (anyOf 2)nullAlternative
citystringRequired within parentCity name.
countrystringRequired within parentTwo-letter ISO 3166-1 country code.
postal_codestringRequired within parentPostal or ZIP code.
stateJSONRequired within parent
state (anyOf 1)stringAlternativeState or province abbreviation.
Default: null
Maximum length: 2
Minimum length: 2
state (anyOf 2)nullAlternative

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"]

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.