Paypal.Payment.RefundRequest (Paypal v0.1.0)

View Source

Request object that Refunds a captured payment, by ID. For a full refund, include an empty request body. For a partial refund, include an amount object in the request body.

Fields

  • amount - The currency and amount for a financial transaction, such as a balance or payment due.
  • custom_id - The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions.
  • invoice_id - The API caller-provided external invoice ID for this order.
  • note_to_payer - The reason for the refund. Appears in both the payer's transaction history and the emails that the payer receives.
  • payment_instruction - Any additional payments instructions during refund payment processing.

Summary

Types

t()

@type t() :: %Paypal.Payment.RefundRequest{
  amount: Paypal.Common.CurrencyValue.t() | nil,
  custom_id: String.t() | nil,
  invoice_id: String.t() | nil,
  note_to_payer: String.t() | nil,
  payment_instruction: map() | nil
}