- METHOD TYPEE-wallet
- PAYMENTS
- PAYOUTS
- REFUNDS
- RECURRING
Introduction
e-CNY is an offline payment solution. The e-CNY app enables a user to transfer funds into an account that displays on OFAPAY redirect page.
Supported Countries
- China
Supported Currencies
- CNY
Payment (Deposit) Flow
** REMOVE WITHDRAWAL FLOW CONTENT without affecting tabs**
** REVISE PAYMENT METHOD NAME**
Press tab to open…
Follow these steps to perform a payment using Nuvei REST API integration:
1. Generate a sessionToken
Press here for details.
2. Send a /payment Request
Perform the payment by sending a /payment request with its mandatory parameters including:
userTokenIdamountcurrencypaymentOption.alternativePaymentMethodclass containing:paymentMethod: “apmgw_MoneyBookers“account_id
deviceDetailsclass containing:ipAddressbillingAddressclass containing:firstName,lastName,country,emailuserDetailsclass containing:firstName,lastName,country,email
Example /payment Request
{
"sessionToken":"<sessionToken from /getSessionToken>",
"merchantId":"<your merchantId>",
"merchantSiteId":"<your merchantSiteId>",
"clientRequestId":"<unique request ID in merchant system>",
"amount":"200",
"currency":"USD",
"userTokenId":"<unique customer identifier in merchant system>",
"clientUniqueId":"<unique transaction ID in merchant system>",
"paymentOption":{
"alternativePaymentMethod":{
"paymentMethod":"apmgw_MoneyBookers",
"account_id":"<Skrill account>"
}
},
"deviceDetails":{
"ipAddress":"<customer's IP address>"
},
"billingAddress":{
"firstName": "John",
"lastName": "Smith",
"country":"US",
"email":"[email protected]"
},
"userDetails":{
"firstName": "John",
"lastName": "Smith",
"country":"US",
"email":"[email protected]"
},
"timeStamp":"<YYYYMMDDHHmmss>",
"checksum":"<calculated checksum>"
}
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.notificationUrl, which Nuvei recommends including in the /payment request.
Payout (Withdrawal) Flow
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.notificationUrl, which Nuvei recommends including in the /payout request.
Follow these steps to perform a payment using Nuvei Web SDK integration.
1. Initiate a Session
Before you can submit payment using the client-side Nuvei Web SDK, you need to send the /openOrder API call.
2. Initialize the Web SDK
Instantiate the Web SDK with the sessionToken received from the server call to /openOrder.
3. Create an APM Payment
Send a createPayment() request with its mandatory parameters including:
paymentOption.alternativePaymentMethodclass containing:paymentMethod: “apmgw_MoneyBookers“account_id
deviceDetailsclass containing:ipAddressbillingAddressclass containing:firstName,lastName,country,emailuserDetailsclass containing:firstName,lastName,country,email
Example createPayment() Request
sfc.createPayment({
sessionToken: '<sessiontoken>',
paymentOption: {
alternativePaymentMethod: {
paymentMethod: 'apmgw_MoneyBookers',
account_id: '<Skrill account>'
},
subMethod: {
subMethod: 'skrill1Tap'
}
},
deviceDetails: {
ipAddress: "<customer's IP address>"
},
billingAddress: {
firstName: 'John',
lastName: 'Smith',
country: 'US',
email: '[email protected]'
},
userDetails: {
firstName: 'John',
lastName: 'Smith',
country: 'US',
email: '[email protected]'
}
}, function (res) {
console.log(res)
})
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.notificationUrl, which Nuvei recommends including in the /openOrder request.
Withdrawal Flow
For information about the Withdrawal flow for WebSDK, see Withdrawal.
Example Payment Page Request
After the transaction is processed, Nuvei sends a Direct Merchant Notification (DMN) that includes the result of the transaction to notify_url, which Nuvei recommends including in the request.
To perform a payment using Nuvei Simply Connect integration:
1. Initiate a Session
Before submitting a Simply Connect payment request, you need to submit a server-side /openOrder API request.
2. Create an HTML Placeholder
Import the checkout.js library for building payment flows and create an HTML placeholder on your payment page for the Simply Connect UI element.
3. Submit a checkout() Request
Send a checkout() request with its mandatory input parameters, along with any other relevant parameters and customizations. For more information, see Quick Start to Simply Connect.
Fast Flow (Optional)
To offer customers the option to skip the PayPal payment confirmation page for future payments, include in the checkout() request:
savePm: “always“, “true“, or “force” – Fast flow requires a saved payment method. Other possiblesavePmvalues do not support fast flow.apmConfigclass containing:apmgw_MoneyBookersclass containing:fastFlow: true
subMethod: [“ReferenceTransaction”,”AliasRegistration”,”Skrill1Tap”] – Array of submethods that support fast flow.
checkout ({...
savePm: 'true',
apmConfig: {
apmgw_MoneyBookers: {
fastFlow: true
},
},
subMethod: ["ReferenceTransaction","AliasRegistration","Skrill1Tap"],...
});
- REST API
-
Follow these steps to perform a payment using Nuvei REST API integration:
1. Generate a
sessionTokenPress here for details.
2. Send a
/paymentRequestPerform the payment by sending a
/paymentrequest with its mandatory parameters including:userTokenIdamountcurrencypaymentOption.alternativePaymentMethodclass containing:paymentMethod: “apmgw_MoneyBookers“account_id
deviceDetailsclass containing:ipAddressbillingAddressclass containing:firstName,lastName,country,emailuserDetailsclass containing:firstName,lastName,country,email
Example
/paymentRequest{ "sessionToken":"<sessionToken from /getSessionToken>", "merchantId":"<your merchantId>", "merchantSiteId":"<your merchantSiteId>", "clientRequestId":"<unique request ID in merchant system>", "amount":"200", "currency":"USD", "userTokenId":"<unique customer identifier in merchant system>", "clientUniqueId":"<unique transaction ID in merchant system>", "paymentOption":{ "alternativePaymentMethod":{ "paymentMethod":"apmgw_MoneyBookers", "account_id":"<Skrill account>" } }, "deviceDetails":{ "ipAddress":"<customer's IP address>" }, "billingAddress":{ "firstName": "John", "lastName": "Smith", "country":"US", "email":"[email protected]" }, "userDetails":{ "firstName": "John", "lastName": "Smith", "country":"US", "email":"[email protected]" }, "timeStamp":"<YYYYMMDDHHmmss>", "checksum":"<calculated checksum>" }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.notificationUrl, which Nuvei recommends including in the/paymentrequest.Payout (Withdrawal) Flow
Send a
/payoutrequest 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 the URL provided in
urlDetails.notificationUrl, which Nuvei recommends including in the/payoutrequest. - Web SDK
-
Follow these steps to perform a payment using Nuvei Web SDK integration.
1. Initiate a Session
Before you can submit payment using the client-side Nuvei Web SDK, you need to send the
/openOrderAPI call.2. Initialize the Web SDK
Instantiate the Web SDK with the
sessionTokenreceived from the server call to/openOrder.3. Create an APM Payment
Send a
createPayment()request with its mandatory parameters including:paymentOption.alternativePaymentMethodclass containing:paymentMethod: “apmgw_MoneyBookers“account_id
deviceDetailsclass containing:ipAddressbillingAddressclass containing:firstName,lastName,country,emailuserDetailsclass containing:firstName,lastName,country,email
Example
createPayment()Requestsfc.createPayment({ sessionToken: '<sessiontoken>', paymentOption: { alternativePaymentMethod: { paymentMethod: 'apmgw_MoneyBookers', account_id: '<Skrill account>' }, subMethod: { subMethod: 'skrill1Tap' } }, deviceDetails: { ipAddress: "<customer's IP address>" }, billingAddress: { firstName: 'John', lastName: 'Smith', country: 'US', email: '[email protected]' }, userDetails: { firstName: 'John', lastName: 'Smith', country: 'US', email: '[email protected]' } }, function (res) { console.log(res) })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.notificationUrl, which Nuvei recommends including in the/openOrderrequest.Withdrawal Flow
For information about the Withdrawal flow for WebSDK, see Withdrawal.
- Payment Page
-
Example Payment Page Request
After the transaction is processed, Nuvei sends a Direct Merchant Notification (DMN) that includes the result of the transaction to
notify_url, which Nuvei recommends including in the request. - Simply Connect
-
To perform a payment using Nuvei Simply Connect integration:
1. Initiate a Session
Before submitting a Simply Connect payment request, you need to submit a server-side
/openOrderAPI request.2. Create an HTML Placeholder
Import the
checkout.jslibrary for building payment flows and create an HTML placeholder on your payment page for the Simply Connect UI element.3. Submit a
checkout()RequestSend a
checkout()request with its mandatory input parameters, along with any other relevant parameters and customizations. For more information, see Quick Start to Simply Connect.Fast Flow (Optional)
To offer customers the option to skip the PayPal payment confirmation page for future payments, include in the
checkout()request:savePm: “always“, “true“, or “force” – Fast flow requires a saved payment method. Other possiblesavePmvalues do not support fast flow.apmConfigclass containing:apmgw_MoneyBookersclass containing:fastFlow: true
subMethod: [“ReferenceTransaction”,”AliasRegistration”,”Skrill1Tap”] – Array of submethods that support fast flow.
checkout ({... savePm: 'true', apmConfig: { apmgw_MoneyBookers: { fastFlow: true }, }, subMethod: ["ReferenceTransaction","AliasRegistration","Skrill1Tap"],... });After the transaction is processed, Nuvei sends a DMN that includes the result of the transaction.
User Experience
add content
Testing
add content