BB_logo

tab_left
tab_right
Report purchase by referral to the ecommerce site listener

This report is used to notify your site that a b-buzzy transaction was made. In addition, you can use this API to notify your site that the 'return period' is over for a specific purchase.

The first step of the integration is to open a B-buzzy sandbox account. If you don't have an account click here.

The sandbox is a full feature B-buzzy service that doesn't create real transaction.

Prior production deployment, please check the integration with our sandbox.

When working with the sandbox environment, use sandbox.b-buzzy.com as the domain. When working with the production environment, use b-buzzy.com as the domain.


This report by B-buzzy is optional, and depends on the 'Report each transaction to seller's listener' parameter on the profile page.

If this parameter is 'checked' than after each transaction throgh B-buzzy, B-buzzy will notify your system about it (1).

In addition, B-buzzy can make a report after the return period is over (the 'Return Policy Period' parameter on the profile page).
If you want this report, than the 'Report After Return Policy Period' parameter on the profile page must be 'checked' (2).

The report must be made to a predetermined URL that is managed on the 'Seller's Transaction Listener URL' field on the profile page.

An independent report will be made for each product purchased through the system.

The report will be done by a secure http request (https) with the following POST NVP parameters:

Parameter nameDetails
bbuzzy_sellerIdThe Id provided by B-buzzy
methodFor report after transaction (1) - 'report_user_transaction_purchase' .
For report after the return period is over (2) - 'transaction_after_return_period_is_over' .
For report after the a purchase cancellation (3) - 'report_user_transaction_cancellation' .
bbuzzyTransactionIdB-buzzy's transaction id for this report
bbuzzyTransactionTimeGMT time when the transaction was reported to B-buzzy
Format: 'Y-m-d H:i:s'
Example: 2010-11-25 19:23:28
buyerTransactionIdThe ecommerce site transaction id of the buyer that was referred
recommenderTransactionIdThe ecommerce site transaction id of the user made the referral
productIdThe ecommerce site product id of the product purchased
productPriceThe price of the product for a single unit
priceCurrencyThe transaction currency
productQuantityThe quantity of the transaction
productTotalPriceQuantity * price per unit of the transaction
totalAffiliationPercentageThe total percentage of the compensation
buyerCommissionPercentageThe buyer compensation percentage part
recommenderCommissionPercentageThe recommender compensation percentage part
bbuzzyCommissionPercentageB-buzzy's compensation percentage part
buyerCommissionSumThe buyer compensation sum for the transaction
recommenderCommissionSumThe recommender compensation sum for the transaction
bbuzzyCommissionSumB-buzzy's compensation sum for the transaction
compensationTypeThe type of compensation according to seller's profile
From on of the options:
bbuzzy_cash_back, seller_cash_back, next_purchase_rebate
cancellationReasonWhen reporting method "report_user_transaction_cancellation" - the cancellation reason.
cancelRemarkWhen reporting method "report_user_transaction_cancellation" - the cancellation reason.
cancelSourceWhen reporting method "report_user_transaction_cancellation" - the cancellation source:
"cancel_purchase_api" or "seller_transactions_screen"
cancelTimeWhen reporting method "report_user_transaction_cancellation" - GMT time when the transaction was cancelled.
Format: 'Y-m-d H:i:s'
Example: 2010-11-25 19:23:28


The response of the request must be an XML file as follows:

<?xml version="1.0" encoding="UTF-8"?>
<message>
<bbuzzyTransactionId>123abc</bbuzzyTransactionId>
<response>saved</response>
</message>

Unless the desired response will be received ('saved' on the 'response' tag), B-buzzy will continue to try to report the transaction in varying time intervals.

The report details can be seen here .






© 2019 B-buzzy Systems Ltd. All Rights Reserved.