Merchant Fields
Merchant Field Attributes are optional fields within the orderInfo schema used for web integrations. These fields allow merchants to pass additional merchant-specific data as part of the order payload.
Please Note:
Merchant Fields are optional unless explicitly required for a specific integration. If Merchant Fields are required for your specific integration type, your Flex Pay Integration Lead will notify you while working through the implementation process.
Common Use Cases
A partner operates multiple websites, brands, or properties under a single integration or UPC
Specific reporting or analytics is desired
Promotional financing campaigns need to target specific properties or brands under a one UPC to many configuration
Transactions need to be associated with a parent merchant and sub-property structure
There is a need for brand specific Flex Pay customer communications
Example orderInfo Object
orderInfo = {
travelers: [{ /* travelers object */}],
hotel_reservations: [{/* hotel_reservations object */}],
add_ons: [{/* add_ons object */}],
order_amount: 99900,
merchant: "Property Name or Brand Name"
merchant_field_1: "Parent Company Name"
merchant_field_2: "Property Name or Brand Name" Merchant Field Definitions
Examples
Air
{
"merchant": "Flex Pay Airlines"
"merchant_field_1": "Upgrade Air",
"merchant_field_2": "Flex Pay Airlines "Hotel
{
"merchant": "Flex Pay Bahamas Hotel"
"merchant_field_1": "Upgrade Resorts",
"merchant_field_2": "Flex Pay Bahamas Hotel"Cruise
{
"merchant": "Flex Pay Cruise Line "
"merchant_field_1": "Upgrade Cruise Platform",
"merchant_field_2": "Flex Pay Cruise Line "Retail
{
"merchant": "Upgrade Store "
"merchant_field_1": "Flex Pay Payments",
"merchant_field_2": "Upgrade Store "In the above examples:
merchant identifies the brand
merchant_field_1 identifies the parent company or platform name
merchant_field_2 identifies the individual brand name
Best Practices
When working with Merchant Fields, there are a few best practices Flex Pay recommends:
Use consistent naming conventions across all transactions
Avoid sending inconsistent values and ensure format is a String
Validate property and brand names match your business internal reporting standards