Follow these steps to perform a payout using Nuvei REST API integration:

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 – See the list of APMs that support account details capture.
   • currencyCode
   • countryCode
     
     Some APMs require the userDetails class.

     Example /accountCapture Request

     {
       "sessionToken":"<sessionToken from /getSessionToken>",
       "merchantId":"<your merchantId>",
       "merchantSiteId":"<your merchantSiteId>",
       "paymentMethod":"apmgw_<APM provider name>",
       "userTokenId":"<unique customer identifier in merchant system>",
       "currencyCode":"USD",
       "countryCode":"US",
       "amount":"200",
       "urlDetails":{
         "successUrl":"<URL the customer is directed to after a successful transaction>",
         "pendingUrl":"<URL the customer is directed to when the transaction response is pending>",
         "failureUrl":"<URL the customer is directed to after an unsuccessful transaction>",
         "notificationUrl":"<URL to which DMNs are sent>"
       },
     }

     The request returns a redirectUrl.

     Example /accountCapture Response

     {
       "sessionToken":"9610a8f6-44cf-4c4f-976a-005da69a2a3b",
       "merchantId":"427583496191624621",
       "merchantSiteId":"142033",
       "redirectUrl":"<redirect URL to enter account details>"
     }

3. Use the redirectUrl to redirect the customer to the APM’s account details capture interface.
4. After the information is captured, Nuvei stores the data in a UPO record, and sends a DMN to the merchant with a newly created userPaymentOptionId.
   
   

   Example DMN

   ppp_status=OK
   userid=139619531
   currency=BRL
   country=BR
   merchant_site_id=142033
   payment_method=apmgw_PayRetailers_Payouts
   merchant_id=427583496191624621
   responseTimeStamp=2021-06-07.07:29:04
   user_token_id=KUGOKLLCP52V
   userPaymentOptionId=8030921
   type=ACCOUNT_CAPTURE
   responsechecksum=dc5d86f3b2248c108b1897bc859cb81c
   advanceResponseChecksum=00c8cb00622ce0dcae6ad443bea56598

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

Follow these steps to perform a payout using Nuvei Web SDK integration:

1. Initiate a Session

Before submitting a payout request using the client-side Nuvei Web SDK, the merchant needs to send an /openOrder request.

2. Initialize the Web SDK

Instantiate the Web SDK with the sessionToken received from the server request to /openOrder.

3. Send an accountCapture() request

a. 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 – See the list of APMs that support account details capture.
• currencyCode
• countryCode

Example accountCapture() Request

sfc.accountCapture({
  sessionToken: "<sessiontoken>",
  merchantId: "<your merchantId>",
  merchantSiteId: "<your merchantSiteId>",
  paymentMethod: "apmgw_<APM provider name>",
  userTokenId: "<unique customer identifier in merchant system>",
  currencyCode: "USD",
  countryCode: "US",
  languageCode: "en",
  urlDetails:{
    successUrl:"<URL the customer is directed to after a successful transaction>",
    pendingUrl:"<URL the customer is directed to when the transaction response is pending>",
    failureUrl:"<URL the customer is directed to after an unsuccessful transaction>",
    notificationUrl:"<URL to which DMNs are sent>"
  },
sourceApplication: "WebSDK"
}, function(accountRes) {
    console.log(accountRes);
})

The response includes a redirectUrl.

Example accountCapture() Response

{
    "redirectUrl": "<redirect URL to enter account details>",
    "userTokenId": "bankCaptureUser4",
    "sessionToken": "e44a932a-e9fc-4482-a570-cf07175408e0",
    "internalRequestId": 23238261,
    "status": "SUCCESS",
    "errCode": 0,
    "reason": "",
    "merchantId": "8256777005602846935",
    "merchantSiteId": "112106",
    "version": "1.0"
}

b. Use the redirectUrl to redirect the customer to the APM’s account details capture interface.

c. After the information is captured, Nuvei stores the data in a UPO record, and sends a DMN back to the merchant with the newly created userPaymentOptionId.

Example DMN

ppp_status=OK
userid=139619531
currency=BRL
country=BR
merchant_site_id=142033
payment_method=apmgw_PayRetailers_Payouts
merchant_id=427583496191624621
responseTimeStamp=2021-06-07.07:29:04
user_token_id=KUGOKLLCP52V
userPaymentOptionId=8030921
type=ACCOUNT_CAPTURE
responsechecksum=dc5d86f3b2248c108b1897bc859cb81c
advanceResponseChecksum=00c8cb00622ce0dcae6ad443bea56598

4. Send a submitWdRequest() request

Send a submitWdRequest() request and include the upoId (the userPaymentOptionId in the DMN), which contains the user’s previously stored APM account details.