Overview link
The Partner Notification System delivers production credentials to a Partner after a new Nuvei Gateway account has been successfully boarded in the back-end systems.
Partners use these credentials to configure point-of-sale software and payment processing capability for the merchant. We recommend that ISV Partners and Payment Facilitators integrating to the Nuvei Gateway use this system.
This page provides the technical details of how Nuvei sends boarding credentials to partners.
COMMUNICATION MESSAGE link
- Nuvei will send the partner-requested communication message in JSON format to an endpoint in the partner information system.
- Partners must provide an HTTPS URL endpoint that supports standard encryption protocols. Nuvei expects an acknowledgement from the partner’s system.
Message Body Requirements
| FIELD NAME | DESCRIPTION | DATA TYPE | CONSTRAINTS |
|---|---|---|---|
| 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 Business Name | Alphanumeric | |
| Message.MerchantId | Merchant Backend MID | Alphanumeric | |
| Message.GatewayMerchantId | Merchant Gateway Identifier | Alphanumeric | |
| Message.GatewayTerminalNumbers | List of Merchant Terminal Identifiers | List | |
| Message.SharedSecret | Terminal Shared Secret Value | Alphanumeric |
Message Constraints
| CONSTRAINT | DESCRIPTION |
|---|---|
| C01 |
List of Values:
|
| C02 |
List of Values:
|
| C03 |
Present in payload only in case of errors List of Values:
|
Communication Message: Sample Code link
JSON
{
"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"
}
}
CONNECTIVITY link
- Nuvei expects an acknowledgement in JSON format to each message successfully delivered.
- The partner must create a payload in response with an HTTP status code of 200 for a successful communication, or 400 if unsuccessful.
Connectivity Requirements
| REQUIREMENT | DESCRIPTION |
|---|---|
| Endpoint URL |
Partner endpoint URL to which Nuvei will send the payload via HTTPS POST. |
| API Key |
A non-expiring access token key/public key in the partner system, used for authentication. |
Partner Acknowledgement Requirements
| FIELD NAME | DESCRIPTION | DATA TYPE |
|---|---|---|
| MessageType | Describes the event in the corresponding message sent by Nuvei | Alphanumeric |
| UID | Unique communication identifier in the corresponding message sent by Nuvei | Unique Identifier |
Partner Acknowledgement: Sample Code link
JSON
{
"MessageType": “Boarding.Merchant.G1P ",
"UId ": "273ad974-61d2-4e04-b264-4c4462eb71aa"
}