To perform a payout using REST API integration, you need to use the /accountCapture method before sending the /payout request:

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_Bank_Payouts“
     • currencyCode: “EUR“
     • countryCode: “<2-letter ISO code for a supported country>”
       
       

       Example /accountCapture Request

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

       The request returns a redirectUrl.

       Example /accountCapture Response

       {
         "internalRequestId": 1130973358,
         "status": "SUCCESS",
         "errCode": 0,
         "reason": "",
         "merchantId": "979047831696752006",
         "merchantSiteId": "217268",
         "version": "1.0",
         "sessionToken": "12e11ad2-3a8e-4be1-8f1c-f4a0b7b4d20d",
         "redirectUrl": "https://cdn-int.safecharge.com/safecharge_resources/v1/bank-details-20050.html?submitUrl=https://test.safecharge.com/APMNotificationGateway/SmartConnector/BankCapture/0855C1E5E3B70B58FDE15FC13191428F&locale=en_US&country=EG&currency=EUR",
         "userTokenId": "TestUser33"
       }

3. Use redirectUrl to redirect the customer to the account details capture interface for them to enter their account details.
4. Once the information is captured, Nuvei stores the data in a userPaymentOptionId (UPO) identifier, and sends a  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.

After the transaction is processed, Nuvei sends a DMN that includes the result of the transaction to 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=42298531&userid=paypaltoken6828596680&merchant_unique_id=20240401123248&customData=Silvenam&productId=&first_name=&last_name=&email=&currency=EUR&pmDisplayName=sb-47o0a329883016%40business.example.com&clientUniqueId=20240401123248&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_expresscheckout&ID=&merchant_id=4972436454212160565&responseTimeStamp=2024-04-01.09%3A33%3A18&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=Credit&externalEmail=&cardCompany=&eci=&user_token_id=paypaltoken6828596680&userPaymentOptionId=2153180711&TransactionID=2610000000000016485&externalAccountDescription=account_id%3ANTDR7TB3GU4LS%7Cemail%3Asb-47o0a329883016%40business.example.com&externalTransactionId=E3YM6GJB75VAW&totalAmount=15.0&dynamicDescriptor=Sil+Descriptor&feeAmount=&houseNumber=&customCurrency=&upoRegistrationDate=20240401&type=DEPOSIT&clientRequestId=&relatedTransactionId=&responsechecksum=f9ccfbf6f086130228392982c3f1231d&advanceResponseChecksum=e40118b36d9e41b1db05176f19fb4f2c',

Example Payment Page Request

https://ppp-test.safecharge.com/ppp/withdrawal/withdraw.do?merchant_id=979047831696752006&merchant_site_id=217268&user_token=auto&merchantLocale=undefined&wd_amount=1.23&wd_currency=EUR&country=EG&wd_min_amount=1&wd_max_amount=100&user_token_id=TestUser33&userid=&time_stamp=2024-06-25%2009:20:53&version=4.0.0&checksum=1f3327ee0e803da0e87177b9f302cde4402f9cda18a349666b868734e36a82de

After the transaction is processed, Nuvei sends a DMN that includes the result of the transaction to notify_url, which Nuvei recommends including in the request.

Example Withdrawal DMN with wdRequestStatus=Approved

...'wdOrderId=5403311&wdRequestId=6783581&gwTrxId=2610000000000027342&notificationType=WITHDRAW_REQUEST_NOTIFICATION&merchantSiteId=186111&merchantGwId=5416795427517477813&merchantLocale=en_US&wdRequestState=Closed&wdRequestStatus=Approved&wdOrderStatus=Settled&settlementType=WITHDRAWAL&gwErrCode=0&gwExtendedErrorCode=0&apmTrxId=2610000000041995&apmReferenceId=F52BE17D8E1FFF556C8A6C7F6762290B&apmErrorCode=0&firstName=Fname&lastName=Lname&userTokenId=13395012yurcv&zip=123456&city=Madrid&country=OM&phone1=0987654321&email=test%40mymail.com&address=Sancho+el+fuerte+15&amount=100.00&approvedAmount=100.00&currency=EUR&userId=Lorem&userPMId=2153215531&paymentMethod=apmgw_Bank_Payouts&version=1.0&pmDisplayName=12345678900&customField1=enracha.es&client_ip=127.0.0.1&wdOrderAmount=100.00&wdOrderCurrency=EUR&responseTimeStamp=2024-05-20.06%3A36%3A01&feeAmount=0.0&transactionAmount=100.0&merchantUniqueId=merchuniqueid&upoRegistrationDate=20240520&acquirerBank=InpayMS-PI&checksum=61b6afb835d208c951362f3b9dc4c4552d0ce25abd148410f84ba6ab4336cf7e',