Paypal.Payment.Captured (Paypal v0.1.0)

View Source

The returned information after performing a capture of an authorized order.

Summary

Types

t()

The information about the captured order is the following one

Types

t()

@type t() :: %Paypal.Payment.Captured{
  amount: Paypal.Common.CurrencyValue.t() | nil,
  create_time: DateTime.t() | nil,
  custom_id: String.t() | nil,
  disbursement_mode: any() | nil,
  final_capture: boolean() | nil,
  id: String.t() | nil,
  invoice_id: String.t() | nil,
  links: [Paypal.Common.Link.t()],
  status: any() | nil,
  status_details: map() | nil,
  update_time: DateTime.t() | nil
}

The information about the captured order is the following one:

  • id for the authorized order.
  • invoice_id (optional) is the provided invoice ID provided when the order was created or authorized.
  • custom_id (optional) is the provided custom ID when the order was created or authorized.
  • final_capture it's about a fraction of the order to be paid.
  • links are the links about the following possible options (HATEOAS).
  • status for the authorized order.
  • status_details is a string defining the status for the authorized order.
  • disbursement_mode
  • amount is the price for the order to be paid.
  • create_time (optional) is the time when the authorized order was created.
  • update_time (optional) is the time when the authorized order was updated.