Skip to content

Ramp: List repayments

Ramp repayment.getRepaymentListWithPagination: arguments, response, policy and SDK examples.

← Repayment operations · Get started

Operation ramp.get_repayment_list_with_pagination

Provider route: GET /developer/v1/repayments. 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["repayment"]["getRepaymentListWithPagination"]>[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.repayment.getRepaymentListWithPagination(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.repayment.get_repayment_list_with_pagination(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.entity_idstringOptionalFormat: uuid
query.funding_methodsarrayOptional
query.funding_methods[]stringEach itemOne of: ach, debit_card, export_for_payment, payroll, prefunded, push, repay_off_ramp
query.original_transaction_idstringOptionalFormat: uuid
query.from_repaid_atstringOptionalFormat: date-time
query.to_repaid_atstringOptionalFormat: date-time
query.sync_statusstringOptionalOne of: IN_PROGRESS, MARKED_CANCELED, NOT_STARTED, SYNC_FAILURE, SYNC_SUCCESS
query.startstringOptional
query.page_sizeintegerOptionalDefault: 20
query.user_idstringOptionalFormat: uuid

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List repayments — response body

Referenced models: List repayments — response body

List repayments — response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand List repayments — 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 repayments — 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 repayments — response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
entity_idstringOptionalUnique identifier of the associated business entity.
Format: uuid
funding_methodJSONRequired within parent
funding_method (anyOf 1)stringAlternativeThe method used to fund the repayment.
Read only: true
funding_method (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier of the repayment.
Format: uuid
original_transaction_idJSONRequired within parent
original_transaction_id (anyOf 1)stringAlternativeOriginal transaction id.
Read only: true
original_transaction_id (anyOf 2)nullAlternative
repaid_atJSONRequired within parent
repaid_at (anyOf 1)stringAlternativeTime at which the repayment is repaid. Presented in ISO8601 format.
Format: date-time
Read only: true
repaid_at (anyOf 2)nullAlternative
repayment_amountJSONRequired within parent
repayment_amount (anyOf 1)ModelAlternativeExpand Hold Bill — response body — amount
Amount and currency of the repayment by the payor.
Read only: true
repayment_amount (anyOf 2)nullAlternative
statusstringRequired within parentCurrent repayment status.
Known values: AWAITING_MANUAL_REPAYMENT, AWAITING_PAYMENT, NONE, REPAID, REPAYMENT_FAILED, REQUESTED_BY_REVIEWER
Read only: true
sync_statusJSONRequired within parent
sync_status (anyOf 1)stringAlternativeLatest accounting sync status of the repayment. Null if no repayment sync has been attempted.
Known values: IN_PROGRESS, MARKED_CANCELED, NOT_STARTED, SYNC_FAILURE, SYNC_SUCCESS
Read only: true
sync_status (anyOf 2)nullAlternative
user_idJSONRequired within parent
user_id (anyOf 1)stringAlternativeCardholder user id.
Read only: true
user_id (anyOf 2)nullAlternative
user_signatureJSONRequired within parent
user_signature (anyOf 1)stringAlternativeUser's signature from the repayment agreement acceptance.
Read only: true
user_signature (anyOf 2)nullAlternative

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_repayment_list_with_pagination. Catalog operation: get_repayment_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: ["repayments: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.