Attributes

• METHOD TYPEBank Transfer
• PAYMENTS
• PAYOUTS
• REFUNDS
• RECURRING

Introduction

The New Payments Platform (NPP) was launched in February 2018. The NPP is an open-access infrastructure for fast payments in Australia.

Nuvei offers merchants using the NPP APM our Verify API electronic know your customer (eKYC) service.

Supported Countries

• Australia

Supported Currencies

• AUD

Payment (Deposit) Flow

Press tab to open…

{
  "sessionToken":"<sessionToken from /getSessionToken>",
  "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>",
  "amount":"90",
  "currency":"AUD",
  "paymentOption":{
    "alternativePaymentMethod":{
      "paymentMethod":"apmgw_NPP"
    }
  },
  "deviceDetails":{
    "ipAddress":"<customer's IP address>"
  },
  "userDetails":{
    "firstName":"John",
    "lastName":"Smith",
    "email":"[email protected]",
    "country":"AU"
  },
  "billingAddress":{
    "firstName":"John",
    "lastName":"Smith",
    "email":"[email protected]",
    "country":"AU"
  },
  "timeStamp":"<YYYYMMDDHHmmss>",
  "checksum":"<calculated checksum>"
}

{
  "orderId":"38400281",
  "userTokenId":"Siltoken54545xxx122252vf1skns",
  "paymentOption":{
    "redirectUrl":"https://apitest.nuvei.com/Home?PaymentToken=7DAEFCFCFEBFA680BB2F4A5C5082C597.14228601",
    "userPaymentOptionId":"8382371",
    "card":{     
    }
  },
  "transactionStatus":"REDIRECT",
  "sessionToken":"1d5b14f1-cb89-4464-a8cc-6814f912f891",
  "clientUniqueId":"12345",
  "internalRequestId":23105301,
  "status":"SUCCESS",
  "errCode":0,
  "reason":"",
  "merchantId":"1459627421657905728",
  "merchantSiteId":"209631",
  "version":"1.0",
  "clientRequestId":"20221123125730"
}

Example Payment DMN with status=APPROVED

...'ppp_status=OK&Status=APPROVED&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=0&PPP_TransactionID=38400281&userid=Siltoken54545xxx122252vf1skns&merchant_unique_id=uniqueIdCC&customData=customData&productId=&first_name=firstname&last_name=lastname&email=email%40email.com&currency=AUD&clientUniqueId=uniqueIdCC&customField1=merchantName&customField2=merchantName&customField3=merchantName&customField4=merchantName&customField5=&customField6=&customField7=&customField8=&customField9=merchantName&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=&address2=&country=Australia&state=&city=city&zip=1335&phone1=&phone2=&phone3=&client_ip=127.0.0.1&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=&acquirerBank=Nuvei-PI&expMonth=&expYear=&Token=&tokenId=&AuthCode=&AvsCode=&Cvv2Reply=&shippingCountry=AU&shippingState=&shippingCity=city&shippingAddress=&shippingZip=1340&shippingFirstName=&shippingLastName=&shippingPhone=&shippingCell=&shippingMail=&total_discount=2.00&total_handling=0.00&total_shipping=1.00&total_tax=1.00&buyButtonProductBundleId=&merchant_site_id=209631&merchant_status=&action=&requestVersion=&message=APPROVED&merchantLocale=&unknownParameters=&payment_method=apmgw_NPP&ID=&merchant_id=1459627421657905728&responseTimeStamp=2022-11-23.11%3A01%3A46&buyButtonProductId=&webMasterId=webMasterId&appliedPromotions=&uniqueCC=&transactionType=Sale&externalEmail=&cardCompany=&eci=&user_token_id=Siltoken54545xxx122252vf1skns&userPaymentOptionId=8382371&TransactionID=2110000000007845347&externalTransactionId=14228601&APMReferenceID=8DE1CCF05ACE79ABB9DC9DABC78CA847&orderTransactionId=19199671&totalAmount=90.00&dynamicDescriptor=Sil+Descriptor&item_name_1=watch&item_number_1=&item_amount_1=40.00&item_quantity_1=1&item_discount_1=0.00&item_handling_1=0.00&item_shipping_1=0.00&item_name_2=color&item_number_2=&item_amount_2=50.00&item_quantity_2=1&item_discount_2=0.00&item_handling_2=0.00&item_shipping_2=0.00&feeAmount=&amountWithoutFee=&houseNumber=&customCurrency=&upoRegistrationDate=20221123&type=DEPOSIT&clientRequestId=20221123125730&relatedTransactionId=&apmPayerInfo=%7B%22StatusInfo%22%3A%22%7B+StatusCode%3A+%2C+info%3A+%2C+originalAmount%3A+90.0000%2C+ProcessedAmount%3A+90%7D%22%2C%22PaidAmount%22%3A%229000%22%2C%22AdditionalTransactionBankId%22%3A%22N00400172770%22%7D&sessionId=422b8b35604d3232a458ec93a418&responsechecksum=ef52e0699201585a1d0a31dc0abfb4b6&advanceResponseChecksum=538617488a717c5fab4843ee50b70434',

