Local Bank Payouts

Home    APMs    Local Bank Payouts

On this page:
Attributes
  • METHOD TYPEBank Transfer
  • PAYMENTS
  • PAYOUTS
  • REFUNDS
  • RECURRING

Introduction

This APM provides bank payouts in local currencies for users in many countries around the world.

Supported Countries

  • Andorra
  • Australia
  • Austria
  • Belgium
  • Brazil
  • Bulgaria
  • Canada
  • Chile
  • China
  • Colombia
  • Croatia
  • Cyprus
  • Czech Republic
  • Denmark
  • Ecuador
  • Estonia
  • Finland
  • France
  • Germany
  • Greece
  • Hong Kong
  • Hungary
  • Iceland
  • Indonesia
  • Ireland
  • Italy
  • Japan
  • Kenya
  • Latvia
  • Liechtenstein
  • Lithuania
  • Luxembourg
  • Malaysia
  • Malta
  • Mexico
  • Monaco
  • Netherlands
  • New Zealand
  • Norway
  • Pakistan
  • Peru
  • Philippines
  • Poland
  • Portugal
  • Romania
  • San Marino
  • Singapore
  • Slovakia
  • Slovenia
  • Spain
  • Sri Lanka
  • Sweden
  • Switzerland
  • Thailand
  • United Kingdom
  • United States
  • Vatican City
  • Vietnam
  • Bolivia
  • South Korea

Supported Currencies

  • EUR
  • USD
  • GBP
  • CAD
  • MYR
  • HUF
  • SGD
  • MXN
  • PHP
  • THB
  • IDR
  • PLN
  • UYU
  • CZK
  • BRL
  • COP
  • CLP
  • AUD
  • NZD
  • PEN
  • DKK
  • HKD
  • KRW
  • NOK
  • RON
  • SEK
  • VND
  • CRC
  • PKR
  • JPY
  • BOB
  • KES
  • LKR
  • TZS

Payout (Withdrawal) Flow

To perform a payout with Local Bank Payouts, you need to use the /accountCapture method before sending the /payout API request:

  1. 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_BankPayouts“
Example /accountCapture Request
{
  "sessionToken": "<sessionToken from /getSessionToken>",
  "merchantId": "<your merchantId>",
  "merchantSiteId": "<your merchantSiteId>",
  "userTokenId": "<unique customer identifier in merchant system>",
  "paymentMethod": "apmgw_BankPayouts",
  "currencyCode": "MXN",
  "countryCode": "MX"
}

The request returns a redirectUrl.

Example /accountCapture Response
{
  "reason": "",
  "redirectUrl": "https://devmobile.sccdev-qa.com/banktransfer/index.html?country=MX&amount=1.0&environment=trunk&sessionToken=00e73402d8b5b71b918ea99df106&paymentMethod=BankPayouts&currency=MXN&returnUrl=https%3A%2F%2Fjumpbox.safecharge.com%2Fdmz%2FApmConnector%2FbankCapture%2F8D7B514B2FCEB498B815E691B6B7A8F8&locale=en_MX",
  "merchantId": "2502136204546424962",
  "errCode": 0,
  "sessionToken": "aff5c587-6d76-42f5-bcbe-934209753951",
  "internalRequestId": 35455681,
  "userTokenId": "42WPMSNLOBAT",
  "version": "1.0",
  "status": "SUCCESS",
  "merchantSiteId": "126006"
}
  1. Use redirectUrl to redirect the customer to the APM’s account details capture interface for them to enter their account details.
  2. Once the information is captured, Nuvei stores the data in a userPaymentOptionId identifier, and sends a Direct Merchant Notification (DMN) back to you with the newly created userPaymentOptionId.
  3. 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 Direct Merchant Notification (DMN) that includes the result of the transaction to urlDetails.notificationUrl, which Nuvei recommends including in the /payout request.

Example Payment DMN with Status=APPROVED
...'ppp_status=OK&Status=APPROVED&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=&PPP_TransactionID=36415381&userid=13395001211231112345662222111111111111111111111111&merchant_unique_id=20180327175242&customData=hristo_tr_test&productId=&first_name=&last_name=&email=&currency=EUR&clientUniqueId=20180327175242&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=&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=186111&merchant_status=&action=&requestVersion=&message=APPROVED&merchantLocale=&unknownParameters=&payment_method=apmgw_BankPayouts&ID=&merchant_id=5416795427517477813&responseTimeStamp=2021-10-06.06%3A58%3A56&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=Credit&externalEmail=&cardCompany=&eci=&user_token_id=13395001211231112345662222111111111111111111111111&userPaymentOptionId=8079201&TransactionID=2110000000004602991&externalTransactionId=2130318&totalAmount=10.0&dynamicDescriptor=hristo+descriptor&feeAmount=&houseNumber=&customCurrency=&upoRegistrationDate=20211006&type=DEPOSIT&clientRequestId=&relatedTransactionId=&responsechecksum=6431652ef2fa78c0961e077e12be2e859fad2540a3e89177736b0a24f083d099&advanceResponseChecksum=f62eea1160502eb68bc5bb0135052af8d9f9a6b41dbb0e298867f56182830de3',
Example Payment DMN with Status=DECLINED
...'ppp_status=FAIL&Status=DECLINED&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=&PPP_TransactionID=36418871&userid=1339501211231112345662222111111&merchant_unique_id=20180327175242&customData=hristo_tr_test&productId=&first_name=&last_name=&email=&currency=SEK&clientUniqueId=20180327175242&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=&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=186111&merchant_status=&action=&requestVersion=&message=DECLINED&merchantLocale=&unknownParameters=&payment_method=apmgw_BankPayouts&ID=&merchant_id=5416795427517477813&responseTimeStamp=2021-10-06.13%3A56%3A29&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=Credit&externalEmail=&cardCompany=&eci=&user_token_id=1339501211231112345662222111111&userPaymentOptionId=8078891&TransactionID=2110000000004605553&externalTransactionId=2131501&totalAmount=1.0&dynamicDescriptor=hristo+descriptor&feeAmount=&houseNumber=&customCurrency=&upoRegistrationDate=20211005&type=DEPOSIT&clientRequestId=&relatedTransactionId=&responsechecksum=682bca6cc594d8ce4fdc626173be248d353e9c2705b3ceb7bb42b316c0d714e9&advanceResponseChecksum=0dce7c0296dbd7541a5181487670f7480bca18757a9d75e6ff780b52cb91168a',

Testing

Test credentials and testing scenarios can be provided by Nuvei if necessary. You can contact Nuvei support for assistance.

Last update iconLast modified December 2024