1. Generate a sessionToken. Press here for details.
2. Send an /accountCapture request that includes the following mandatory fields as shown in the example request below:
   • userTokenId – Unique customer identifier in merchant system.
   • paymentMethod: “apmgw_Express_Connect“
   • currencyCode: CAD
   • countryCode: CA
     
     

     Example /accountCapture Request

     {
       "sessionToken": "<sessionToken from /getSessionToken>",
       "merchantId": "<your merchantId>",
       "merchantSiteId": "<your merchantSiteId>",
       "userTokenId": "<unique customer identifier in merchant system>",
       "paymentMethod": "apmgw_Express_Connect",
       "currencyCode": "CAD",
       "countryCode": "CA",
     }

     The request returns a redirectUrl.

     Example /accountCapture Response

     {
         "reason": "",
         "redirectUrl": "https://interac.express-connect.com/webflow/verify?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhbW91bnQiOiIxIiwiYWRkcmVzcyI6IjI5OTIgQ2FtZXJvbiBSb2FkIiwiY2l0eSI6Ik5ld2FyayIsInNhbmRib3giOiJ0cnVlIiwibW9iaWxlIjoiMDg4ODg4ODQzMiIsImxhc3RfbmFtZSI6IkJPQkJFVEhDSEFSTEVTT04iLCJ0eXBlIjoiS1k0IiwidXNlcklkIjoiQ0Q1MDFBRjlGQTg1MDAxN0M5Mzk5QjZGNTlGRDNDMTUiLCJzaXRlIjoidGVzdCIsInByb3ZpbmNlIjoiTlkiLCJET0IiOiIxOTk3LTA5LTI2IiwidXNlcklwIjoiMTE0LjEzLjEyLjExIiwiY3VycmVuY3kiOiJDQUQiLCJwb3N0YWxfY29kZSI6IjE0MjM2IiwibGFuZyI6ImVuIiwiZmlyc3RfbmFtZSI6IkFMQkVSVEEiLCJlbWFpbCI6ImFjY291bnR0ZXN0bWFpbEBnbS5jb20iLCJ0cmFuc2FjdGlvbiI6IkNENTAxQUY5RkE4NTAwMTdDOTM5OUI2RjU5RkQzQzE1IiwidXNlciI6ImJmMGRhODViZjgyOTMyZWVmMjFhY2ZhNzM0YjZmNjA1IiwiY2FtcGFpZ24iOiI2YWMwZmYzYzY5NTdiNmY4ZTVkMDgxM2Y1MjY4OWNlMyIsImVudGl0eUlkIjoxLCJpYXQiOjE3MDE3OTIyMjAsImV4cCI6MTcwMTg3ODYyMH0.YeG1n2gTpA37JLDZSntpbnhTZkb2lLMDendqihF3Lx4",
         "merchantId": "2502136204546424962",
         "errCode": 0,
         "sessionToken": "aff5c587-6d76-42f5-bcbe-934209753951",
         "internalRequestId": 35455681,
         "userTokenId": "42WPMSNLOBAT",
         "version": "1.0",
         "status": "SUCCESS",
         "merchantSiteId": "126006"
     }

3. Use redirectUrl to redirect the customer to the APM’s account details capture interface for them to enter their account details.
4. Once the information is captured, Nuvei stores the data in a userPaymentOptionId identifier, and sends a Direct Merchant Notification (DMN) back to you with the newly created userPaymentOptionId.
5. Send a /payout request and include the userPaymentOptionId, which contains the user’s previously stored APM account details. Press here for an example.
   
   The response is PENDING; the approved result can be triggered only manually from Interac.

   After the transaction is processed, Nuvei sends a DMN that includes the result of the transaction to the URL provided in urlDetails.notificationUrl, which Nuvei recommends including in the /payout request.

1. Register a userTokenId

A userTokenId is a field in the Nuvei system containing the user’s identifier in the merchant system.

If you do not have a userTokenId registered in the Nuvei system for this user, then register one by sending a /createUser request, including email, countryCode, firstName, and lastName.

Example /createUser Request

{
  "merchantId": "<your merchantId>",
  "merchantSiteId": "<your merchantSiteId>",
  "userTokenId": "<unique customer identifier in merchant system>",
  "clientUniqueId": "<unique transaction ID in merchant system>",
  "clientRequestId": "<unique request ID in merchant system>",
  "currency": "CAD",
  "amount": "100",
  "userPaymentOption": {
    "userPaymentOptionId": "<ID of a previously stored payment option>"
  },
  "deviceDetails": {
    "ipAddress": "<customer's IP address>"
  },
  "urlDetails": {
    "notificationUrl": "<URL to which DMNs are sent>"
  },
  "timeStamp": "<YYYYMMDDHHmmss>",
  "checksum": "<calculated checksum>"
}

Example /createUser  Response

{
  "transactionStatus": "APPROVED",
  "clientRequestId": "W1Q3SBGE4",
  "internalRequestId": 17817071,
  "version": "1.0",
  "transactionId": "2110000000004333013",
  "merchantSiteId": "126006",
  "merchantId": "2502136204546424962",
  "clientUniqueId": "695701003",
  "errCode": 0,
  "userPaymentOptionId": "8054521",
  "paymentMethodErrorCode": 0,
  "userTokenId": "CEBQK9OVSLJA",
  "externalTransactionId": "2110000000068709",
  "status": "SUCCESS"
}

2. Create the UPO

Create a UPO by sending an /addUPOAPM request and include:

• userTokenId – The unique user identifier in your system.
• paymentMethodName: “apmgw_Express_Connect“
• apmData class containing:
  • accountNumber – User account number
  • institutionNumber – User institution number
  • transitNumber – User account transmit number
• billingAddress class containing: country and email

Example /addUPOAPM Request

{
  "merchantSiteId":"<your merchantSiteId>",
  "merchantId":"<your merchantId>",
  "userTokenId":"<unique customer identifier in merchant system>",
  "clientRequestId":"<unique request ID in merchant system>",
  "paymentMethodName":"apmgw_Express_Connect",
  "apmData":{
    "accountNumber":"<1234567>",
    "institutionNumber": "<123>",
    "transitNumber": "<12345>"
  },
  "billingAddress":{
    "country":"CA",
    "email":"[email protected]"
  },
  "timeStamp":"<YYYYMMDDHHmmss>",
  "checksum":"<calculated checksum>"
}

Example /addUPOAPM Response

{
  "userPaymentOptionId":2152829771,
  "internalRequestId":25129841,
  "status":"SUCCESS",
  "errCode":0,
  "reason":"",
  "merchantId":"1102398682906145682",
  "merchantSiteId":"228311",
  "version":"1.0",
  "clientRequestId":"20230228133537"
}

3. Send a /payout Request

Send a /payout request and include the userPaymentOptionId, which contains the user’s previously stored APM account details. Press here for an example.

After the transaction is processed, Nuvei sends a DMN that includes the result of the transaction to the URL provided in urlDetails.notificationUrl, which Nuvei recommends including in the /payout request.