Skip to content

Ramp: List payments

Ramp payment.getPaymentListResource: arguments, response, policy and SDK examples.

← Payment operations · Get started

Operation ramp.get_payment_list_resource

Provider route: GET /developer/v1/payments. 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["payment"]["getPaymentListResource"]>[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.payment.getPaymentListResource(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.payment.get_payment_list_resource(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.external_refJSONOptional
query.external_ref (anyOf 1)stringAlternativeMinimum length: 1
query.external_ref (anyOf 2)nullAlternative
query.statusJSONOptional
query.status (anyOf 1)stringAlternativeOne of: CANCELED, COMPLETED, ERROR, PROCESSING, SCHEDULED
query.status (anyOf 2)nullAlternative
query.vendor_idJSONOptional
query.vendor_id (anyOf 1)stringAlternativeFormat: uuid
query.vendor_id (anyOf 2)nullAlternative
query.include_canceledbooleanOptionalDefault: false
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 payments — response body

Referenced models: List payments — response body

1 more schema is linked from the tables above, on the schema pages.

List payments — response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Fetch a 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 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 payment — response body
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
amountModelRequired within parentExpand Fetch a payment — response body — amount
The payment amount and currency.
Read only: true
check_detailsJSONRequired within parent
check_details (anyOf 1)ModelAlternativeExpand Fetch a payment — response body — check details estimated delivery date, mailed at, tracking number, tracking updates, tracking url
Check-specific delivery tracking details. Populated only for check-funded payments.
Read only: true
check_details (anyOf 2)nullAlternative
customer_friendly_payment_idJSONRequired within parent
customer_friendly_payment_id (anyOf 1)stringAlternativeCustomer-friendly payment identifier for non-card payment methods, if available. Payments sharing the same value belong to the same payment or batch payment.
customer_friendly_payment_id (anyOf 2)nullAlternative
entity_idstringRequired within parentUnique identifier of the entity making the payment.
Format: uuid
external_invoice_numberJSONRequired within parent
external_invoice_number (anyOf 1)stringAlternativeThe invoice number associated with this payment.
external_invoice_number (anyOf 2)nullAlternative
external_refJSONRequired within parent
external_ref (anyOf 1)stringAlternativeAn external reference identifier for this payment.
external_ref (anyOf 2)nullAlternative
failure_reasonJSONRequired within parent
failure_reason (anyOf 1)stringAlternativeThe reason for the payment failure, if applicable.
Known values: ACCOUNT_HOLDER_DECEASED, CARD_DECLINED, CARD_DETAILS_INVALID, CARD_INSUFFICIENT_FUNDS, CARD_PROCESSING_ERROR, CARD_REVERIFICATION_REQUIRED, CHECK_ATTACHMENT_REJECTED, CHECK_DELIVERY_FAILURE, CHECK_DEPOSIT_REJECTED, CHECK_DEPOSIT_RETURNED, CHECK_EXPIRED, CHECK_VOIDED, CHECK_WITHDRAWAL_INSUFFICIENT_BALANCE, CHECK_WITHDRAWAL_RECIPIENT_NAME_MISMATCH, CHECK_WITHDRAWAL_RETURNED, DEBIT_DISPUTED, DUPLICATE_ACH_ENTRY, FAILURE_NOT_RECOGNIZED, INTERNATIONAL_DIRECT_DEBIT_INSTRUMENT_UNAVAILABLE, INTERNATIONAL_PROVIDER_UNAVAILABLE, INVALID_BANK_BRANCH, INVALID_ROUTING_NUMBER, MANDATE_DATA_MISMATCH, MISSING_PAYEE_BANK_ACCOUNT, MISSING_PAYER_BANK_ACCOUNT, PAYEE_ACCOUNT_CLOSED, PAYEE_ACCOUNT_FROZEN, PAYEE_ACCOUNT_INVALID_BENEFICIARY_DETAILS, PAYEE_ACCOUNT_NON_TRANSACTIONAL, PAYEE_ACCOUNT_NOT_FOUND, PAYEE_ACCOUNT_REJECTED_PAYMENT, PAYEE_ACCOUNT_WRONG_CURRENCY, PAYEE_ACCOUNT_WRONG_NAME, PAYER_ACCOUNT_CLOSED, PAYER_ACCOUNT_DEBIT_BLOCK, PAYER_ACCOUNT_FROZEN, PAYER_ACCOUNT_INSUFFICIENT_FUNDS, PAYER_ACCOUNT_NON_TRANSACTIONAL, PAYER_ACCOUNT_NOT_FOUND, PAYER_ACCOUNT_WRONG_CURRENCY, PAYER_ACCOUNT_WRONG_NAME, PAYER_OUTSTANDING_BALANCE, PAYMENT_FREEZE, PAYMENT_RETURNED_BY_PROVIDER, PROVIDER_ACCOUNT_FROZEN, QUOTE_REJECTED_BY_PROVIDER, QUOTE_TRANSFER_TOO_EXPENSIVE, SETTLEMENT_PAYMENT_CANCELED, UNRESOLVED_COMPLIANCE_RFI, UNRESOLVED_NO_DQ_INSUFFICIENT_FUNDS, UNSUPPORTED_BY_BANKING_PARTNER, WIRE_INCORRECT_ACCOUNT_NUMBER, WIRE_INCORRECT_BENEFICIARY_DETAILS
Read only: true
failure_reason (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the payment.
Format: uuid
is_cancelablebooleanRequired within parentWhether this payment can be canceled.
Read only: true
payment_methodModelRequired within parentExpand Fetch a payment — response body — payment method
The payment method used for this payment.
Read only: true
scheduled_datestringRequired within parentThe date the payment is scheduled to be initiated.
Format: date
source_bank_account_idstringRequired within parentUnique identifier of the bank account the payment is sent from.
Format: uuid
statusstringRequired within parentThe current status of the payment.
Known values: CANCELED, COMPLETED, ERROR, PROCESSING, SCHEDULED
Read only: true
status_detailJSONRequired within parent
status_detail (anyOf 1)stringAlternativeThe detailed processing status for an ACH payment. Null for other payment methods.
Known values: CANCELED, DEBITING, DELIVERED, FAILED, INITIATED, SCHEDULED, TRANSFERRING_TO_VENDOR
Read only: true
status_detail (anyOf 2)nullAlternative
vendor_idstringRequired within parentUnique identifier of the vendor being paid.
Format: uuid

Referenced models: Fetch a payment — response body — amount, Fetch a payment — response body — payment method, Fetch a payment — response body — check details estimated delivery date, mailed at, tracking number, tracking updates, tracking url

Fetch a payment — response body — amount
FieldTypePresenceDescription and constraints
$objectRoot
currencystringRequired within parentThe currency of the amount in ISO 4217 format (e.g. USD).
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
valueJSONRequired within parent
value (anyOf 1)integerAlternativeThe non-negative amount in the smallest denomination of the currency (e.g. cents for USD).
Minimum: 0
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Fetch a payment — response body — payment method
FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentUnique identifier of the payment instrument.
Format: uuid
typestringRequired within parentThe type of payment method.
Known values: ACH, CHECK
Fetch a payment — response body — check details estimated delivery date, mailed at, tracking number, tracking updates, tracking url
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
estimated_delivery_dateJSONRequired within parent
estimated_delivery_date (anyOf 1)stringAlternativeEstimated date the mailed check will reach the vendor, if available.
Format: date
estimated_delivery_date (anyOf 2)nullAlternative
mailed_atJSONRequired within parent
mailed_at (anyOf 1)stringAlternativeISO 8601 timestamp the check printing provider reported mailing the check, if available.
Format: date-time
mailed_at (anyOf 2)nullAlternative
tracking_numberJSONRequired within parent
tracking_number (anyOf 1)stringAlternativeCarrier tracking number for the mailed check, if available.
tracking_number (anyOf 2)nullAlternative
tracking_updatesarrayRequired within parentCarrier tracking updates for the mailed check, in the order returned by the carrier. Empty when no tracking updates have been received yet.
tracking_updates[]ModelEach itemExpand Fetch a payment — response body — check details estimated delivery date, mailed at, tracking number, tracking updates, tracking url tracking updates item
tracking_urlJSONRequired within parent
tracking_url (anyOf 1)stringAlternativeCarrier tracking URL for the mailed check, if available.
tracking_url (anyOf 2)nullAlternative

Referenced models: Fetch a payment — response body — check details estimated delivery date, mailed at, tracking number, tracking updates, tracking url tracking updates item

SDK function policy ID: ramp.get_payment_list_resource. Catalog operation: get_payment_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: ["payments: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.