# Configuring CCAvenue

CCAvenue is an auto-settle payment method offering locale India payment options such as Credit Card, Wallet, Net Banking, and UPI.

## Configuring CCAvenue for DigitalRiver.js <a href="#configuring-ccavenue-for-digitalriver.js" id="configuring-ccavenue-for-digitalriver.js"></a>

Create a method for your app or website in four easy steps:

* [​Step 1: Build a CCAvenue Source Request and Details object​](#step-1-build-a-ccavenue-source-request-and-details-object)
* ​[Step 2: Create a CCAvenue source using DigitalRiver.js​](#step-2-create-a-ccavenue-source-using-digitalriver.js)
* [​Step 3: Authorize the CCAvenue authorized source​](#step-3-authorize-the-ccavenue-source)
* [​Step 4: Use the authorized source​](#step-4-use-the-authorized-source)

### Step 1: Build a **CCAvenue** Source Request and Details object

Build the CCAvenue Source Request and Details objects.

#### **CCAvenue** Source Request object

The CCAvenue Source Request object requires the following fields.

| Field       | Value                                                                                                                                |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `type`      | `ccavenue`                                                                                                                           |
| `sessionId` | The payment session identifier                                                                                                       |
| `owner`     | An [Owner object](/commerce-api/payments/payments-solutions/digitalriver.js/payment-methods/common-payment-objects.md#owner-object). |
| `ccavenue`  | A [CCAvenue Source Details object](#ccavenue-source-details-object).                                                                 |

#### **CCAvenue** Source Details object

The CCAvenue Source Details object requires the following fields.

```javascript
{
    "returnUrl": "https://example.com/return",
    "cancelUrl": "https://example.com/cancel"
}
```

The CCAvenue Source Details object requires the following field.

| Field       | Required/Optional | Description                                                                                         |
| ----------- | ----------------- | --------------------------------------------------------------------------------------------------- |
| `returnUrl` | Required          | Where you will redirect your customer after the customer authorizes within the CCAvenue experience. |
| `cancelUrl` | Required          | Where you will redirect your customer after the customer cancels within the CCAvenue experience.    |

### Step 2: Create a **CCAvenue** source using DigitalRiver.js

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

{% hint style="info" %}
CCAvenue's risk policy requires the shopper's phone number (a ten-digit numeric value) in the address object, which cannot be empty. However, Digital River does not validate the phone number.
{% endhint %}

```javascript
let ccavenueSourceData = {
    "type": "ccavenue",
    "sessionId": "3c9473b0-630d-4f20-af61-63d3aa8acb35",
    "owner": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@digitalriver.com",
        "phoneNumber": "1306372509",
        "address":{
            "line1":"34th Floor, Promod Industrial Estate, Western X-highway, B/h Kohinoor Ind Est, Goregaon (e)",
            "line2":"",
            "city":"Mumbai",
            "state":"Maharashtra",
            "postalCode":"400063",
            "country":"IN"
        }
    },
    "ccavenue": {
        "returnUrl": "https://example.com/return",
        "cancelUrl": "https://example.com/cancel"
    }
}
 
digitalriver.createSource(ccavenueSourceData).then(function(result) {
    if (result.error) {
        //handle errors as something went wrong
    } else {
        var source = result.source;
     
        //do something with the created source
    }
});
```

#### **CCAvenue** source example

```javascript
{
    "clientId": "gc",
    "channelId": "drdod15",
    "liveMode": false,
    "id": "5ce08114-143b-4bf6-ae0e-6fc501ee0c24",
    "clientSecret": "5ce08114-143b-4bf6-ae0e-6fc501ee0c24_a468b08e-2c47-4531-82af-d48d80ff6dcc",
    "type": "ccavenue",
    "reusable": false,
    "owner": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@digitalriver.com",
        "phoneNumber": "13063725095",
        "address":{
            "line1":"34th Floor, Promod Industrial Estate, Western X-highway, B/h Kohinoor Ind Est, Goregaon (e)",
            "line2":"",
            "city":"Mumbai",
            "state":"Maharashtra",
            "postalCode":"400063",
            "country":"IN"
        }
    },
    "amount": "10.00",
    "currency": "INR",
    "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": "https://example.com/return",
        "cancelUrl": "https://example.com/cancel"
    },
    "ccavenue": {}
}
```

#### Payment options

CCAvenue offers multiple payment options. The `bankCode` identifies the payment options and determines the value of the `subType` field.

The `bankCode` value will be used as the `subType` unless the `bankCode` is `"Credit Card"`, then the `bankName` will be used as the `subType`.

{% code title="Credit Card" %}

```javascript
"ccavenue": {

    "bankReferenceNumber": "1634229024157",
    "accountToken": "71826934100000000000000575766005",
    "trackingId": "310007639563",
    "subType": "Visa",
    "bankName": "Visa",
    "bankCode": "Credit Card",
    "orderStatus": "Success"
}
```

{% endcode %}

{% code title="Net Banking" %}

```json
"ccavenue": {
    "bankReferenceNumber": "1634229110338",
    "accountToken": "71826934100000000000000575766005",
    "trackingId": "310007639565",
    "subType": "Net Banking",
    "bankName": "AvenuesTest",
    "bankCode": "Net Banking",
    "orderStatus": "Success"
}
```

{% endcode %}

{% code title="Wallet" %}

```json
"ccavenue": {
    "bankReferenceNumber": "1634229189578",
    "accountToken": "71826934100000000000000575766005",
    "trackingId": "310007639569",
    "subType": "Wallet",
    "bankName": "AvenuesTest",
    "bankCode": "Wallet",
    "orderStatus": "Success"
}
```

{% endcode %}

{% code title="UPI" %}

```json
"ccavenue": {
    "bankReferenceNumber": "377494",
    "accountToken": "71826934100000000000000575766005",
    "trackingId": "310007639571",
    "subType": "Unified Payments",
    "bankName": "UPI",
    "bankCode": "Unified Payments",
    "orderStatus": "Success"
}

```

{% endcode %}

| Field                 | Optional/Required | Description                                          |
| --------------------- | ----------------- | ---------------------------------------------------- |
| `bankReferenceNumber` | Required          | The bank reference nubmer for the shopper's account. |
| `accountToken`        | Required          | The shopper's account token.`trackingId`             |
| `trackingId`          | Required          | The tracking identifier for the order.               |

### Step 3: Authorize the **CCAvenue** source

When you create a CCAvenue 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 **CCAvenue** authorization

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

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

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

Once authorized, the source state will change to `chargeable`.

### Step 4: Use the authorized source

Once authorized, you can use the source by [attaching it to a cart](/commerce-api/payments/sources.md#attaching-a-payment-method-to-an-order-or-cart) or [a customer](/commerce-api/payments/sources.md#attaching-source-to-a-customer).

#### Option 1: Attach the source to the cart

{% tabs %}
{% tab title="POST /v1/shoppers/me/carts/active/apply-payment-method" %}

```javascript
{  
   "paymentMethod": {    
      "sourceId": "5ce08114-143b-4bf6-ae0e-6fc501ee0c24"
   }
}
```

{% endtab %}
{% endtabs %}

#### Option 2: Attach the source to a customer

{% tabs %}
{% tab title="POST /v1/shoppers/me/payment-options" %}

```javascript
{
  "paymentOption": {
    "nickName": "My Visa Card",
    "isDefault": "true",
    "sourceId": "5ce08114-143b-4bf6-ae0e-6fc501ee0c24"
  }
}
```

{% endtab %}
{% endtabs %}

## Testing CCAvenue

See [Testing the CCAvenue payment method](/commerce-api/payments/testing-scenarios.md#testing-the-ccavenue-payment-method) for testing instructions.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.digitalriver.com/commerce-api/payments/payments-solutions/digitalriver.js/payment-methods/configuring-ccavenue.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.