Element Types

Address Data Elements

The following structure details the Address object.

Address Data Elements

Address Elements Code Example

dictionary Address {
  optional String name;
  conditional String line1;
  optional String line2;
  optional String line3;
  conditional String city;
  conditional String state;
  required String zip;
  required String countryCode;
}

Transaction Options Data Elements

This structure represents the transaction configuration parameters specific to the payment transaction being requested by the Merchant.

Transaction Options Data Elements

Transaction Options Data Elements Code Example

dictionary TransactionOptions {
  optional String merchantCategoryCode;
  optional Enum billingPreference;
  optional Enum payloadTypeIndicator;
}

Transaction Value Data Elements

This structure represents the transaction value as split into its components. It is used in Checkout for display purposes and in Complete to submit a transaction for tokenization. For the Paze initial release, the only supported transactionCurrencyCode is “USD”.

Transaction Value Data Elements

Transaction Value Data Elements Code Example

dictionary TransactionValue {
  required String transactionCurrencyCode;
  required String transactionAmount;
}

Cobrand Elements

This structure details the Cobrand object.

Cobrand Data Elements

Cobrand Elements Code Example

dictionary Cobrand {
  required String cobrandName;
  optional Boolean benefitsOffered;
}

Enhanced Transaction Data Elements

This structure represents optional parameters specific to the payment transaction being requested by the Merchant. These parameters may impact fraud decisioning and will be retained to inform the Paze fraud risk decision engine.

Enhanced Transaction Data Elements

Enhanced Transaction Data Code Example

dictionary EnhancedTransactionData {
  optional EcomData ecomData;
  optional TravelData travelData;
}

Ecom Data Elements

This structure represents optional electronic commerce-related parameters within the Enhanced Transaction Data object.

Ecom Data Data Elements

Ecom Data Code Example

dictionary EcomData {
  optional Boolean cartContainsGiftCard;
  optional Boolean orderForPickup;
  optional String orderQuantity;
  optional String orderHighestCost;
  optional Address finalShippingAddress;
}

Travel Data Elements

This structure represents optional travel-related parameters within the Enhanced Transaction Data object.

Travel Data Data Elements

Travel Data Code Example

dictionary TravelData {
  optional String passengerName;
  optional Boolean roundTrip;
  optional String departureDate;
  optional String returnDate;
  optional Address departureLocation;
  optional Address returnLocation;
}

Client Data Elements

This structure details the client (Merchant) integrating with Paze.

Client Data Elements

Client Data Elements Code Example

dictionary Client {
  required String id;
  optional String name;
  optional String profileId;
}

Masked Card Data Elements

This structure details the non-sensitive masked token details.

Masked Card Data Elements

Masked Card Data Elements Code Example

dictionary MaskedCard {
  required String digitalCardId;
  required String panLastFour;
  required String paymentAccountReference;
  conditional String panExpirationMonth;
  conditional String panExpirationYear;
  required String paymentCardDescriptor;
  required Enum paymentCardType;
  required Enum paymentCardBrand;
  required Enum paymentCardNetwork;
  required DigitalCardData digitalCardData;
  conditional Address billingAddress;
}

Digital Card Data Elements

Digital Card Data contains digital card art for presentation. This structure details the Digital Card Data object.

Digital Card Data Elements

Digital Card Data Elements Code Example

dictionary DigitalCardData {
  required URL artUri;
  required Number artHeight;
  required Number artWidth;
}

Token Data Elements

This structure details the Token object.

Token Data Elements

Token Data Elements Code Example

dictionary Token {
  required String paymentToken;
  required String tokenExpirationMonth;
  required String tokenExpirationYear;
  required String paymentAccountReference;
}

Checkout Response Data Elements

This structure details the Checkout Response object.

Checkout Response Data Elements

Checkout Response Data Elements Code Example

dictionary CheckoutResponse {
  conditional String sessionId;
  required Consumer consumer;
  required MaskedCard maskedCard;
  conditional ShippingAddress shippingAddress;
}

Complete Response Data Elements

This structure details the Complete Response object.

Complete Response Data Elements

Complete Response Data Elements Code Example

dictionary completeResponse {
  required String payloadId;
  conditional String sessionId;
  conditional JWE<JWS<Payload>> securedPayload;
}

Secured Payload Data Elements

This section details the structure of the encrypted Payload object within the JWE claims. The JWEs must have their signatures validated before being decrypted.

Encrypted Signed Payload Data Elements

Secured Payload Data Elements Code Example

dictionary Payload {
  required String clientId;
  required String profileId;
  required Token token;
  required Enum paymentCardNetwork;
  required List<DynamicData> dynamicData;
  conditional Address billingAddress;
  required Consumer consumer;
  conditional String eci;
}

Dynamic Data Elements

This structure details the Dynamic Data object used for cryptographic verification during authorization.

Table 33. Dynamic Data Elements

Dynamic Data Elements Code Example

dictionary DynamicData {
  required String dynamicData;
  required Enum dynamicDataType;
  optional String dynamicDataExpiration;
}

Consumer Data Elements

This structure details the Consumer object.

Consumer Data Elements

Consumer Data Elements Code Example

dictionary Consumer {
  optional String firstName;
  optional String lastName;
  required String fullName;
  required String emailAddress;
  optional PhoneNumber mobileNumber;
  optional String countryCode;
  optional String languageCode;
}

Phone Number Data Elements

This structure details the Phone Number object.

Phone Number Data Elements

Phone Number Data Elements Code Example

dictionary PhoneNumber {
  required String countryCode;
  required String phoneNumber;
}

Shipping Address Data Elements

This structure details the Shipping Address object.

Shipping Address Data Elements

Shipping Address Data Elements Code Example

dictionary ShippingAddress {
  required String name;
  required String line1;
  optional String line2;
  optional String line3;
  required String city;
  required String state;
  required String zip;
  required String countryCode;
  optional DeliveryContactDetails deliveryContactDetails;
}

Delivery Contact Details Data Elements

This structure details the DeliveryContactDetails object.

Delivery Contact Details Data Elements

Delivery Contact Details Data Elements Code Example

dictionary DeliveryContactDetails {
  optional String contactFullName;
  optional PhoneNumber contactPhoneNumber;
}