Callbacks

Last changes: 07-24-2020

Notification Service

This section covers how to use webhooks to be notified about events that happen in an E-wallet account. Some events, like disputed charges or account status changes, are not the result of a direct API request. Webhooks solve these problems by letting you register a Url that we will notify anytime such an event happens.
The "Notification Target URL" contains a JSON payload depending on the notification type. Based on integration requirements the individual notifications have to be turned on in the back office. Please contact Customer Support or your administrator to check your individual integration use case.

Authentication options

Based on the authentication selected for the corresponding program the following behaviors are possible:

Authentication TypeBehavior

No Authentication

No authentication information is used for the requests to "Notification Service Settings".
IP Whitelisting is mandatory in this case.
Please contact Customer Support or your Administrator for the IP address which you should
whitelist.

Basic Authentication

The authentication is done by specifying Username and Password under "Notification
Service Settings". These fields are used for basic authentication for every call made to the
"Notifications Target URL".

OAUTH Authentication

The Authentication URL is specified along with the Username and Password under the
"Notification Service Settings" for the corresponding program. These fields are used for
OAUTH authentication to get the authentication token via the Client Credentials Grant. This
token is then attached to every call to "Notification Target URL".

 

Chargeback

If a chargeback has been performed for a transaction, a notification is sent to the "Notifications Target URL" specified in the
"Notification Service Settings" of the program owning the account to which the transaction belongs if the following services are
activated in the back office:

  • Notification service for the corresponding program.
  • Chargeback.
{
"notificationType": "Chargeback",
"uniqueReference": "{unique reference of the transaction being charged back}"
}

Account Status Change

If an e-wallet user account changes its status, a notification is sent to the "Notifications Target URL" specified in the "Notification Service Settings" of the program owning the account whose status has been changed, if the following services are activated in the back office:

  • Notification service for the corresponding program.
  • AccountStatusChange.
{
"notificationType": "AccountStatusChange",
"accno": "{account number of the affected account}",
"externalAccountReference": "{external account reference of the affected account}",
"newStatus": "{status code of the new account status}"
}

Debtor Invoice Callback

If the API method 1.103 Perform Debtor Invoice Callback is called, a notification is sent to the "Notifications Target URL" specified in the "Notification Service Settings" of the program owning the account whose status has been changed if the following services are activated in the back office:

  • Notification service for the corresponding program.
  • DebtorInvoiceCallback.
{
"notificationType": "DebtorInvoiceCallback",
"invoiceData": "{body of the 'Perform Debtor Invoice Callback' request}"
}

Reject

If a transaction has been rejected, a notification is sent to the "Notifications Target URL" specified in the "Notification Service Settings" of the program owning the account to which the transaction  belongs if the following services are activated in the back office:

  • Notification service for the program above is active.
  • Reject.
{
"notificationType": "Reject",
"uniqueReference": "{unique reference of the transaction being rejected}"
}

Compliance Check

If the "Manual Review Result" is changed for a compliance check record, a notification is sent to the "Notifications Target URL" specified in the "Notification Service Settings" of the program owning the account to which the "archiveId" is specified in the compliance check record, if the following services are activated in the back office:

  • Notification service for the program above is active.
  • ComplianceCallback.
{
"notificationType": "ComplianceCallback",
"archiveId": "{'ArchiveId' specified in the compliance check record}",
"decision": "{'ManualReviewResult' specified in the compliance check record: 1 -> 'OK', 0 -> 'KO'}",
"comment": "{'ReviewComment' specified in the compliance check record}"
}

Payment Option Expiration

The “Payment Option Expiration” callback sends a notification the aligned number of days prior to the payment option expiration date. Allowing you to trigger internal processes in order to prompt the user to register a new payment option and delete the one which is about to expire. Please contact your rollout manager to align on the usage of this functionality, particularly to align on how many days before the payment option's expiration you wish to receive the notification.

In order to change the expiry date of the card the integrating party must first 1.55 Delete Stored Payment Option and then enroll the payment option again by calling 1.53 Init Add Stored Payment Option and 1.54 Complete Add Stored Payment Option.

{
"notificationType": "PaymentOptionExpiration",
"storedPaymentOptions":
[
{
"storedPaymentOptionReference": "{reference of the stored payment option to be expired}",
"paymentOptionCode": "{payment option code of the stored payment option to be expired}",
"validUntil": "{validity date of the stored payment option to be expired as YYYY-MM-DD}",
"accno": "{account number to which the stored payment option above belongs}",
"externalAccountReference": "{external account reference of the account above}"
}
]
}

PayU Callback

If you use PayU, a notification is sent to the "Notifications Target URL" specified in the "Notification Service Settings" of the program owning the account, if the following services are activated in the back office:

  • Notification service for the program above is active.
  • Authorization Feedback.
  • Capture Feedback.
  • Cancellation Feedback
  • Refund Feedback
{
    "notificationType": "AuthorizationFeedback",
    "processingStatus": "Status of transaction processing: 'Success' or 'Failed'",
    "processingReason": "Description of the transaction processing status",
    "transactionStatus": "RECEIVED or AUTHORIZED",
    "uniqueReference": "Unique reference of the transaction",
    "relatedTransactionReferences": [{
        Array of transaction references of dependent transactions which are updated,
        if available.Otherwise, the array is empty.
    }]
}