Struct CustomerDisplay 

pub struct CustomerDisplay {
    pub display_amount: Option<CustomerDisplayDisplayAmount>,
    pub merchant_name: Option<CustomerDisplayMerchantName>,
    pub order_code: Option<CustomerDisplayOrderCode>,
}

Merchant-provided display data shown to the payer during checkout. All fields are informational only — stored and returned as-is, with no effect on payment processing, settlement, or validation.

JSON schema

{
 "title": "Customer Display",
 "description": "Merchant-provided display data shown to the payer during checkout. All fields are informational only — stored and returned as-is, with no effect on payment processing, settlement, or validation.",
 "examples": [
   {
     "displayAmount": {
       "amount": "1.37",
       "currency": "cad"
     },
     "merchantName": "Acme Store"
   }
 ],
 "type": "object",
 "properties": {
   "displayAmount": {
     "description": "The amount to present to the payer, which may differ from the authoritative settlement amount and asset. Commonly used when the payer's local currency differs from the settlement currency (e.g., charging in USD but displaying the equivalent in CAD). Stored and returned as-is — no cross-validation is performed against the authoritative `amount` and `asset`. Both `amount` and `currency` must be provided together.",
     "examples": [
       {
         "amount": "1.37",
         "currency": "cad"
       }
     ],
     "type": "object",
     "required": [
       "amount",
       "currency"
     ],
     "properties": {
       "amount": {
         "description": "The display amount as a decimal string (e.g., `\"1.37\"`).",
         "examples": [
           "1.37"
         ],
         "type": "string"
       },
       "currency": {
         "description": "An ISO 4217 currency code in lowercase for the display amount (e.g., `cad`, `usd`).",
         "examples": [
           "cad"
         ],
         "type": "string"
       }
     }
   },
   "merchantName": {
     "description": "The merchant name to display on the payment UI. When provided, this overrides the default name derived from the entity's profile. Useful when a merchant operates multiple storefronts or brands under a single entity.",
     "examples": [
       "Acme Store"
     ],
     "type": "string",
     "maxLength": 128
   },
   "orderCode": {
     "description": "A customer-visible code for the overall order. When omitted, CDP generates one and returns it. It must not contain personally identifiable information (PII) or payment credentials.",
     "examples": [
       "ORDER-ABC123"
     ],
     "type": "string",
     "maxLength": 128
   }
 }
}

Fields

display_amount: Option<CustomerDisplayDisplayAmount>

merchant_name: Option<CustomerDisplayMerchantName>

The merchant name to display on the payment UI. When provided, this overrides the default name derived from the entity’s profile. Useful when a merchant operates multiple storefronts or brands under a single entity.

order_code: Option<CustomerDisplayOrderCode>

A customer-visible code for the overall order. When omitted, CDP generates one and returns it. It must not contain personally identifiable information (PII) or payment credentials.

Implementations

impl CustomerDisplay

pub fn builder() -> CustomerDisplay

Trait Implementations

impl Clone for CustomerDisplay

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 CustomerDisplay

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

Formats the value using the given formatter.

impl Default for CustomerDisplay

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CustomerDisplay

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&CustomerDisplay> for CustomerDisplay

fn from(value: &CustomerDisplay) -> Self

Converts to this type from the input type.

impl From<CustomerDisplay> for CustomerDisplay

fn from(value: CustomerDisplay) -> Self

Converts to this type from the input type.

impl Serialize for CustomerDisplay

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CustomerDisplay> for CustomerDisplay

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.