Add Cross Brand

Add Partner Brand

Description¶

The addCrossBrand endpoint is used to create a Partner Brand rule within the Loyalty Rewards Program. This rule establishes a relationship between the primary brand and one or more partner brands, enabling loyalty points to be earned or redeemed across brand boundaries.

Endpoint¶
/ui/v1/addCrossBrand
Method¶
POST
Header¶

Content-Type: application/json
Authorization: $TOKEN

Note

Replace $TOKEN in the request with the base64-encoded username/password combination in the format username:password.

Given a username of username and a password of password, the request header would appear as follows:

Content-Type: application/json
Authorization: dXNlcm5hbWU6cGFzc3dvcmQ=

Request Body (Add)¶

{
    "id": 0,
    "crossBrandStatus": {
        "name": "ACTIVE"
    },
    "createdUserId": "642",
    "flatTransferFees": {
        "amount": "30.00",
        "currency": {
            "currencyCode": "USD"
        }
    },
    "transferFeesPerPoint": {
        "amount": "",
        "currency": {
            "currencyCode": "USD"
        }
    },
    "maxTransferFees": {
        "amount": "",
        "currency": {
            "currencyCode": "USD"
        }
    },
    "transferFeesRadioButton": "FLAT_TRANSFER_FEES",
    "merchantId": "42",
    "crossBrandName": "ABC Company",
    "rewardsProgramName": "ABC Rewards",
    "merchantBrandPoints": "2",
    "crossBrandPoints": "3"
}

Response¶

{
    "id": 2,
    "createdDateTime": null,
    "lastUpdatedDateTime": null,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "createdUserId": 642,
    "lastModifiedUserId": null,
    "crossBrandName": "ABC Company",
    "rewardsProgramName": "ABC Rewards",
    "merchantBrandPoints": 2,
    "crossBrandPoints": 3,
    "crossBrandStatus": {
        "value": "Active",
        "name": "ACTIVE"
    },
    "minimumTransferPoints": null,
    "maxTransferPointsPerYear": null,
    "flatTransferFees": {
        "amount": 30,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1733858673000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "transferFeesPerPoint": {
        "amount": null,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1733858673000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "maxTransferFees": {
        "amount": null,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1733858673000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "payFeeWithPoints": null,
    "merchantId": 42,
    "createdUserName": null,
    "message": {
        "code": "54",
        "type": {
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "CROSS_BRAND_CREATION_SUCCESS",
        "parameters": [
            {
                "name": "PARTNER_BRAND_NAME",
                "value": "ABC Company"
            }
        ]
    }
}

Updated As Of Version 6.6.x