Skip to content

Ramp: List transfer payments

Ramp transferPayment.getTransferListWithPagination: arguments, response, policy and SDK examples.

← Transfer payment operations · Get started

Operation ramp.get_transfer_list_with_pagination

Provider route: GET /developer/v1/transfers. 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["transferPayment"]["getTransferListWithPagination"]>[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.transferPayment.getTransferListWithPagination(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.transfer_payment.get_transfer_list_with_pagination(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.sync_statusstringOptionalOne of: NOT_SYNC_READY, SYNCED, SYNC_READY
query.statusstringOptionalOne of: ACH_CONFIRMED, CANCELED, COMPLETED, ERROR, INITIATED, NOT_ACKED, NOT_ENOUGH_FUNDS, PROCESSING_BY_ODFI, REJECTED_BY_ODFI, RETURNED_BY_RDFI, SUBMITTED_TO_FED, SUBMITTED_TO_RDFI, UNNECESSARY, UPLOADED
query.entity_idstringOptionalFormat: uuid
query.statement_idstringOptionalFormat: uuid
query.has_no_sync_commitsbooleanOptional
query.from_datestringOptionalFormat: date-time
query.to_datestringOptionalFormat: date-time
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 transfer payments — response body

Referenced models: List transfer payments — response body

List transfer payments — response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Fetch a transfer payment — response body
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: List bills — response body — page, Fetch a transfer payment — response body

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
Fetch a transfer payment — response body
FieldTypePresenceDescription and constraints
$objectRoot
amountModelOptionalExpand Hold Bill — response body — amount
Amount of the transfer.
bank_account_idJSONRequired within parent
bank_account_id (anyOf 1)stringAlternativeUnique identifier of the bank account used for this transfer payment.
Format: uuid
Read only: true
bank_account_id (anyOf 2)nullAlternative
created_atstringOptionalTimestamp when the transfer was created.
Format: date-time
entity_idstringOptionalBusiness entity associated with this transfer.
Format: uuid
idstringOptionalUnique identifier for the transfer.
Format: uuid
payment_idstringOptionalUnique payment identifier for the transfer.
statusstringOptionalStatus of the transfer. See [Transfers Guide](/developer-api/v1/guides/transfers) for definitions.
Known values: ACH_CONFIRMED, CANCELED, COMPLETED, ERROR, INITIATED, NOT_ACKED, NOT_ENOUGH_FUNDS, PROCESSING_BY_ODFI, REJECTED_BY_ODFI, RETURNED_BY_RDFI, SUBMITTED_TO_FED, SUBMITTED_TO_RDFI, UNNECESSARY, UPLOADED
sync_statusstringRequired within parentCurrent sync status of the transfer.
Known values: NOT_SYNC_READY, SYNCED, SYNC_READY
Read only: true

Referenced models: 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

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