Last updated
These docs are intended for a developer audience.Dismiss

Define lead source data

This topic describes how to define lead source data when creating a payment token in Rebilly using the FramePay JavaScript library. For more information about lead source attribution, see Lead source attribution.

To define lead source information, use the extraData parameter of the createToken method when creating a payment token to specify the lead source attributes directly in the token creation request.

Example:

var extraData = {
    leadSource: {
        content: 'buylink',
        medium: 'affiliate',
        source: 'affiliate-website.com',
        campaign: 'affiliate-campaign',
        affiliate: 'af12345'
    }
};
Framepay.createToken(form, extraData);

Deactivate lead source attribution

To deactivate lead source attribution in FramePay, provide an empty object to the extraData option when creating a token. This prevents Rebilly from collecting any lead source data.

To deactivate lead source attribution in Rebilly Instruments, see Features configuration properties.

var extraData = {
    leadSource: {}
};
Framepay.createToken(form, extraData);

To view all accepted lead source parameters, see createToken documentation.