Notifications

The PXP Financial Onboarding Service supports sending notifications for a set of events during the onboarding process:

via email (to a pre-configured email address provided by the partner during the setup with PXP Financial)
via REST/JSON API (to a pre-configured URL provided by the partner during the setup with PXP Financial)

Merchant State Change Notifications

Notifications are sent for the following state changes of a merchant:

merchant.state	Definition	StateReason
Declined	The merchant application was declined by PXP Financial.	For pre-screening, one of the following: AlreadyProcessing Outside License Generic For underwriting, either of the following:
PendingOnPreScreeningData	The merchant application is pending. The partner has to transmit the additionally requested documentation/data in order to proceed with the merchant pre-screening process.	A freetext captured by the agent that lists what data should be sent. Please note: this data needs to be sent outside of the PXP Financial Onboarding API.
PendingOnUnderwritingData	The merchant application is pending. The partner has to transmit the additionally requested documentation/data in order to proceed with the merchant activation process.	A freetext captured by the agent that lists what data should be sent. Please note: this data needs to be sent outside of the PXP Financial Onboarding API.
PendingOnDocuments	The merchant application is pending. The partner has to transmit the mandatory documents in order to proceed with the merchant activation process.	n/a
PendingOnContract	The merchant application is pending. The partner has to transmit the Contract (document) in order to proceed with the merchant activation process.	n/a
PendingOnActivation	All necessary information has been received by PXP Financial and the merchant is being activated. It will be able to start processing soon (once the state changes to "Active" or "ConditionallyActive").	n/a
Active	The merchant is active and can start processing payments. The notification will additionally contain the POS-Gateway MID which needs to be used to initiate payments for a CP (POS) merchant/shop.	n/a
ConditionallyActive	The merchant is active and can start processing payments, but no settlement payouts to the merchant will be done until the merchant is finally "Active". The notification will additionally contain the POS-Gateway MID which needs to be used to initiate payments for a CP (POS) merchant/shop.	n/a
Blocked	The merchant was blocked by PXP Financial and cannot process payments currently.	One of the following: tbd
Closed	The merchant was closed by PXP Financial and cannot process payments any longer.	n/a

Email notification

A notification email has the following format:

From: [email protected]
Subject: Merchant $MerchantID$ has changed state to $state$

Body:
Merchant: 
$id$
State: 
$State$
Timestamp: 
dd/MM/yyyy hh:mm:ss
StateReason: 
$Reason$

Example notification email: for a merchant state change to "Active"

From: [email protected]
Subject: Merchant 370e6794-51d2-41d9-bbcc-e0762e7500ef has changed state to Active #0030782
Body:
Merchant:
370e6794-51d2-41d9-bbcc-e0762e7500ef  
State:
Active 
Timestamp:
5/16/2018 6:30 PM 
StateReason:
n/a
POS_MID:
7171123458

API notification

The format specification (contract) of REST/JSON API event notifications can be found in the API reference section: Event Notifications

Example API notification: for a merchant state change to "Active"

{ 
   "id":"7a35d79e-56df-4bc2-8946-1cef2f0b6d75",
   "createdOn":"2018-12-14 11:30:27:725",
   "type":"MerchantStateChangedEvent",
   "data":{ 
      "merchantId":"70f4ed1f-8ba9-4ad9-9800-4fab7c564e63",
      "state":{ 
         "type":"Active",
         "reason":""
      },
      "cardPresentMid":""
   }
}

Prescreen-Merchant State Change Notifications

Notifications are sent for the following state changes of a pre-screen merchant:

PreScreenMerchant.state Definition

Approved The pre-screening request was approved.
The partner should now use GET /prescreen-merchants/{preScreenMerchantId} to retrieve full information about the pre-screening result. Especially the customerDueDiligenceLevel and the state of each pre-screening shop elements must be checked.

The Partner can proceed to send the merchant/shop application data (via POST /Merchant or POST /Shop).
Mandatory Data, Questions and Documents should be sent based on the customerDueDiligenceLevel.
* Only those shops should be sent which were approved in the pre-screening (PreScreenShop.state=Approved).

Declined The pre-screening request was declined. The partner is not allowed to send the merchant application data.

PreScreenMerchant.state	Definition
Approved	The pre-screening request was approved. The partner should now use GET /prescreen-merchants/{preScreenMerchantId} to retrieve full information about the pre-screening result. Especially the customerDueDiligenceLevel and the state of each pre-screening shop elements must be checked. The Partner can proceed to send the merchant/shop application data (via POST /Merchant or POST /Shop). Mandatory Data, Questions and Documents should be sent based on the `customerDueDiligenceLevel`. * Only those shops should be sent which were approved in the pre-screening (`PreScreenShop.state`=Approved).
Declined	The pre-screening request was declined. The partner is not allowed to send the merchant application data.

Email notification

A notification email for changes of a PreScreenMerchant entity has the following format:

From: [email protected]

Subject: Pre-Screening Merchant element $PreScreeningDataId$ has changed state to $state$

Body:
Pre-Screen Merchant: 
$PreScreeningMerchantId$
State: 
$state$
Timestamp: 
dd/MM/yyyy hh:mm:ss

Example notification email: for a PreScreenMerchant state change to "Approved"

From: [email protected]
Subject: PreScreen-Merchant 370e6794-51d2-41d9-bbcc-e0762e7500ef has changed state to Approved #0030782
Body:
Pre-screen Merchant:
370e6794-51d2-41d9-bbcc-e0762e7500ef  
State:
Approved 
Timestamp:
5/16/2018 6:30 PM

API notification

The format specification (contract) of REST/JSON API event notifications can be found in the API reference section: Event Notifications

Example API notification: for a PreScreenMerchant state change to "Approved"

{ 
   "id":"7a35d79e-56df-4bc2-8946-1cef2f0b6d75",
   "createdOn":"2018-12-14 11:30:27:725",
   "type":"PreScreenMerchantStateChangedEvent",
   "data":{ 
      "preScreenMerchantId":"70f4ed1f-8ba9-4ad9-9800-4fab7c564e63",
      "state":{ 
         "type":"Active"
      }
   }
}