- METHOD TYPEBank Transfer
- PAYMENTS
- PAYOUTS
- REFUNDS
- RECURRING
Introduction
Single Euro Payments Area (SEPA) Payouts is used throughout Europe for withdrawals. The Verified SEPA Payouts APM provider uses an algorithm to compare the name provided by the user with the real name provided by the bank and generates a match score.
Supported Countries
- Austria
- Belgium
- Finland
- France
- Germany
- Italy
- Lithuania
- Netherlands
- Spain
- Sweden
Supported Currencies
- EUR
Payout (Withdrawal) Flow
To perform a payout with Verified SEPA Payouts, you need to use the /accountCapture
method before sending the /payout
request:
- Generate a
sessionToken
. Press here for details. - Send an
/accountCapture
request with all of its mandatory parameters, including:userTokenId
– Unique customer identifier in merchant system.paymentMethod
: “apmgw_Verified_SEPA_Payouts“currencyCode
: “EUR“countryCode
Example
/accountCapture
Request{ "sessionToken": "<sessionToken from /getSessionToken>", "merchantId": "<your merchantId>", "merchantSiteId": "<your merchantSiteId>", "userTokenId": "<unique customer identifier in merchant system>", "paymentMethod": "apmgw_Verified_SEPA_Payouts", "currencyCode": "EUR", "countryCode": "<2-letter ISO country code>" }
The request returns a
redirectUrl
.Example
/accountCapture
Response{ "internalRequestId": 42104051, "status": "SUCCESS", "errCode": 0, "reason": "", "merchantId": "1102398682906145682", "merchantSiteId": "228311", "version": "1.0", "sessionToken": "7b8a7498-9010-4354-872a-054eff611f43", "redirectUrl": "<redirect URL>", "userTokenId": "77ssss7777777" }
- Use
redirectUrl
to redirect the user to their bank’s website where they log in. - Once the information is captured, Nuvei stores the data in a
userPaymentOptionId
(UPO) identifier, and sends a Direct Merchant Notification (DMN) with the newly createduserPaymentOptionId
tourlDetails.notificationUrl
, which Nuvei recommends including in the/accountCapture
request.
If the merchant is not collecting the IBAN from users and a user has more than one IBAN with the bank, Nuvei creates the UPO using the first IBAN in the list. Using theapmPayerInfo
information in the DMN, create an IBAN selection page. If the user selects a different IBAN than the IBAN Nuvei stored for the UPO, send an/editUPOAPM
request to change the IBAN for the UPO.Example
/accountCapture
DMN...'ppp_status=OK&ExErrCode=&ErrCode=&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=&PPP_TransactionID=&userid=140059111&merchant_unique_id=&customData=&productId=&first_name=&last_name=&email=¤cy=EUR&customField1=&customField2=&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=&address2=&country=DE&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_SEPA_Payouts&ID=&merchant_id=1102398682906145682&responseTimeStamp=2024-07-08.11%3A20%3A21&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=&externalEmail=&cardCompany=&eci=&user_token_id=77ssss7777777&userPaymentOptionId=2153282131&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+Smith%22%2C%22swift_bic%22%3A%22CPBKGB00%22%2C%22account_number%22%3A%2210000000%22%2C%22sort_code%22%3A%2201-21-31%22%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%7D%5D&responsechecksum=eb3501a6e6f06b8ee3cd6982839d378c&advanceResponseChecksum=107acd3d680818be7bdf6eb48c9b57d0&',
- 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 /payout
DMN with Status
=APPROVED
...'ppp_status=OK&ExErrCode=&ErrCode=&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=&PPP_TransactionID=&userid=140059111&merchant_unique_id=&customData=&productId=&first_name=&last_name=&email=¤cy=EUR&customField1=&customField2=&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=&address2=&country=DE&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_SEPA_Payouts&ID=&merchant_id=1102398682906145682&responseTimeStamp=2024-07-08.11%3A20%3A21&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=&externalEmail=&cardCompany=&eci=&user_token_id=77ssss7777777&userPaymentOptionId=2153282131&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%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%7D%5D&responsechecksum=eb3501a6e6f06b8ee3cd6982839d378c&advanceResponseChecksum=107acd3d680818be7bdf6eb48c9b57d0&',
User Experience
- The user is redirected to the provider’s website and selects a country.
- The user selects a bank.
- In some cases, the user selects a bank branch.
- The user connects the bank account to the provider by granting one-time access.
- The user is redirected to the bank’s website, logs in, and approves permission. For example, Sparkasse:
- The withdrawal request is submitted and processed by Nuvei and the APM.
Testing
Test credentials and testing scenarios can be provided by Nuvei if necessary. You can contact Nuvei support for assistance.