Example Payment DMN with status=DECLINED

...'ppp_status=FAIL&Status=DECLINED&ExErrCode=0&ErrCode=272&errApmCode=272&errApmDescription=Allowed+time+for+transaction+has+expired&errScCode=2022&errScDescription=Transaction+expired&Reason=Transaction+expired&ReasonCode=2022&PPP_TransactionID=38400421&userid=Siltoken54545xxx122252vf1skns&merchant_unique_id=uniqueIdCC&customData=customData&productId=&first_name=firstname&last_name=lastname&email=email%40email.com&currency=AUD&clientUniqueId=uniqueIdCC&customField1=merchantName&customField2=merchantName&customField3=merchantName&customField4=merchantName&customField5=&customField6=&customField7=&customField8=&customField9=merchantName&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=&address2=&country=Australia&state=&city=city&zip=1335&phone1=&phone2=&phone3=&client_ip=127.0.0.1&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=&acquirerBank=Nuvei-PI&expMonth=&expYear=&Token=&tokenId=&AuthCode=&AvsCode=&Cvv2Reply=&shippingCountry=AU&shippingState=&shippingCity=city&shippingAddress=&shippingZip=1340&shippingFirstName=&shippingLastName=&shippingPhone=&shippingCell=&shippingMail=&total_discount=2.00&total_handling=0.00&total_shipping=1.00&total_tax=1.00&buyButtonProductBundleId=&merchant_site_id=209631&merchant_status=&action=&requestVersion=&message=DECLINED&merchantLocale=&unknownParameters=&payment_method=apmgw_NPP&ID=&merchant_id=1459627421657905728&responseTimeStamp=2022-11-23.11%3A27%3A35&buyButtonProductId=&webMasterId=webMasterId&appliedPromotions=&uniqueCC=&transactionType=Sale&externalEmail=&cardCompany=&eci=&user_token_id=Siltoken54545xxx122252vf1skns&userPaymentOptionId=8382371&TransactionID=2110000000007845456&externalTransactionId=14228646&APMReferenceID=9D6921D15ECA9D9B02FB39819EEB1591&orderTransactionId=19199761&totalAmount=90.00&dynamicDescriptor=Sil+Descriptor&item_name_1=watch&item_number_1=&item_amount_1=40.00&item_quantity_1=1&item_discount_1=0.00&item_handling_1=0.00&item_shipping_1=0.00&item_name_2=color&item_number_2=&item_amount_2=50.00&item_quantity_2=1&item_discount_2=0.00&item_handling_2=0.00&item_shipping_2=0.00&feeAmount=&amountWithoutFee=&houseNumber=&customCurrency=&upoRegistrationDate=20221123&type=DEPOSIT&clientRequestId=20221123132204&relatedTransactionId=&apmPayerInfo=%7B%22StatusInfo%22%3A%22%7B+StatusCode%3A+272%2C+info%3A+Allowed+time+for+transaction+has+expired%2C+originalAmount%3A+90.0000%2C+ProcessedAmount%3A+90%7D%22%7D&sessionId=43938291f83757dba8d5502c9003&responsechecksum=05bf3f6513a900439b94fac13c0d91c3&advanceResponseChecksum=1bb12cf7053abffb6df64a7893c8558c',

Payout (Withdrawal) Flow

Follow these steps to perform a payout:

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

{
  "merchantSiteId":"<your merchantSiteId>",
  "merchantId":"<your merchantId>",
  "userTokenId":"<unique user identifier in merchant system>",
  "clientRequestId":"<unique request ID in merchant system>",  
  "firstName":"John",
  "lastName":"Smith",
  "address":"some street",
  "email":"[email protected]",
  "countryCode":"AU",
  "timeStamp":"<YYYYMMDDHHmmss>",
  "checksum":"<calculated checksum>"
}

Example /createUser Response

{
  "userId":139762411,
  "internalRequestId":23165741,
  "status":"SUCCESS",
  "errCode":0,
  "reason":"",
  "merchantId":"1459627421657905728",
  "merchantSiteId":"209631",
  "version":"1.0",
  "clientRequestId":"20221129121724"
}

The request registers the userTokenId (userId) in the Nuvei system, which is needed to generate a UPO in the next step.

2. Create the UPO

• By including the customer bank account details.
• By including the PayID details.

Press tab to open…

{
  "merchantId":"<your merchantId>",
  "merchantSiteId":"<your merchantSiteId>",
  "clientRequestId":"<unique request ID in merchant system>",
  "userTokenId":"<unique customer identifier in merchant system>",
  "paymentMethodName":"apmgw_NPP",
  "apmData":{
    "npp_payout_type": "559",
    "npp_account_name": "John Smith",
    "npp_bankStateBranch_number": "802-985",
    "npp_account_number": "915390153"
  },
  "timeStamp":"<YYYYMMDDHHmmss>",
  "checksum":"<calculated checksum>"
}

{
  "userPaymentOptionId": 8384701,
  "internalRequestId": 23167641,
  "status": "SUCCESS",
  "errCode": 0,
  "reason": "",
  "merchantId": "1459627421657905728",
  "merchantSiteId": "209631",
  "version": "1.0",
  "clientRequestId": "20221129141037"
}

