Skip to content

Overview

Notifications are event objects pushed to the merchant server, by posting to the merchant’s notification URL. A notification indicates changes to the object referenced in the event, such as changes to the transaction status (authorized, canceled, denied).

An Event Notification is a HTTPS POST to an endpoint you provide to PayWithMyBank. There is an Authorization header that can be used to verify the authenticity of the notification. The content of the POST will be a x-www-form-urlencoded string. For example:

1
merchantId=1002463580&merchantReference=123123&paymentType=2&transactionType=1&eventId=1002622668&eventType=Establish&objectId=1002622667&objectType=Transaction&message=establishTransaction&timeZone=Etc%2FUTC&createdAt=1557257165441&accessId=M8RaHgEjBE54zuFYMRQq&status=0&statusMessage=New

An Event Notification contains an eventType and a statusMessage (among other fields). These events can then be used to update transaction statuses in your system.

For more information on handling Event Notifications, refer to the Event Notification API Reference.

Common failure scenarios

Common failure scenarios are outlined in the table below.

Transaction Status Payment Provider Transaction Status Error Code Description Action to Take Suggested User Messaging
Failed SW057 326 Expired split token See Refresh a Bank Authorization using Online Banking. None
Failed SW051 380 Invalid / corrupt split token See Refresh a Bank Authorization using Online Banking. None
Failed SW056 330 Invalid account Remove the bank account from the Users profile in your system. Prompt the User to add another method of payment. Sorry, we are unable to process your request at this time. Please choose a different payment method.
Failed SW054 390 Fraud analysis. Remove the bank account from the Users profile in your system. Prompt the User to add another method of payment. Sorry, we are unable to process your request at this time. Please choose a different payment method.
Failed SW055 390 Fraud analysis (Negative Data). Remove the bank account from the Users profile in your system. Prompt the User to add another method of payment. Sorry, we are unable to process your request at this time. Please choose a different payment method.
Failed SW052 378 Internal error or bank request error Show the suggested User message on the payment method page and allow the User to try the payment again. Sorry, we are unable to process your request at this time. Please choose a different payment method.
Denied SW021 331 Not enough balance Show the suggested User message on the payment method page and allow the User to use another method of payment. Your account can not be used for payment at this time. Please select another method of payment to continue.

Sample Event Notifications

Authorization

New

1
merchantId=1002463580&merchantReference=123123&paymentType=2&transactionType=1&eventId=1003313733&eventType=Establish&objectId=1003313732&objectType=Transaction&message=establishTransaction&timeZone=Etc%2FUTC&createdAt=1571866046896&status=0&statusMessage=New

Pending

1
merchantId=1002463580&merchantReference=123123&paymentType=2&transactionType=1&eventId=1003313737&eventType=Update&objectId=1003313732&objectType=Transaction&message=setPaymentProvider&timeZone=Etc%2FUTC&createdAt=1571866050518&fiCode=200005501&fiName=Demo+Bank&status=1&statusMessage=Pending

Authorized

1
merchantId=1002463580&merchantReference=123123&paymentType=2&transactionType=1&eventId=1003313761&eventType=Authorize&objectId=1003313732&objectType=Transaction&message=&timeZone=Etc%2FUTC&createdAt=1571866059485&fiCode=200005501&status=2&statusMessage=Authorized&splitToken=CPnBktTfLRABGGAgACowccGjSjoPgwsZiEYTehhASji2VJHYXXITNH1ZA9ORiIWhdD8i1eudNQHcZ%2FRDhDXc

Capture

Pending

1
merchantId=1002463580&merchantReference=24637605-114e-4986-8d4d-da0d6c01fa63&paymentType=2&transactionType=3&eventId=1003313816&eventType=Establish&objectId=1003313815&objectType=Transaction&message=Awaiting+account+balance+refresh&timeZone=Etc%2FUTC&createdAt=1571867424088&paymentProviderTransaction.status=SW010&paymentProviderTransaction.statusMessage=Established&status=1&statusMessage=Pending

Authorized

1
merchantId=1002463580&merchantReference=24637605-114e-4986-8d4d-da0d6c01fa63&paymentType=2&transactionType=3&eventId=1003313830&eventType=Authorize&objectId=1003313815&objectType=Transaction&message=&timeZone=Etc%2FUTC&createdAt=1571867425337&paymentProviderTransaction.status=AC100&paymentProviderTransaction.statusMessage=Pending&status=2&statusMessage=Authorized

Processed

1
merchantId=1002463580&merchantReference=24637605-114e-4986-8d4d-da0d6c01fa63&paymentType=2&transactionType=3&eventId=1003313836&eventType=Process&objectId=1003313815&objectType=Transaction&message=Fast+forwarded+guaranteed+transaction&timeZone=Etc%2FUTC&createdAt=1571867425625&paymentProviderTransaction.status=AC118&paymentProviderTransaction.statusMessage=Settled&status=3&statusMessage=Processed

Completed

