Struct CreateCaptureRequest 

pub struct CreateCaptureRequest {
    pub amount: Option<String>,
    pub customer_display: Option<OperationCustomerDisplay>,
    pub external_reference_id: Option<ExternalReferenceId>,
    pub final_capture: bool,
    pub metadata: Option<Metadata>,
}

A request to create a capture for a payment session.

JSON schema

{
 "description": "A request to create a capture for a payment session.",
 "examples": [
   {
     "amount": "1.00",
     "finalCapture": true
   }
 ],
 "type": "object",
 "required": [
   "finalCapture"
 ],
 "properties": {
   "amount": {
     "description": "A decimal representation of the amount to capture, denominated in the session's `asset`. If omitted, the full remaining capturable amount is captured.",
     "examples": [
       "1.00"
     ],
     "type": "string"
   },
   "customerDisplay": {
     "description": "Optional customer-facing display data for this manual capture, shown to the payer. Falls back to the session's `orderCode` when `referenceCode` is omitted.",
     "examples": [
       {
         "referenceCode": "REF-ABC123"
       }
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/OperationCustomerDisplay"
       }
     ]
   },
   "externalReferenceId": {
     "description": "An optional merchant-provided internal identifier for this manual capture, from the merchant's own system—not visible to the payer.",
     "examples": [
       "merchant-capture-abc123"
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/ExternalReferenceId"
       }
     ]
   },
   "finalCapture": {
     "description": "When `true`, this capture is treated as the final one for the authorization. Any remaining capturable balance is released back to the payer immediately after the capture settles. When `false`, the remaining capturable balance stays held and is available for subsequent partial captures (subject to `captureExpiresAt`). Has no effect if `amount` equals the full capturable balance, since no remaining balance exists to release.",
     "examples": [
       true
     ],
     "type": "boolean"
   },
   "metadata": {
     "$ref": "#/components/schemas/Metadata"
   }
 }
}

Fields

amount: Option<String>

A decimal representation of the amount to capture, denominated in the session’s asset. If omitted, the full remaining capturable amount is captured.

customer_display: Option<OperationCustomerDisplay>

Optional customer-facing display data for this manual capture, shown to the payer. Falls back to the session’s orderCode when referenceCode is omitted.

external_reference_id: Option<ExternalReferenceId>

An optional merchant-provided internal identifier for this manual capture, from the merchant’s own system—not visible to the payer.

final_capture: bool

When true, this capture is treated as the final one for the authorization. Any remaining capturable balance is released back to the payer immediately after the capture settles. When false, the remaining capturable balance stays held and is available for subsequent partial captures (subject to captureExpiresAt). Has no effect if amount equals the full capturable balance, since no remaining balance exists to release.

metadata: Option<Metadata>

Implementations

impl CreateCaptureRequest

pub fn builder() -> CreateCaptureRequest

Trait Implementations

impl Clone for CreateCaptureRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCaptureRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateCaptureRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&CreateCaptureRequest> for CreateCaptureRequest

fn from(value: &CreateCaptureRequest) -> Self

Converts to this type from the input type.

impl From<CreateCaptureRequest> for CreateCaptureRequest

fn from(value: CreateCaptureRequest) -> Self

Converts to this type from the input type.

impl Serialize for CreateCaptureRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CreateCaptureRequest> for CreateCaptureRequest

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: CreateCaptureRequest) -> Result<Self, ConversionError>

Performs the conversion.