Event capture

As an alternative to the notifications, you can configure your ecosystem to "listen to", i.e. receive, transaction-related events generated by the Cashier. This might be necessary for implementing your own business logic when BridgerPay cannot control the redirection.
Events
Consult the Cashier or server-side deposit flow diagram for better understanding the sequence of the events.
Session created: the API has created or failed to create a Cashier session.
[bp]:create-session  //or
[bp][cashier:{{cashierKey}}]:create-session
{
  type: 'success' | 'failure',
  bearerToken?: [string]
}
Cashier widget shown: a Cashier widget has been shown to a shopper.
[bp]:contentRendered  //or
[bp][cashier:{{cashierKey}}]:contentRendered
Deposit processed: the shopper's request to make a deposit has been processed. This might be approved or declined, or the PSP might request to enter a security code to confirm the deposit (3D Secure). In the latter case, the event will happen at the end of the workflow.
[bp]:deposit  //or
[bp][cashier:{{cashierKey}}]:deposit
{
  type: 'approved' | 'declined' | 'pending'
}
Shopper redirected: the shopper has been redirected to the appropriate page to see the result of their transaction.
[bp]:redirect  //or
[bp][cashier:{{cashierKey}}]:redirect
{
  url: [string]
}
Implementation
If a Cashier scheme is integrated as a script embedded in your website, include the following piece of code to listen to all the event.
window.addEventListener(
  '[bp]:all', 
  ({ detail }) => console.log('[bp]:all', detail)
);
Or, include the following one to listen to a particular event (e.g. "Session created").
window.addEventListener(
  '[bp]:create-session', 
  ({ detail: { type, bearerToken } }) => console.log(
      '[bp]:create-session', 
      type, 
      bearerToken
  )
);
If a Cashier scheme is integrated as an iFrame placed on an arbitrary web resource, include the following piece of code to listen to the events.
window.addEventListener(
	'message', 
	({ data: { event, url }}) => {
		if (!event || !event.includes('[bp]'))
			return;
		if (event === '[bp]:redirect')
			window.location.href = url;
	}
);

Reporting - Previous

Notifications

Next - Reporting

Merchant Admin: Transactions, Payouts

Last modified 9mo ago

Copy link

Outline

Events

Implementation