1
merchantId=1002463580&merchantReference=24637605-114e-4986-8d4d-da0d6c01fa63&paymentType=2&transactionType=3&eventId=1003313842&eventType=Complete&objectId=1003313815&objectType=Transaction&message=Fast+forwarded+guaranteed+transaction&timeZone=Etc%2FUTC&createdAt=1571867425836&paymentProviderTransaction.status=AC118&paymentProviderTransaction.statusMessage=Settled&status=4&statusMessage=Completed

Refund

Authorized

1
merchantId=1003185344&merchantReference=ac78a1b9-dcd3-47b5-a9d7-a300a2a0a16e&paymentType=2&transactionType=4&eventId=1003323133&eventType=Authorize&objectId=1003323132&objectType=Transaction&message=&timeZone=Etc%2FUTC&createdAt=1572044185776&paymentProviderTransaction.status=AC100&paymentProviderTransaction.statusMessage=Pending&status=2&statusMessage=Authorized

Processed

1
merchantId=1003185344&merchantReference=ac78a1b9-dcd3-47b5-a9d7-a300a2a0a16e&paymentType=2&transactionType=4&eventId=1003323230&eventType=Process&objectId=1003323132&objectType=Transaction&message=Processed+by+user+vivyan.ngo%40trustly.com&timeZone=Etc%2FUTC&createdAt=1572044748415&paymentProviderTransaction.status=AC105&paymentProviderTransaction.statusMessage=Processed&status=3&statusMessage=Processed

Completed

1
merchantId=1003185344&merchantReference=ac78a1b9-dcd3-47b5-a9d7-a300a2a0a16e&paymentType=2&transactionType=4&eventId=1003323236&eventType=Complete&objectId=1003323132&objectType=Transaction&message=Completed+by+user+vivyan.ngo%40trustly.com&timeZone=Etc%2FUTC&createdAt=1572044755981&paymentProviderTransaction.status=AC105&paymentProviderTransaction.statusMessage=Processed&status=4&statusMessage=Completed

Deposit

Authorized

1
merchantId=1003185344&merchantReference=13c3f5c5-b521-4c59-a003-ab71ecfa0044&paymentType=2&transactionType=6&eventId=1003323243&eventType=Authorize&objectId=1003323242&objectType=Transaction&message=&timeZone=Etc%2FUTC&createdAt=1572044960238&paymentProviderTransaction.status=AC100&paymentProviderTransaction.statusMessage=Pending&status=2&statusMessage=Authorized

Processed

1
merchantId=1003185344&merchantReference=13c3f5c5-b521-4c59-a003-ab71ecfa0044&paymentType=2&transactionType=6&eventId=1003323249&eventType=Process&objectId=1003323242&objectType=Transaction&message=Processed+by+user+vivyan.ngo%40trustly.com&timeZone=Etc%2FUTC&createdAt=1572045241157&paymentProviderTransaction.status=AC105&paymentProviderTransaction.statusMessage=Processed&status=3&statusMessage=Processed

Completed

1
merchantId=1003185344&merchantReference=13c3f5c5-b521-4c59-a003-ab71ecfa0044&paymentType=2&transactionType=6&eventId=1003323255&eventType=Complete&objectId=1003323242&objectType=Transaction&message=Completed+by+user+vivyan.ngo%40trustly.com&timeZone=Etc%2FUTC&createdAt=1572045245717&paymentProviderTransaction.status=AC105&paymentProviderTransaction.statusMessage=Processed&status=4&statusMessage=Completed

Capture Reversal

Reversed

1
merchantId=1003185344&merchantReference=61a808b4-a059-4e3b-b295-24ca5db7e8a0&paymentType=2&transactionType=3&eventId=1003323415&eventType=Reverse&objectId=1003323369&objectType=Transaction&message=Reversed+by+user+vivyan.ngo%40trustly.com&timeZone=Etc%2FUTC&createdAt=1572046021258&paymentProviderTransaction.status=AC118&paymentProviderTransaction.statusMessage=Settled&status=10&statusMessage=Reversed

Deposit Reversal

Disputed

1
merchantId=1003185344&merchantReference=13c3f5c5-b521-4c59-a003-ab71ecfa0044&paymentType=2&transactionType=6&eventId=1003323261&eventType=Dispute&objectId=1003323242&objectType=Transaction&message=Reversed+by+user+vivyan.ngo%40trustly.com&timeZone=Etc%2FUTC&createdAt=1572045282884&paymentProviderTransaction.status=AC105&paymentProviderTransaction.statusMessage=Processed&status=9&statusMessage=Disputed

Reversed

1
merchantId=1003185344&merchantReference=13c3f5c5-b521-4c59-a003-ab71ecfa0044&paymentType=2&transactionType=6&eventId=1003323286&eventType=Reverse&objectId=1003323242&objectType=Transaction&message=Reversed+by+user+vivyan.ngo%40trustly.com&timeZone=Etc%2FUTC&createdAt=1572045283939&paymentProviderTransaction.status=AC105&paymentProviderTransaction.statusMessage=Processed&status=10&statusMessage=Reversed

Further Reading