Struct CreateRefundRequest 

pub struct CreateRefundRequest {
    pub amount: Option<String>,
    pub customer_display: Option<OperationCustomerDisplay>,
    pub external_reference_id: Option<ExternalReferenceId>,
    pub metadata: Option<Metadata>,
    pub reason: Option<String>,
    pub source: RefundSource,
}

A request to create a refund for a payment session.

JSON schema

{
 "description": "A request to create a refund for a payment session.",
 "examples": [
   {
     "amount": "0.50",
     "reason": "Customer returned the item.",
     "source": {
       "accountId": "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
       "asset": "usdc"
     }
   }
 ],
 "type": "object",
 "required": [
   "source"
 ],
 "properties": {
   "amount": {
     "description": "A decimal representation of the amount to refund, denominated in the session's `asset`. If omitted, the full remaining refundable amount is refunded.",
     "examples": [
       "0.50"
     ],
     "type": "string"
   },
   "customerDisplay": {
     "description": "Optional customer-facing display data for this refund, 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 refund, from the merchant's own system—not visible to the payer.",
     "examples": [
       "merchant-refund-abc123"
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/ExternalReferenceId"
       }
     ]
   },
   "metadata": {
     "$ref": "#/components/schemas/Metadata"
   },
   "reason": {
     "description": "The reason for the refund.",
     "examples": [
       "Customer returned the item."
     ],
     "type": "string"
   },
   "source": {
     "description": "The source from which to fund the refund. Can be a CDP account or an onchain address.",
     "examples": [
       {
         "accountId": "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
         "asset": "usdc"
       }
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/RefundSource"
       }
     ]
   }
 }
}

Fields

amount: Option<String>

A decimal representation of the amount to refund, denominated in the session’s asset. If omitted, the full remaining refundable amount is refunded.

customer_display: Option<OperationCustomerDisplay>

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

metadata: Option<Metadata>

reason: Option<String>

The reason for the refund.

source: RefundSource

The source from which to fund the refund. Can be a CDP account or an onchain address.

Implementations

impl CreateRefundRequest

pub fn builder() -> CreateRefundRequest

Trait Implementations

impl Clone for CreateRefundRequest

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 CreateRefundRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateRefundRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&CreateRefundRequest> for CreateRefundRequest

fn from(value: &CreateRefundRequest) -> Self

Converts to this type from the input type.

impl From<CreateRefundRequest> for CreateRefundRequest

fn from(value: CreateRefundRequest) -> Self

Converts to this type from the input type.

impl Serialize for CreateRefundRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CreateRefundRequest> for CreateRefundRequest

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.