To perform a payout with Verified Faster Payments, you need to use the /accountCapture method before sending the /payout API request:

1. Generate a sessionToken. Press here for details.
2. Send an /accountCapture request with all of its mandatory parameters, including:
   • userTokenId – Unique customer identifier in merchant system.
   • paymentMethod: “apmgw_Verified_Faster_Payments“
   • currencyCode: “GBP“
   • countryCode: “GB“
     
     

     Example /accountCapture Request

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

     The request returns a redirectUrl.

     Example /accountCapture Response

     {
       "internalRequestId": 42177171,
       "status": "SUCCESS",
       "errCode": 0,
       "reason": "",
       "merchantId": "1102398682906145682",
       "merchantSiteId": "228311",
       "version": "1.0",
       "sessionToken": "505557de-b492-435b-b67d-45e1e0ff0d4c",
       "redirectUrl": "https://auth.truelayer-sandbox.com/[email protected]&scope=accounts%20info%20verification&response_type=code&redirect_uri=https://jumpbox.safecharge.com/dmz/ApmConnectorNotify/ConnectorBankCapture/711/540&state=018246908B03252D1292C89B21630999&client_id=sandbox-nuvei12345-aceeb4&providers=uk-cs-mock&tracking_id=2610000000061351",
       "userTokenId": "99999455"
     }

3. Use redirectUrl to redirect the customer to an account details capture page where they enter account details.
4. Once the information is captured, Nuvei stores the data in a userPaymentOptionId (UPO) identifier, and sends a Direct Merchant Notification (DMN) with the newly created userPaymentOptionId to urlDetails.notificationUrl, which Nuvei recommends including in the /accountCapture request.
   If the user has more than one IBAN or account number, Nuvei creates the UPO with the first IBAN or account number. The merchant needs to check the IBAN or account number in the apmPayerInfo portion of the DMN and, if necessary, send an /editUPOAPM request to change the IBAN or account number for the UPO to the one the customer is using for the payout.

   Example /accountCapture DMN

   ...'ppp_status=OK&ExErrCode=&ErrCode=&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=&PPP_TransactionID=&userid=140061921&merchant_unique_id=&customData=&productId=&first_name=&last_name=&email=&currency=GBP&customField1=&customField2=&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=&address2=&country=GB&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=&total_handling=&total_shipping=&total_tax=&buyButtonProductBundleId=&merchant_site_id=228311&merchant_status=&action=&requestVersion=&message=&merchantLocale=&unknownParameters=&payment_method=apmgw_Verified_Faster_Payments&ID=&merchant_id=1102398682906145682&responseTimeStamp=2024-07-10.12%3A54%3A49&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=&externalEmail=&cardCompany=&eci=&user_token_id=99999455&userPaymentOptionId=2153285031&TransactionID=&totalAmount=&dynamicDescriptor=&feeAmount=&amountWithoutFee=&houseNumber=&customCurrency=&type=ACCOUNT_CAPTURE&clientRequestId=&relatedTransactionId=&apmPayerInfo=%5B%7B%22verifiable%22%3A%22true%22%2C%22currency%22%3A%22GBP%22%2C%22iban%22%3A%22GB08CLRB04066800003435%22%2C%22provider_id%22%3A%22mock%22%2C%22account_type%22%3A%22CURRENT%22%2C%22display_name%22%3A%22John+Doe%22%2C%22swift_bic%22%3A%22CPBKGB00%22%2C%22account_number%22%3A%2210000000%22%2C%22sort_code%22%3A%2201-21-31%22%2C%22account_holders%22%3A%5B%7B%22name%22%3A%22John+Doe%22%2C%22verified%22%3A%22true%22%2C%22match_score%22%3A%22100%22%7D%5D%7D%2C%7B%22verifiable%22%3A%22true%22%2C%22currency%22%3A%22GBP%22%2C%22iban%22%3A%22GB08CLRB04066800003435%22%2C%22provider_id%22%3A%22mock%22%2C%22account_type%22%3A%22CURRENT%22%2C%22display_name%22%3A%22Joint+Account%22%2C%22swift_bic%22%3A%22CPBKGB00%22%2C%22account_number%22%3A%2250000000%22%2C%22sort_code%22%3A%2201-21-31%22%2C%22account_holders%22%3A%5B%7B%22name%22%3A%22John+Doe%22%2C%22verified%22%3A%22true%22%2C%22match_score%22%3A%22100%22%7D%2C%7B%22name%22%3A%22Mary+Poppins%22%2C%22verified%22%3A%22false%22%2C%22match_score%22%3A%2230%22%7D%5D%7D%5D&responsechecksum=eb3501a6e6f06b8ee3cd6982839d378c&advanceResponseChecksum=e7c555a66af3fc7fc109f3a767f2e165,'

5. Send a /payout request with all of its mandatory parameters, including:
   • userPaymentOptionId – Contains the user’s previously stored APM account details.
   • userDetails class containing:
     • firstName
     • lastName
     • email

In addition, to minimize transactions held by the RFI process, the following parameters are mandatory :

• • • birthdate
    • address (for example: 1 Hardwick Street)
    • city
    • zip

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 Payment Page Request

https://ppp-test.safecharge.com/ppp/withdrawal/withdraw.do?merchant_id=5970183043540730700&merchant_site_id=238459&user_token=auto&email=johndoe%40gmail.com&merchantLocale=en_GB&country=GB&first_name=John&last_name=Doe&address1=6th+Floor%2C+2+Kingdom+Street&city=London&state=London&zip=W2+6BD&phone1=441234567890&dateOfBirth=1988-10-15&wd_amount=5&wd_currency=GBP&wd_min_amount=1&wd_max_amount=1000&user_token_id=28c8edde3d61a0411511&time_stamp=2024-07-31+12%3A48%3A15&customField1=1&parent_url=https%3A%2F%2Fdemos.nuvei.com&version=4.0.0&userid=1&userName=JohnDoe&languageCode=en&title=Mrs&gender=Female&building=46&mobileCountryCode=054&mobileNumber=13094526617&identificationType=NationalId&identification=234234234234&checksum=de77a5f9b5f2fd45a9a5aee4c1d72a0a

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