Attributes

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

Introduction

Single Euro Payments Area (SEPA) Payouts is used throughout Europe for withdrawals.

Supported Countries

• Andorra
• Austria
• Belgium
• Bulgaria
• Croatia
• Cyprus
• Czech Republic
• Denmark
• Estonia
• Finland
• France
• Germany
• Greece
• Hungary
• Iceland
• Ireland
• Italy
• Latvia
• Liechtenstein
• Lithuania
• Luxembourg
• Malta
• Monaco
• Netherlands
• Norway
• Poland
• Portugal
• Romania
• San Marino
• Slovakia
• Slovenia
• Spain
• Sweden
• Switzerland
• United Kingdom
• Vatican City

Supported Currencies

• EUR

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.

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

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

Example /createUser Request

{
  "merchantId":"<your merchantId>",
  "merchantSiteId":"<your merchantSiteId>",
  "clientRequestId":"<unique request ID in merchant system>",
  "userTokenId":"<unique user identifier in merchant system>",
  "countryCode":"GB",
  "email":"[email protected]",
  "firstName":"John",
  "lastName":"Smith",
  "dateOfBirth":"2000-06-30",
  "address":"1 Hardwick Street",
  "city":"London",
  "zip":"EC1R"
  "timeStamp":"<YYYYMMDDHHmmss>",
  "checksum":"<calculated checksum>"
}

The request registers the userTokenId in the Nuvei system, which is then used to generate a UPO in the next step

Example /createUser Response

{
  "userId":78403498,
  "internalRequestId":552360538,
  "status":"SUCCESS",
  "errCode":0,
  "reason":"",
  "merchantId":"2439523627382132721",
  "merchantSiteId":"224428",
  "version":"1.0",
  "clientRequestId":"20221108130736"
}

After the transaction is processed, Nuvei sends a Direct Merchant Notification (DMN) that includes the result of the transaction to the URL provided in urlDetails.notification, which Nuvei recommends including in the /createUser request.

2. Create the UPO

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

• userTokenId – The unique user identifier in your system.
• paymentMethodName: “apmgw_SEPA_Payouts“
• apmData class containing:
  • IBAN – User’s IBAN
• billingAddress class containing: country and email

Example /addUPOAPM Request

{
  "merchantId":"<your merchantId>",
  "merchantSiteId":"<your merchantSiteId>",
  "userTokenId":"<unique customer identifier in merchant system>",
  "clientRequestId":"<unique request ID in merchant system>",
  "paymentMethodName":"apmgw_SEPA_Payouts",
  "apmData":{
    "IBAN":"GB10CLRB04066800015427"
  },
  "billingAddress":{
    "country":"GB",
    "email":"[email protected]",
  },
  "timeStamp":"<YYYYMMDDHHmmss>",
  "checksum":"<calculated checksum>"
}

The request returns an encrypted userPaymentOptionId (UPO) representing the user’s APM account details.

Example /addUPOAPM Response

{
  "reason":"",
  "merchantId":"2502136204546424962",
  "errCode":0,
  "clientRequestId":"HWMTWQ2RT",
  "userPaymentOptionId":8119601,
  "internalRequestId":17817221,
  "version":"1.0",
  "status":"SUCCESS",
  "merchantSiteId":"126006"
}

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.notification, which Nuvei recommends including in the /payout request.