Attributes
- METHOD TYPEBank Transfer
- PAYMENTS
- PAYOUTS
- REFUNDS
- RECURRING
Introduction
The Bank Payouts APM provides real-time and same-day withdrawals for users with bank accounts in Malaysia and Brunei.
Supported Countries
- Malaysia
- Brunei
Supported Currencies
- MYR
- BND
Payout (Withdrawal) Flow
To perform a payout with Bank 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_Local_Payouts“currencyCode
: “MYR“countryCode
: “MY“
Example
/accountCapture
Request{ "sessionToken": "<sessionToken from /getSessionToken>", "merchantId": "<your merchantId>", "merchantSiteId": "<your merchantSiteId>", "userTokenId": "<unique customer identifier in merchant system>", "paymentMethod": "apmgw_Local_Payouts", "currencyCode": "MYR", "countryCode": "MY" }
The request returns a
redirectUrl
.Example
/accountCapture
Response{ "internalRequestId": 38178551, "status": "SUCCESS", "errCode": 0, "reason": "", "merchantId": "5416795427517477813", "merchantSiteId": "186111", "version": "1.0", "sessionToken": "1ccd14df-dcdb-43f6-b874-6d6beeaf5779", "redirectUrl": "https://apmtest.gate2shop.com/ppp/resources/cdn/v1/bank-details-618843.html?country=MY&submitUrl=https://jumpbox.safecharge.com/dmz/SmartConnector/BankCapture/EDE8DA0E651BE15FC66221FAD0BDF5E2&firstName=JAKE&lastName=ISKANDAR MARR&mobileNumber=&bankCode=&accountNumber=&mode=1", "userTokenId": "LP_OM00001" }
- Use
redirectUrl
to redirect the customer to an account details capture page for them to enter their account details.
Once the information is captured, Nuvei stores the data in auserPaymentOptionId
(UPO) identifier, and sends a Direct Merchant Notification (DMN) back to the user with the newly createduserPaymentOptionId
.which Nuvei recommends including in the/accountCapture
request - Send a
/payout
request and include theuserPaymentOptionId
, 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 urlDetails.notificationUrl
, which Nuvei recommends including in the /payout
request.
Testing
Test credentials and testing scenarios can be provided by Nuvei if necessary. You can contact Nuvei support for assistance.