Definition

export class UnifiedSetupConfig {
  integrationKey?: string;
  buyer?: UnifiedBuyer;
  loyaltyID?: string;
  storeNumber?: string;
  existingCardHolder?: boolean;
  cardholderTier?: string;
  env?: string;
  cardEnv?: string;
  clientVariable1?: string;
  clientVariable2?: string;
  clientVariable3?: string;
  clientVariable4?: string;
}

Field Name	Type	Description	Details/Example
integrationKey	string? Format: UUID	The apiKey provided to the client for using the sdk and related apis.	Not needed to be passed here if provided as part of the sdk script tag.
buyer	UnifiedBuyer?	Details about the customer navigating the eCommerce site.	Typically used for passing user info to perform Real-time Prescreen.
loyaltyID	string?	Brand's unique identifier for a customer enrolled in their loyalty program	Used to link acquisition/sign-up benefits back to brand loyalty program, if applicable.
storeNumber	string?	Internal ID representing the store of the purchase.	Usually set to a single value for all eCommerce. i.e. "99996"
existingCardHolder	boolean?	Set to indicate the customer is a known existing cardholder.	Default: false
cardholderTier	string?	Used to indicate a loyalty/program tier for a known cardholder, if applicable	"Elite"
env	string?	Environment indicator to be used for both placements and real-time prescreen	“PROD” \| “STAGE” Default: "PROD"
cardEnv	string?	Environment indicator specifically for Card products (as opposed to installments, etc), if different than env value.	“PROD” \| “STAGE” Default: env
clientVariable1	string?	Additional data to be passed into acquisition process, if needed.	Not commonly used
clientVariable2	string?	Additional data to be passed into acquisition process, if needed.	Not commonly used
clientVariable3	string?	Additional data to be passed into acquisition process, if needed.	Not commonly used
clientVariable4	string?	Additional data to be passed into acquisition process, if needed.	Not commonly used

Examples

const config: UnifiedSetupConfig = {
    loyaltyID: “xxxxxx”, //optional
    storeNumber: “1234567”,
    cardEnv: 'STAGE', // STAGE | PROD
};

BreadPayments.setup(config);

const config: UnifiedSetupConfig{
    loyaltyID: “xxxxxx”, 
    storeNumber: “1234567”,
    buyer: {
        givenName: "Jack",
        familyName: "Seamus",
        additionalName: "C.",
        birthDate: "1974-08-21",
        email: "[email protected]",
        phone: "+13235323423",
        billingAddress: {
            address1: "323 somethibng lane",
            address2: "apt. B",
            country: "US",
            locality: "NYC",
            region: "NY",
            postalCode: "11222",
        },
        shippingAddress: {
            address1: "323 something lane",
            address2: "apt. B",
            country: "US",
            locality: "NYC",
            region: "NY",
            postalCode: "11222",
        },
    }
};

window.BreadPayments.setup(config);

UnifiedBuyer
UnifiedAddress

Definition

Examples

Related