** REVISE PAYMENT METHOD NAME**

**check line separators**

Attributes

• 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

REST API

Payment (Deposit) Flow

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:

• userTokenId
• amount
• currency
• paymentOption.alternativePaymentMethod class containing:
  • paymentMethod: “apmgw_ECNY“
  • account_id
• deviceDetails class containing: ipAddress
• billingAddress class containing: firstName, lastName, country, email
• userDetails class 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_ECNY",
      "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.

Web SDK

Payment (Deposit) Flow

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.alternativePaymentMethod class containing:
  • paymentMethod: “apmgw_ECNY“
  • account_id
• deviceDetails class containing: ipAddress
• billingAddress class containing: firstName, lastName, country, email
• userDetails class containing: firstName, lastName, country, email

Example createPayment() Request

**change payment method in sample**

sfc.createPayment({

  sessionToken: '<sessiontoken>',
  paymentOption: {
    alternativePaymentMethod: {
      paymentMethod: 'apmgw_ECNY',
      account_id: '<ECNY account>'
    },
    subMethod: {
      subMethod: 'ECNYTap'
    }
  },
  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.

Payment Page

Payment (Deposit) Flow

Example Payment Page Request

REPLACE THIS? see QA TEST SHEET

https://ppp-test.safecharge.com/ppp/purchase.do?merchant_id=5970183043540730700&merchant_site_id=238459&user_token=auto&user_token_id=TestECNY&item_open_amount_1=false&item_min_amount_1=1&item_max_amount_1=410000&item_name_1=Cashier%20Test%20product&item_amount_1=10&item_quantity_1=1&item_discount_1=0&numberofitems=1&total_tax=0&discount=0&total_amount=10.00&currency=CNY&version=4.0.0&encoding=UTF-8&first_name=test&last_name=test&address1=test&city=test&zip=123456&country=AU&phone1=123456&email=TestECNY%40gmail.com&time_stamp=&checksum=04b4f802f2f83c7cbf7936a5702a0fd7&

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

Payment (Deposit) Flow

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)

**Is this section needed?**

To offer customers the option to skip the payment confirmation page for future payments, include in the checkout() request:

• savePm: “always“, “true“, or “force” – Fast flow requires a saved payment method. Other possible savePm values do not support fast flow.
• apmConfig class containing:
  • apmgw_ECNY class containing:
    • fastFlow: true
• subMethod: [“ReferenceTransaction”,”AliasRegistration”,”ECNY1Tap”] – Array of submethods that support fast flow.

checkout ({...
    savePm: 'true',
    apmConfig: {
        apmgw_ECNY: {
            fastFlow: true
        },
    },
    subMethod: ["ReferenceTransaction","AliasRegistration","ECNYTap"],...
});

User Experience

add content

Testing

add content