{
  "merchantId":"<your merchantId>",
  "merchantSiteId":"<your merchantSiteId>",
  "clientRequestId":"<unique request ID in merchant system>",
  "userTokenId":"<unique customer identifier in merchant system>",  
  "paymentMethodName":"apmgw_NPP",
  "apmData":{
    "npp_payout_type":"560",
    "npp_account_name":"John Smith",
    "npp_pay_id": "[email protected]",
    "npp_pay_id_type": "email"
  },
  "timeStamp":"<YYYYMMDDHHmmss>",
  "checksum":"<calculated checksum>"
}

{
  "userPaymentOptionId": 8384731,
  "internalRequestId": 23167901,
  "status": "SUCCESS",
  "errCode": 0,
  "reason": "",
  "merchantId": "1459627421657905728",
  "merchantSiteId": "209631",
  "version": "1.0",
  "clientRequestId": "20221129143045"
}

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 Direct Merchant Notification (DMN) that includes the result of the transaction to the urlDetails.notificationUrl, which Nuvei recommends including in the /payout request.

Example /payout DMN with status=APPROVED

...'ppp_status=OK&Status=APPROVED&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=&PPP_TransactionID=38421941&userid=Silvenatoken2&merchant_unique_id=20221129141145&customData=Silvenam&productId=&first_name=&last_name=&email=&currency=AUD&clientUniqueId=20221129141145&customField1=&customField2=&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=&address2=&country=&state=&city=&zip=&phone1=&phone2=&phone3=&client_ip=&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=&expMonth=&expYear=&Token=&tokenId=&AuthCode=&AvsCode=&Cvv2Reply=&shippingCountry=&shippingState=&shippingCity=&shippingAddress=&shippingZip=&shippingFirstName=&shippingLastName=&shippingPhone=&shippingCell=&shippingMail=&total_discount=0.00&total_handling=0.00&total_shipping=0.00&total_tax=0.00&buyButtonProductBundleId=&merchant_site_id=209631&merchant_status=&action=&requestVersion=&message=APPROVED&merchantLocale=&unknownParameters=&payment_method=apmgw_NPP&ID=&merchant_id=1459627421657905728&responseTimeStamp=2022-11-29.12%3A11%3A55&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=Credit&externalEmail=&cardCompany=&eci=&user_token_id=Silvenatoken2&userPaymentOptionId=8384701&TransactionID=2110000000007897671&externalTransactionId=20661&totalAmount=100.0&dynamicDescriptor=Sil+Descriptor&feeAmount=&houseNumber=&customCurrency=&upoRegistrationDate=20221129&type=DEPOSIT&clientRequestId=&relatedTransactionId=&responsechecksum=74b6da331de7de71fb8c39815307b6d1&advanceResponseChecksum=5b4f9f731af0579fb1864196b870ee3e',

Example /payout DMN with status=DECLINED

...'ppp_status=FAIL&Status=DECLINED&ExErrCode=0&ErrCode=1016&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=Invalid+Account&ReasonCode=0&PPP_TransactionID=38421281&userid=Silvenatoken1&merchant_unique_id=20221129123619&customData=Silvenam&productId=&first_name=&last_name=&email=&currency=AUD&clientUniqueId=20221129123619&customField1=customField1&customField2=customField2&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=&address2=&country=&state=&city=&zip=&phone1=&phone2=&phone3=&client_ip=&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=null&expMonth=&expYear=&Token=&tokenId=&AuthCode=&AvsCode=&Cvv2Reply=&shippingCountry=&shippingState=&shippingCity=&shippingAddress=&shippingZip=&shippingFirstName=&shippingLastName=&shippingPhone=&shippingCell=&shippingMail=&total_discount=0.00&total_handling=0.00&total_shipping=0.00&total_tax=0.00&buyButtonProductBundleId=&merchant_site_id=209631&merchant_status=&action=&requestVersion=&message=DECLINED&merchantLocale=&unknownParameters=&payment_method=apmgw_NPP&ID=&merchant_id=1459627421657905728&responseTimeStamp=2022-11-29.10%3A36%3A20&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=null&transactionType=Credit&externalEmail=&cardCompany=&user_token_id=Silvenatoken1&userPaymentOptionId=8384501&TransactionID=2110000000007895793&totalAmount=100.0&dynamicDescriptor=silvenam&feeAmount=&houseNumber=&customCurrency=&upoRegistrationDate=20221129&type=DEPOSIT&clientRequestId=20221129123619&relatedTransactionId=&responsechecksum=1cec08f6668b1d0496ab9e5e70d5aa92&advanceResponseChecksum=a6ea123301aed4ffc40d456eef0020c0',

User Experience

1. The user is redirected to an instruction page that provides information on which bank account to transfer the funds to.
   For REST API merchants, there is also an option to receive the required details to display them on their site/page.

2. The user selects an option: PayID or Bank Account.
   Bank Account
   
   PayID
   
3. The user presses OK.
4. The user completes the deposit offline.