Stripe: List Payment Attempt Records

Stripe paymentAttemptRecords.getPaymentAttemptRecords: arguments, response, policy and SDK examples.

← Payment attempt records operations · Get started

Operation stripe.getpaymentattemptrecords

Provider route: GET /v1/payment_attempt_records. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["paymentAttemptRecords"]["getPaymentAttemptRecords"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.paymentAttemptRecords.getPaymentAttemptRecords(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.payment_attempt_records.get_payment_attempt_records(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`query`	object	Required within parent	Additional keys: not allowed
`query.expand`	array	Optional
`query.expand[]`	string	Each item	Maximum length: 5000
`query.limit`	integer	Optional
`query.payment_record`	string	Required within parent	Maximum length: 5000
`query.starting_after`	string	Optional	Maximum length: 5000

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
`$`	object	Root	A list of PaymentAttemptRecords.
`data`	array	Required within parent
`data[]`	Model	Each item	Expand Retrieve a Payment Attempt Record — response body
`has_more`	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
`object`	string	Required within parent	String representing the object’s type. Objects of the same type share the same value. Always has the value `list`. Known values: list
`url`	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000

Referenced models: Retrieve a Payment Attempt Record — response body

Schemas

704 more schemas are linked from the tables above, on the schema pages.

Retrieve a Payment Attempt Record — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A Payment Attempt Record represents an individual attempt at making a payment, on or off Stripe. Each payment attempt tries to collect a fixed amount of money from a fixed customer and payment method. Payment Attempt Records are attached to Payment Records. Only one attempt per Payment Record can have guaranteed funds.
`amount`	Model	Required within parent	Expand Report a refund — response body — amount
`amount_authorized`	Model	Required within parent	Expand Report a refund — response body — amount
`amount_canceled`	Model	Required within parent	Expand Report a refund — response body — amount
`amount_failed`	Model	Required within parent	Expand Report a refund — response body — amount
`amount_guaranteed`	Model	Required within parent	Expand Report a refund — response body — amount
`amount_refunded`	Model	Required within parent	Expand Report a refund — response body — amount
`amount_requested`	Model	Required within parent	Expand Report a refund — response body — amount
`application`	JSON	Optional
`application (anyOf 1)`	string	Alternative	ID of the Connect application that created the PaymentAttemptRecord. Maximum length: 5000
`application (anyOf 2)`	null	Alternative
`created`	JSON	Required within parent
`created (anyOf 1)`	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
`created (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`customer_details`	JSON	Optional
`customer_details (anyOf 1)`	JSON	Alternative	Customer information for this payment.
`customer_details (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Report a refund — response body — customer details Customer information for this payment Information about the customer for this payment
`customer_details (anyOf 2)`	null	Alternative
`customer_presence`	JSON	Optional
`customer_presence (anyOf 1)`	string	Alternative	Indicates whether the customer was present in your checkout flow during this payment. Known values: off_session, on_session
`customer_presence (anyOf 2)`	null	Alternative
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000
`description (anyOf 2)`	null	Alternative
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`livemode`	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`metadata`	object	Required within parent	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
`metadata.*`	string	Additional keys	Maximum length: 500
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: payment_attempt_record
`payment_method_details`	JSON	Optional
`payment_method_details (anyOf 1)`	JSON	Alternative	Information about the Payment Method debited for this payment.
`payment_method_details (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Report a refund — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, billing details, bizum, blik, boleto, card, card present, cashapp, crypto, custom, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, momo, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, payment method, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip
`payment_method_details (anyOf 2)`	null	Alternative
`payment_record`	JSON	Optional
`payment_record (anyOf 1)`	string	Alternative	ID of the Payment Record this Payment Attempt Record belongs to. Maximum length: 5000
`payment_record (anyOf 2)`	null	Alternative
`processor_details`	Model	Required within parent	Expand Report a refund — response body — processor details
`reported_by`	string	Required within parent	Indicates who reported the payment. Known values: self, stripe
`shipping_details`	JSON	Optional
`shipping_details (anyOf 1)`	JSON	Alternative	Shipping information for this payment.
`shipping_details (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Report a refund — response body — shipping details Shipping information for this payment address, name, phone
`shipping_details (anyOf 2)`	null	Alternative

Referenced models: Report a refund — response body — amount, Report a refund — response body — customer details Customer information for this payment Information about the customer for this payment, Report a refund — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, billing details, bizum, blik, boleto, card, card present, cashapp, crypto, custom, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, momo, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, payment method, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip, Report a refund — response body — processor details, Report a refund — response body — shipping details Shipping information for this payment address, name, phone

Report a refund — response body — amount

Field	Type	Presence	Description and constraints
`$`	object	Root	A representation of an amount of money, consisting of an amount and a currency.
`currency`	string	Required within parent	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency
`value`	JSON	Required within parent
`value (anyOf 1)`	integer	Alternative	A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
`value (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Report a refund — response body — customer details Customer information for this payment Information about the customer for this payment

Field	Type	Presence	Description and constraints
`$`	object	Root	Information about the customer for this payment.
`customer`	JSON	Optional
`customer (anyOf 1)`	string	Alternative	ID of the Stripe Customer associated with this payment. Maximum length: 5000
`customer (anyOf 2)`	null	Alternative
`email`	JSON	Optional
`email (anyOf 1)`	string	Alternative	The customer's email address. Maximum length: 5000
`email (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The customer's name. Maximum length: 5000
`name (anyOf 2)`	null	Alternative
`phone`	JSON	Optional
`phone (anyOf 1)`	string	Alternative	The customer's phone number. Maximum length: 5000
`phone (anyOf 2)`	null	Alternative

Report a refund — response body — processor details

Field	Type	Presence	Description and constraints
`$`	object	Root	Processor information associated with this payment.
`custom`	Model	Optional	Expand Report a refund — response body — processor details custom
`type`	string	Required within parent	The processor used for this payment attempt. Known values: custom

Referenced models: Report a refund — response body — processor details custom

Create a Payment Method — response body — zip

Field	Type	Presence	Description and constraints
`$`	object	Root

Create a Payment Method — response body — blik

Field	Type	Presence	Description and constraints
`$`	object	Root
`buyer_id`	JSON	Optional
`buyer_id (anyOf 1)`	string	Alternative	A unique and immutable identifier assigned by BLIK to every buyer. Maximum length: 5000
`buyer_id (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: stripe.getpaymentattemptrecords. Catalog operation: GetPaymentAttemptRecords. 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.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source

Report an issue with this page