Struct Void 

pub struct Void {
    pub amount: Option<String>,
    pub created_at: Option<DateTime<Utc>>,
    pub customer_display: Option<OperationCustomerDisplay>,
    pub error: Option<PaymentError>,
    pub external_reference_id: Option<ExternalReferenceId>,
    pub metadata: Option<Metadata>,
    pub onchain_transactions: Vec<OnchainTransaction>,
    pub payment_session_id: Option<PaymentSessionId>,
    pub status: Option<PaymentActionStatus>,
    pub updated_at: Option<DateTime<Utc>>,
    pub void_id: Option<VoidId>,
}

A release of uncaptured authorized funds back to the payer. Voids release all remaining capturable funds in a single operation, including after partial refunds as long as a capturableAmount remains.

JSON schema

{
 "description": "A release of uncaptured authorized funds back to the payer. Voids release all remaining capturable funds in a single operation, including after partial refunds as long as a capturableAmount remains.",
 "examples": [
   {
     "amount": "1.00",
     "createdAt": "2025-06-15T12:30:00.000Z",
     "metadata": {
       "customer_id": "cust_12345"
     },
     "onchainTransactions": [
       {
         "network": "base",
         "transactionHash": "0x789012345678901234567890abcdef1234567890abcdef1234567890abcdef12"
       }
     ],
     "paymentSessionId": "paymentSession_82c879c1-84e1-44ed-a8c2-1ac239cf09ad",
     "status": "succeeded",
     "updatedAt": "2025-06-15T12:31:00.000Z",
     "voidId": "void_82c879c1-84e1-44ed-a8c2-1ac239cf09ad"
   }
 ],
 "type": "object",
 "properties": {
   "amount": {
     "description": "A decimal representation of the voided amount, denominated in the session's `asset`.",
     "examples": [
       "1.00"
     ],
     "type": "string"
   },
   "createdAt": {
     "description": "The UTC ISO 8601 timestamp at which the void was created.",
     "examples": [
       "2025-06-15T12:30:00.000Z"
     ],
     "type": "string",
     "format": "date-time"
   },
   "customerDisplay": {
     "description": "Customer-facing display data for this void, shown to the payer. Present when supplied on the create void request or when the session's `orderCode` fallback applies; otherwise omitted.",
     "allOf": [
       {
         "$ref": "#/components/schemas/OperationCustomerDisplay"
       }
     ]
   },
   "error": {
     "$ref": "#/components/schemas/PaymentError"
   },
   "externalReferenceId": {
     "description": "A merchant-provided internal identifier for this void, from the merchant's own system—not visible to the payer. Present only when supplied on the create void request.",
     "examples": [
       "merchant-void-abc123"
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/ExternalReferenceId"
       }
     ]
   },
   "metadata": {
     "$ref": "#/components/schemas/Metadata"
   },
   "onchainTransactions": {
     "description": "The onchain transactions associated with this void.",
     "examples": [
       [
         {
           "network": "base",
           "transactionHash": "0x789012345678901234567890abcdef1234567890abcdef1234567890abcdef12"
         }
       ]
     ],
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/OnchainTransaction"
     }
   },
   "paymentSessionId": {
     "description": "The ID of the payment session this void belongs to.",
     "examples": [
       "paymentSession_82c879c1-84e1-44ed-a8c2-1ac239cf09ad"
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/PaymentSessionId"
       }
     ]
   },
   "status": {
     "description": "The current status of the void.",
     "examples": [
       "pending"
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/PaymentActionStatus"
       }
     ]
   },
   "updatedAt": {
     "description": "The UTC ISO 8601 timestamp at which the void was last updated.",
     "examples": [
       "2025-06-15T12:31:00.000Z"
     ],
     "type": "string",
     "format": "date-time"
   },
   "voidId": {
     "description": "The unique identifier of the void.",
     "examples": [
       "void_82c879c1-84e1-44ed-a8c2-1ac239cf09ad"
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/VoidId"
       }
     ]
   }
 }
}

Fields

amount: Option<String>

A decimal representation of the voided amount, denominated in the session’s asset.

created_at: Option<DateTime<Utc>>

The UTC ISO 8601 timestamp at which the void was created.

customer_display: Option<OperationCustomerDisplay>

Customer-facing display data for this void, shown to the payer. Present when supplied on the create void request or when the session’s orderCode fallback applies; otherwise omitted.

error: Option<PaymentError>

external_reference_id: Option<ExternalReferenceId>

A merchant-provided internal identifier for this void, from the merchant’s own system—not visible to the payer. Present only when supplied on the create void request.

metadata: Option<Metadata>

onchain_transactions: Vec<OnchainTransaction>

The onchain transactions associated with this void.

payment_session_id: Option<PaymentSessionId>

The ID of the payment session this void belongs to.

status: Option<PaymentActionStatus>

The current status of the void.

updated_at: Option<DateTime<Utc>>

The UTC ISO 8601 timestamp at which the void was last updated.

void_id: Option<VoidId>

The unique identifier of the void.

Implementations

impl Void

pub fn builder() -> Void

Trait Implementations

impl Clone for Void

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 Void

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

Formats the value using the given formatter.

impl Default for Void

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Void

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Void> for Void

fn from(value: &Void) -> Self

Converts to this type from the input type.

impl From<Void> for Void

fn from(value: Void) -> Self

Converts to this type from the input type.

impl Serialize for Void

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Void> for Void

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.