Notification Callbacks

Bill & Pay has the ability to make outbound HTTP requests to other servers to notify the other server of events within Bill & Pay. To add a notification callback go to the Biller Control Panel / Advanced Options / Dev Tools / Edit Event Notifications and click the "Add New Event Notification" button. On the Event Notification page you should select which events will get sent with this notification and what URL to send notifications to. You can use a single URL for all event notifications or a separate URL for each event by adding multiple event notifications.

Event Notification Body

The body of the event notification POSTed to the URL you specify has the following format:

<?xml version=\"1.0\" ?>
<notification>
  <biller>
    <internalid>xxxx</internalid>
  </biller>
  <event>
    <type>xxxx</type>
    <content>xxxx</content>
  </event>
</notification>

The <biller><internalid> will be the ID number of the biller the event notification is being sent for.

The call may have one or more <event> elements in it depending on how many events there are waiting to send notifications for.

The <event><type> field will contain one of the following:

transactionprocessed

transactionposted

payerenrolled

autopaychanged

customerchanged

The <event><content> field will contain the detail of the event you are being notified of.

Transaction Processed Event Content

This event is called as soon as a transaction has been processed through the payment gateway. The <event><content> field will have the following form when the <event><type> is transaction_processed:

<transactionid>xxxx</transactionid>

This transactionid can then be passed in the <where><internalid> field of a call to transactioninfo of the biller class to retreive all of the information about the transaction.

Transaction Posted Event Content

This event is called as soon as a transaction has been posted to the accounting software of the biller. It has the same format as the Transaction Processed Event.