Attributes

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

Introduction

The Local Currency Payouts APM provides bank payouts processed in the local currencies of a number of European, Asian, and North American countries.

Supported Countries

• Australia
• Bangladesh
• Canada
• Czech Republic
• Hong Kong
• Hungary
• India
• Japan
• New Zealand
• Philippines
• Poland
• Romania
• Singapore
• Thailand
• United Kingdom
• South Korea

Supported Currencies

• AUD
• BDT
• CAD
• CZK
• HKD
• HUF
• INR
• JPY
• NZD
• PHP
• PLN
• RON
• SGD
• THB
• GBP
• KRW

Payout (Withdrawal) Flow

To perform a payout with Local Currency Payouts, you need to use the /accountCapture method before sending the /payout 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_Local_Currency_Payouts“
   • currencyCode – 3-letter ISO currency code for a supported currency.
   • countryCode – 2-letter ISO country code for a supported country. The country must be where the currency is used.
     
     

     Example /accountCapture Request

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

     The request returns a redirectUrl.

     Example /accountCapture Response

     {
       "redirectUrl":"https://apmtest.gate2shop.com/ppp/resources/cdn/v1/bank-details-20050.html?locale=en_US&submitUrl=https://jumpbox.safecharge.com/dmz/SmartConnector/BankCapture/2616240605684098A1E555111F2CF3C6&firstName=Test&lastName=Test&country=GB&address=TestStreet&city=Madrid&currency=GBP&disablePrePopulatedFields=0",
       "userTokenId":"test0202",
       "sessionToken":"2cf95c21-5b01-4e81-b400-29ea73ddf5cc",
       "internalRequestId":604246858,
       "status":"SUCCESS",
       "errCode":0,
       "reason":"",
       "merchantId":"221195993304907999",
       "merchantSiteId":"232618",
       "version":"1.0"
     }

2. Use the redirectUrl to redirect the customer to an account details capture interface for them to enter their account details.
3. Once the information is captured, Nuvei stores the data in a userPaymentOptionId (UPO) identifier, and sends a DMN with the newly created userPaymentOptionId.
4. Send a /payout request and include the userPaymentOptionId. 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.

Test Data

(PHP) Philippine Peso & (PH) Philippines

account_number: “12345678910”
bank_bic: “BOPIPHMM”
bank_name: “BPI Bank of the Philippine Islands”

(AUD) Australian Dollar & (AU) Australia

account_number: “376270164”
bank_clearing_system_id: “012005”

(JPY) Yen & (JP) Japan

account_number: “2763206”
bank_clearing_system_id: “0036224”
bank_name: “楽天銀行”

(THB) Baht & (TH) Thailand

account_number: “9999123456”
bank_bic: “SICOTHBK”
bank_name: “Siam Commercial Bank”

(NZD) New Zealand Dollar & (NZ) New Zealand

account_number: “376270164”
bank_bic: “ANZBNZ22”
bank_clearing_system_id: “011131”
bank_name: “ANZ Bank New Zealand”

(INR) Indian Rupee & (IN) India

account_number: “75945611”
bank_clearing_system_id: “ICIC0000798”
bank_name: “ICICI BANK LTD”

(GBP) Pound Sterling & (GB) United Kingdom

account_number: “98016101”
bank_clearing_system_id: “231470“