Struct CreateVoidRequest 

pub struct CreateVoidRequest {
    pub customer_display: Option<OperationCustomerDisplay>,
    pub external_reference_id: Option<ExternalReferenceId>,
    pub metadata: Option<Metadata>,
}

A request to create a void for a payment session. A void releases all remaining capturable funds back to the payer, including after partial refunds as long as a capturableAmount remains.

JSON schema

{
 "description": "A request to create a void for a payment session. A void releases all remaining capturable funds back to the payer, including after partial refunds as long as a capturableAmount remains.",
 "type": "object",
 "properties": {
   "customerDisplay": {
     "description": "Optional customer-facing display data for this void, 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 void, from the merchant's own system—not visible to the payer.",
     "examples": [
       "merchant-void-abc123"
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/ExternalReferenceId"
       }
     ]
   },
   "metadata": {
     "$ref": "#/components/schemas/Metadata"
   }
 }
}

Fields

customer_display: Option<OperationCustomerDisplay>

Optional customer-facing display data for this void, 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 void, from the merchant’s own system—not visible to the payer.

metadata: Option<Metadata>

Implementations

impl CreateVoidRequest

pub fn builder() -> CreateVoidRequest

Trait Implementations

impl Clone for CreateVoidRequest

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 CreateVoidRequest

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

Formats the value using the given formatter.

impl Default for CreateVoidRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateVoidRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&CreateVoidRequest> for CreateVoidRequest

fn from(value: &CreateVoidRequest) -> Self

Converts to this type from the input type.

impl From<CreateVoidRequest> for CreateVoidRequest

fn from(value: CreateVoidRequest) -> Self

Converts to this type from the input type.

impl Serialize for CreateVoidRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CreateVoidRequest> for CreateVoidRequest

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.