Pass back functionality

  • Updated on

Pass Back mechanism allows passing specific buyer responses back to the publisher after the post. By default, these are Buyer Guid, Transaction ID and Sold=True/False parameters. Redirect URL and Buyer Raw Response fields are also supported and should be additionally configured.

When the lead is posted to a buyer, that buyer sends the response, including fields captured by PX. Pass Back functionality allows to pass these fields back to the publisher's form. This mechanism is synchronous: the form waits until PX replies with Pass Back fields (if received). Pass Back functionality affects conversion rate of the buyer and directly relates to publisher quality tracking.

To request Pass Back, publisher needs to insert PassBack="True" in the Lead. In this case, the following fields will be automatically passed back by default:

  • Buyer Guid - unique ID of the campaign in PX platform;
  • Transaction ID - unique ID of the transaction in PX;
  • Sold=True/False indicates whether or not the lead was sold to the buyer.

See how default parameters are passed back in a Simple Flow. You can also configure additional parameters and follow Extended Pass Back Flow.

Simple Pass Back Flow

The default Pass Back flow includes the following steps:

  1. Publisher inserts the lead to PX with a PassBack="True" parameter.
  2. PX processes the lead.
  3. The Lead is posted to a buyer.
  4. Buyer sends post response: success if he buys the lead or error if not.
  5. If the Lead is sold, PX returns Transaction ID, Sold=True and Buyer Guid parameters to the publisher.
  6. If the Lead is not sold, PX returns Transaction ID and Sold=False parameters to the publisher.

For now, Pass Back functionality is supported for XML and JSON  formats. 

If Publishers send their requests in HTTP format, the flow is a bit different.

XML Buyer Response Example

Here is XML code example when lead is sold:

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Result Value="BaeOK">
        <TransactionId>D956FAF6-6CB2-427B-A7AD-2C51715158F9</TransactionId>
        <TotalCount>1</TotalCount>
        <PassBack>
            <Sold>True</Sold>
            <BuyerGUID>4A6F8EF1-CA41-48B7-A5F2-F2C4A2949B1F</BuyerGUID>
        </PassBack>
    </Result>
</Response>

XML code example when lead is not sold:

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Result Value="BaeOK">
        <TransactionId>D956FAF6-6CB2-427B-A7AD-2C51715158F9</TransactionId>
        <TotalCount>1</TotalCount>
        <PassBack>
            <Sold>False</Sold>
        </PassBack>
    </Result>
</Response>

JSON Buyer Response Example

JSON code example when lead is sold:

{
    "Result": "BaeOK",
    "TransactionId": "8DF593E1-66CC-4F6C-B4FE-471108C86FAC",
    "TotalCount": "1",
    "PassBack": [{
        "Sold": "True",
        "BuyerGUID": "4A6F8EF1-CA41-48B7-A5F2-F2C4A2949B1F"
    }],}

JSON code example when lead is not sold :

{
    "Result": "BaeOK",
    "TransactionId": "2A21A972-1A5F-423B-9E79-B7375732FD29",
    "TotalCount": "1",
        "PassBack": [{
        "Sold": "False"
    }]
}

Pass Back and HTTP Format

Buyer responses cannot be passed back to the Publisher in HTTP format. However, publishers can insert specific data into their HTTP requests in order to receive passed back fields in XML or JSON format:

  • Insert &BaeReplyType=xml in the lead request to receive buyer response in XML format;
  • Insert &BaeReplyType=json in the lead request to receive buyer response in JSON format.

PX is not responsible for the wrong, fraud or offensive data passed back to the publisher because it is passed back transparently.

Related articles

0 comments

Please sign in to leave a comment.

Related articles