Configuring Alipay (domestic)

Learn how to configure Alipay (domestic) for DigitalRiver.js with Elements

If you're using DigitalRiver.js with Elements, you can create an Alipay (domestic) payment method for your app or website in four easy steps:

• Step 1: Alipay (domestic) Source Details object

• Step 2: Create the Alipay (domestic) source using DigitalRiver.js

• Step 3: Authorize an Alipay (domestic) source

• Step 4: Use the Authorized source

Step 1: Build an Alipay (domestic) source request object

Build an Alipay (domestic) Source Request object. The Alipay Source Request object requires the following fields.

Field	Value
type	alipay
sessionId	The payment session identifier.
owner	An Owner object.
alipay	An Alipay (domestic) Source Details object that includes the details of the transaction.

Alipay (domestic) source details object

{
    "returnUrl": "https://example.com"
}

Field	Required/Optional	Description
returnUrl	Required	Where you will redirect your customer after the customer authorizes or cancels within the Alipay (domestic) experience.

Step 2: Create the Alipay (domestic) source using DigitalRiver.js

Use the DigitalRiver.js library to create and mount elements to the HTML container.

The address object must contain postal code and state/province data that adheres to a standardized format using the state attribute. Note that the state attribute listed below corresponds to the countrySubdivision attribute used when providing address information. The payment session manages the correct field name on the backend.

let alipaySourceData = {
                "type": "alipay",
                "sessionId": "3c9473b0-630d-4f20-af61-63d3aa8acb35",
                "owner": {
                    "firstName": "Donglei",
                    "lastName": "Ye",
                    "email": "[email protected]",
                    "phoneNumber": "13063725095",
                    "address": {
                        "line1": "Wei Bai Chang",
                        "city": "ShunDe District)",
                        "state": "Guangdong",
                        "country": "CN",
                        "postalCode": "528322"
                    }
                },
                "alipay": {
                    "returnUrl": redirectUrl
                }
            }
 
digitalriver.createSource(alipaySourceData ).then(function(result) {
    if (result.error) {
        //handle errors as something went wrong
    } else {
        var source = result.source;
     
        //do something with the created source
    }
});

Alipay (domestic) source example

{
    "clientId": "gc",
    "channelId": "drdod15",
    "liveMode": false,
    "id": "5ce08114-143b-4bf6-ae0e-6fc501ee0c24",
    "clientSecret": "5ce08114-143b-4bf6-ae0e-6fc501ee0c24_a468b08e-2c47-4531-82af-d48d80ff6dcc",
    "type": "alipay",
    "reusable": false,
    "owner": {
        "firstName": "Donglei",
        "lastName": "Ye",
        "email": "[email protected]",
        "phoneNumber": "13063725095",
        "address": {
            "line1": "Wei Bai Chang",
            "city": "ShunDe District)",
            "state": "Guangdong",
            "country": "CN",
            "postalCode": "528322"    
        }
    },
    "amount": "10.00",
    "currency": "CNY",
    "state": "pending_redirect",
    "creationIp": "10.81.3.92",
    "createdTime": "2020-02-26T02:48:11.508Z",
    "updatedTime": "2020-02-26T02:48:11.508Z",
    "flow": "redirect",
    "redirect": {
        "redirectUrl": "https://api.digitalriverws.com:443/payments/redirects/51314834-9bf9-483f-b3a7-4b36a14d3f5c?apiKey=pk_hc_e03ee62c0d964bb3ac75595b1203d13c",
        "returnUrl": "returnUrl.com"
    },
    "alipay": {}
}

Step 3: Authorize an Alipay (domestic) source

When you create an Alipay (domestic) source, the customer must authorize the charge through their payment provider. You can accomplish this by redirecting the customer to their payment provider.

Redirecting the customer for authorization

Use the redirectUrl parameter in your createResource response to redirect your customer to the payment provider for authorization.

window.location.href = sourceResponse.redirect.redirectUrl;

The payment provider will present the customer with the transaction details to authorize or cancel the transaction. A successful authorization redirects the customer to the Alipay Return URL parameter you specified when you created the source.

Step 4: Use the authorized source

Once authorized, you can use the source by attaching it to a cart.

POST /v1/shoppers/me/carts/active/apply-payment-method

{
  "paymentMethod": {
    "sourceId": "e7ba0595-059c-460c-bad8-2812123b9313"
  }

Testing Alipay (domestic)

See Testing redirect payment methods for testing instructions.