Paypal.Subscription.Capture (Paypal v0.2.0)

Copy Markdown View Source

Response returned after capturing an authorized payment on a subscription.

Official PayPal API Documentation: Capture Authorized Payment on Subscription

Summary

Types

t()

Subscription capture response

Types

t()

@type t() :: %Paypal.Subscription.Capture{
  amount_with_breakdown: Paypal.Common.CurrencyValue.t() | nil,
  create_time: DateTime.t() | nil,
  id: String.t() | nil,
  links: [Paypal.Common.Link.t()],
  status: any() | nil,
  status_details: map() | nil,
  update_time: DateTime.t() | nil
}

Subscription capture response:

  • id - Capture ID.
  • status - Status of the capture (:completed, :declined, :pending, :failed).
  • status_details - Status details map if available.
  • amount_with_breakdown - Monetary amount with breakdown.
  • create_time - Date and time when the capture was created.
  • update_time - Date and time when the capture was last updated.
  • links - HATEOAS links.