Partner Notification System

Section 1 - OVERVIEW

 

The Partner Notification System is used to deliver production processing credentials to a Nuvei Partner once a new Nuvei Gateway account has been successfully boarded in the back-end Nuvei systems.

Partners may need to leverage the credentials delivered via this system in such circumstances where configuration within point-of-sale software is required to activate payment processing capabilitites for the merchant. This system is highly recommended to implement for ISV Partners and Payment Facilitators leveraging the Nuvei Gateway.

The aim of this documentation is to provide partners with guidance containing boarding details with a unique identifier throughout the Partner Notification System.

The scope of this document is limited to providing technical details on how Nuvei sends boarding communications and the content of the communication to its partners.

 

Section 2 - COMMUNICATION MESSAGE

 

Section 2.1 - Message Body

{
"MessageType": “Boarding.Merchant.G1P " ,
"UId ": "273ad974-61d2-4e04-b264-4c4462eb71aa",
"CreatedDate": "2016-04-20T22:35:08.3195501Z",
"Status": “Completed”
“ResponseCode” : “0”
“ResponsePhrase” : “Success”
"Message": {
"DbaName": "my Merchant LLC",
"MerchantId": " 912280012617",
“GatewayMerchantId” : “3860”
"GatewayTerminalNumbers": ["3860001"],
"SharedSecret": "PIV012617"
}
}

 

Section 2.2 - Message Body Details

 FIELD  DESCRIPTION    VALUE TYPE  CONSTRAINTS
 Message Type  Describes the event  Alphanumeric   C01
 UId  Unique communication identifier  Unique Identifier  
 CreatedDate  Date Time in ISO 8601 format  Date Time  
 State  Communication State  Alphanumeric  C02
 Response Code  Response Codes  Alphanumeric  C03
 ResponsePhrase  Response Messages  Alphanumeric  C03
 Message.DbaName  Merchant's Business Name  Alphanumeric  
 Message.MerchantId  Merchant's Backend MID  Alphanumeric  
 Message.GatewayMerchantId  Merchants Gateway Identifier  Alphanumeric  
 Message.GatewayTerminalNumbers  List of Merchant's Terminal Identifiers  List  
 Message.SharedSecret  Terminal Shared Secret Value Alphanumeric  

 

 

Section 2.3 - Message Body Constraints

LABEL DESCRIPTION
C01

List of Values:

   Boarding.Merchant.G1P

C02

List of Values:

   Failed

   Completed

   Cancelled

C03

Present in payload only in case of errors

List of Values:

   0 - Denotes a successful boarding

 

 

Section 3 - CONNECTIVITY DETAILS

 

Nuvei will send the partner-requested communication message to an endpoint in the partner’s
information system in json format. Nuvei expects an answer in the form of an acknowledgement from the partner’s system.

 

Section 3.1 - Connectivity Requirements

For Nuvei to send a message to the partner’s system, the following details must be provided by the partner.

REQUIREMENT DESCRIPTION
Endpoint URL Partner's endpoint URL where messages will be sent via HTTP POST by Nuvei
API Key

A non-expiring access token key / public key in the partner's system used for authentication.

Nuvei will send this key in the headers using the header name, AuthenticationKey.

 

 

Section 3.2 - Partner Acknowledgement

Nuvei expects an acknowledgement for each message successfully delivered within the partner’s system in JSON format. The following message with a HTTP status code of 200 for each successful communication or HTTP 400 status code otherwise sent to Nuvei.

{
"MessageType": “Boarding.Merchant.G1P ",
"UId ": "273ad974-61d2-4e04-b264-4c4462eb71aa"
}
FIELD DESCRIPTION VALUE TYPE
MessageType Message type describing the event in the corresponding message sent by Nuvei Alphanumeric
UId Unique comminucation identifier in the corresponding message sent by Nuvei Unique Identifier

 

Need Help?

How can we help you today?  Our team is standing by and just a click away.