View Source Stripe.PaymentAttemptRecord (stripity_stripe v3.3.1)

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.

Summary

Types

t()

The payment_attempt_record type.

Functions

list(params \\ %{}, opts \\ [])

List all the Payment Attempt Records attached to the specified Payment Record.

retrieve(id, params \\ %{}, opts \\ [])

Retrieves a Payment Attempt Record with the given ID

Types

t()

@type t() :: %Stripe.PaymentAttemptRecord{
  amount: term(),
  amount_authorized: term(),
  amount_canceled: term(),
  amount_failed: term(),
  amount_guaranteed: term(),
  amount_refunded: term(),
  amount_requested: term(),
  application: binary() | nil,
  created: integer(),
  customer_details: term() | nil,
  customer_presence: binary() | nil,
  description: binary() | nil,
  id: binary(),
  livemode: boolean(),
  metadata: term(),
  object: binary(),
  payment_method_details: term() | nil,
  payment_record: binary() | nil,
  processor_details: term(),
  reported_by: binary(),
  shipping_details: term() | nil
}

The payment_attempt_record type.

amount
amount_authorized
amount_canceled
amount_failed
amount_guaranteed
amount_refunded
amount_requested
application ID of the Connect application that created the PaymentAttemptRecord.
created Time at which the object was created. Measured in seconds since the Unix epoch.
customer_details Customer information for this payment.
customer_presence Indicates whether the customer was present in your checkout flow during this payment.
description An arbitrary string attached to the object. Often useful for displaying to users.
id Unique identifier for the object.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
object String representing the object's type. Objects of the same type share the same value.
payment_method_details Information about the Payment Method debited for this payment.
payment_record ID of the Payment Record this Payment Attempt Record belongs to.
processor_details
reported_by Indicates who reported the payment.
shipping_details Shipping information for this payment.

Functions

list(params \\ %{}, opts \\ [])

@spec list(
  params :: %{
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:payment_record) => binary(),
    optional(:starting_after) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

List all the Payment Attempt Records attached to the specified Payment Record.

Details

Method: get
Path: /v1/payment_attempt_records

retrieve(id, params \\ %{}, opts \\ [])

@spec retrieve(
  id :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves a Payment Attempt Record with the given ID

Details

Method: get
Path: /v1/payment_attempt_records/{id}