# Visa Digital Enablement Lite App

## URL Generation API

### Generate VDE Lite app URL  v1 - Latest

Create app clip or instant app URL for given payload.

#### Request

##### header Parameters

|     |     |
| --- | --- |
| x-client-id<br>required | string<br>VDP client ID via Service Context<br>Example: 86da0f74-19f0-4a20-9dde-3e83dfa6bf83 |

##### Request Body schema: application/json

|     |     |
| --- | --- |
| appId<br>required | string<br>Issuer application Id.<br>Example: "50c7e5ac-1e75-4faa-9a27-9882592eff43" |
| emailLookupEnable | boolean<br>Enable search by email.<br>Example: true |
| payload | object or object |
| One of:

objectobject

|     |     |
| --- | --- |
| accountNumber<br>required | string<br>Full card number. |
| cardBrand<br>required | string<br>Valid values are: VISA, MC. |
| cardType<br>required | string<br>Valid values are: DEBIT, CREDIT, PREPAID. |
| expirationMonth<br>required | string<br>Month when the card is set to expire (e.g. 02 for Feb). |
| expirationYear<br>required | string<br>Year when the card is set to expire (e.g. 2023). |
| nameOnAccount<br>required | string<br>Full name on the card (Must use UTF-8 characters). |
| billingAddress | object |
| |     |     |
| --- | --- |
| addressLine1<br>required | string <= 256 characters <br>Line 1 of the billing address (Must use UTF-8 characters) |
| city<br>required | string <= 100 characters <br>City of the billing address (e.g. New York), no special characters. |
| countryCode<br>required | string<br>Must be in ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 or ISO 3-digit numeric format (Recommend ISO 3166-1 alpha-2 format, e.g. US). |
| phoneNumber<br>required | string<br>Cardholder phone number without country code, spaces and special characters (e.g. 6503334444). |
| postalCode<br>required | string<br>U.S.: 5-digit numeric value (e.g. 94100). Canada: 6-digit alphanumeric value (e.g. M4B1B3). Other countries: 5-16 digit alphanumeric value without special characters. |
| stateProvinceCode<br>required | string<br>Must be in ISO 3166-2 format, alphabetic value with max length of 3 characters, with no dashes or spaces. |
| addressLine2 | string <= 256 characters <br>Line 2 of the address, which usually corresponds to apartment, suite, etc. (Must use UTF-8 characters) |
| addressLine3 | string <= 256 characters <br>Line 3 of the address (Must use UTF-8 characters) |  
| source | string<br>Optional for Single-Use clients. Required for Multi-Use/Channel Partner clients. |
| user | object |
| |     |     |
| --- | --- |
| email | string<br>The user’s email address, which will be used to identify the user’s existing account or user profile or to establish a new account or user profile (e.g. [JOHNSMITH@email.com](mailto:JOHNSMITH@email.com)). |
| firstname | string<br>The user’s First Name (e.g. JOHN). |
| lastname | string<br>The user’s Last Name (e.g. SMITH). |
| locale | string<br>Locale code (en-US)- It helps to identify the locale to be selected for email notifications. |
| phoneNumber | string<br>Cardholder phone number including country code, without spaces and special characters (e.g. 0016503334444). |

#### Responses

##### 201
Success Response

|     |     |
| --- | --- |
| notified | boolean<br>Notification status if enabled. By default<br>Example: false |
| url | string<br>URL generated<br>Example: "https://domain.visa.com/dlink/push?payload=abc" |

##### 400
Bad Request

|     |     |
| --- | --- |
| httpStatus<br>required | string<br>HTTP Status code<br>Example: "400" |
| message<br>required | string<br>Message describing the error condition with additional information wherever applicable. |
| reason<br>required | string<br>Error Code for the error condition. |
| correlationId | string<br>Request trace id, for debugging purpose. |
| errorMessages | Array of objects |
| Array

|     |     |
| --- | --- |
| attribute | string<br>Detailed error attribute if any. |
| location | string<br>Detailed error location if any. |
| message | string<br>Detailed error message if any. |

##### 401
Unauthorized

|     |     |
| --- | --- |
| httpStatus<br>required | string<br>HTTP Status code |
| message<br>required | string<br>Message describing the error condition with additional information wherever applicable. |
| reason<br>required | string<br>Error Code for the error condition. |
| correlationId | string<br>Request trace id, for debugging purpose. |
| requestId | string<br>Request unix timestamp, for debugging purpose. |

##### 403
Forbidden

##### 500
Internal Server Error

##### 503
Service Unavailable