Visa Digital Enablement Lite App API Reference
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 required |
string VDP client ID via Service Context Example: 86da0f74-19f0-4a20-9dde-3e83dfa6bf83 |
Request Body schema: application/json
| appId required |
string Issuer application Id. Example: "50c7e5ac-1e75-4faa-9a27-9882592eff43" |
| emailLookupEnable | boolean Enable search by email. Example: true |
| payload | object or object |
| One of: |
objectobject
| accountNumber required |
string Full card number. |
| cardBrand required |
string Valid values are: VISA, MC. |
| cardType required |
string Valid values are: DEBIT, CREDIT, PREPAID. |
| expirationMonth required |
string Month when the card is set to expire (e.g. 02 for Feb). |
| expirationYear required |
string Year when the card is set to expire (e.g. 2023). |
| nameOnAccount required |
string Full name on the card (Must use UTF-8 characters). |
| billingAddress | object |
| --- | --- |
| addressLine1 required |
string <= 256 characters Line 1 of the billing address (Must use UTF-8 characters) |
| city required |
string <= 100 characters City of the billing address (e.g. New York), no special characters. |
| countryCode required |
string 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 required |
string Cardholder phone number without country code, spaces and special characters (e.g. 6503334444). |
| postalCode required |
string 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 required |
string Must be in ISO 3166-2 format, alphabetic value with max length of 3 characters, with no dashes or spaces. |
| addressLine2 | string <= 256 characters Line 2 of the address, which usually corresponds to apartment, suite, etc. (Must use UTF-8 characters) |
| addressLine3 | string <= 256 characters Line 3 of the address (Must use UTF-8 characters) |
| source | string Optional for Single-Use clients. Required for Multi-Use/Channel Partner clients. |
| user | object |
| --- | --- |
| string 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). |
|
| firstname | string The user’s First Name (e.g. JOHN). |
| lastname | string The user’s Last Name (e.g. SMITH). |
| locale | string Locale code (en-US)- It helps to identify the locale to be selected for email notifications. |
| phoneNumber | string Cardholder phone number including country code, without spaces and special characters (e.g. 0016503334444). |
Responses
201
Success Response
| notified | boolean Notification status if enabled. By default Example: false |
| url | string URL generated Example: "https://domain.visa.com/dlink/push?payload=abc" |
400
Bad Request
| httpStatus required |
string HTTP Status code Example: "400" |
| message required |
string Message describing the error condition with additional information wherever applicable. |
| reason required |
string Error Code for the error condition. |
| correlationId | string Request trace id, for debugging purpose. |
| errorMessages | Array of objects |
| Array |
| attribute | string Detailed error attribute if any. |
| location | string Detailed error location if any. |
| message | string Detailed error message if any. |
401
Unauthorized
| httpStatus required |
string HTTP Status code |
| message required |
string Message describing the error condition with additional information wherever applicable. |
| reason required |
string Error Code for the error condition. |
| correlationId | string Request trace id, for debugging purpose. |
| requestId | string Request unix timestamp, for debugging purpose. |
403
Forbidden
500
Internal Server Error
503
Service Unavailable