Struct CaptureAuthorizedPaymentDto

pub struct CaptureAuthorizedPaymentDto {
    pub invoice_id: Option<String>,
    pub note_to_payer: Option<String>,
    pub amount: Option<Money>,
    pub is_final_capture: Option<bool>,
    pub payment_instruction: Option<PaymentInstruction>,
    pub soft_descriptor: Option<String>,
}

Fields

invoice_id: Option<String>

The API caller-provided external invoice number for this order. Appears in both the payer’s transaction history and the emails that the payer receives.

note_to_payer: Option<String>

An informational note about this settlement. Appears in both the payer’s transaction history and the emails that the payer receives.

amount: Option<Money>

The amount to capture. To capture a portion of the full authorized amount, specify an amount. If amount is not specified, the full authorized amount is captured. The amount must be a positive number and in the same currency as the authorization against which the payment is being captured.

is_final_capture: Option<bool>

Indicates whether you can make additional captures against the authorized payment. Set to true if you do not intend to capture additional payments against the authorization. Set to false if you intend to capture additional payments against the authorization.

payment_instruction: Option<PaymentInstruction>

Any additional payment instructions to be considered during payment processing. This processing instruction is applicable for Capturing an order or Authorizing an Order.

soft_descriptor: Option<String>

The payment descriptor on the payer’s account statement.

Implementations

impl CaptureAuthorizedPaymentDto

pub fn new() -> Self

pub fn invoice_id(self, invoice_id: String) -> Self

pub fn note_to_payer(self, note_to_payer: String) -> Self

pub fn amount(self, amount: Money) -> Self

pub const fn is_final_capture(self, is_final_capture: bool) -> Self

pub fn payment_instruction( self, payment_instruction: PaymentInstruction, ) -> Self

pub fn soft_descriptor(self, soft_descriptor: String) -> Self

Trait Implementations

impl Clone for CaptureAuthorizedPaymentDto

fn clone(&self) -> CaptureAuthorizedPaymentDto

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CaptureAuthorizedPaymentDto

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CaptureAuthorizedPaymentDto

fn default() -> CaptureAuthorizedPaymentDto

Returns the “default value” for a type.

impl Serialize for CaptureAuthorizedPaymentDto

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.