POST/////
Use this endpoint to check for available Visa Aliases for alias resolution. One or more Visa Aliases might be available.
Header parameter
| Fields | Description |
|---|---|
| participant-id string Required | Visa Business Identifier (BID) that is assigned to the program. Allowable Values: Existing participant ID |
| req-sys-id string Required | Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. Allowable Values: 36 char max |
Request body
| Fields | Description |
|---|---|
| aliases array of strings Required | List of Visa Aliases to check for availability. Allowable Values: 1–128 chars |
| filters array of objects Optional | List of filters to apply in the request to check Visa Alias availability. Allowable Values: 1-3 items |
| filters[].field string Optional | Fields used to filter the Visa Aliases. Allowable Values: DIRECTORY_NAME, EXCLUDED_DIRECTORY_NAME, ENTITY_ID |
| filters[].value array of strings Optional | Values used to filter the Visa Aliases. Visa Alias values are either an email address or phone number. Allowable Values: 1–128 chars |
| transactionDetails object Optional | Details of the transaction associated with the Alias. Allowable Values: currencyCode |
| transactionDetails.currencyCode string Optional | The currency code for the transaction in ISO 4217 (Alpha-3) format. Allowable Values: 3 chars |
| userDetails object Optional | Details of the user requesting the Visa Alias information. The information must not contain personal identifiable information (PII). Allowable Values: userName |
| userDetails.userName string Optional | Unique identifier of the user. Allowable Values: 1–50 chars |
Sample request body
JSON
{
"aliases": [
"123456"
],
"filters": [
{
"field": "DIRECTORY_NAME",
"value": [
"DIRECTORY_A",
"DIRECTORY_B",
"DIRECTORY_C"
]
}
],
"transactionDetails": {
"currencyCode": "USD"
},
"userDetails": {
"userName": "johndoe313"
}
}
Response body
| Fields | Description |
|---|---|
| summary object Returned | Summary of available Visa Aliases. Allowable Values: aliasesFound, aliasesNotFound, aliasesRepeated, aliasesTotal |
| summary.aliasesFound integer Returned | Number of available Visa Aliases found. Allowable Values: 0–900 |
| summary.aliasesNotFound integer Returned | Number of Visa Aliases not found. Allowable Values: 0–900 |
| summary.aliasesRepeated integer Returned | Number of duplicate Visa Aliases. Allowable Values: 0–900 |
| summary.aliasesTotal integer Returned | Total number of available Visa Aliases. Allowable Values: 0–900 |
| details array of objects Conditionally returned | Information associated with available Visa Aliases. Allowable Values: aliasType, aliasValue, directories, directoriesNames |
| details[].aliasType string Conditionally returned | Type of Visa Alias in the Alias Directory Service (ADS) profile. Visa supports phone and email as Visa Alias types that can be used in place of sensitive payment credentials details. This field is returned if it exists in the resource. Allowable Values: EMAIL, PHONE, DIRECTORY_ALIASID, PAYNAME |
| details[].aliasValue string Conditionally returned | Visa Alias value, which can be an email, a phone number, ID of an alias directory, or a payname. If a phone number is used for the Visa Alias, it must follow ITU-T E.164 (2010) number structure. NOTE: In the E.164 format, the ”+” sign is not included. Allowable Values: 1–128 chars |
| details[].directories array of objects Conditionally returned | List of directories associated with the Visa Alias. Allowable Values: directoryName, entities |
| details[].directories[].directoryName string Conditionally returned | The directory name for the Visa Alias. Allowable Values: 25 char max |
| details[].directories[].entities array of objects Conditionally returned | List of entities associated with the directory. Allowable Values: id, preferredFor |
| details[].directories[].entities[].id string Conditionally returned | Unique identifier of the entity. Allowable Values: 1–36 chars |
| details[].directories[].entities[].preferredFor array of objects Conditionally returned | List of preferred payment methods for the entity. Allowable Values: type, date |
| details[].directories[].entities[].preferredFor[].type string Returned | Type of operation associated with the payment credential. Allowable Values: RECEIVE, SEND, PAY |
| details[].directories[].entities[].preferredFor[].date string Conditionally returned | Date of the Receiving, Sending, or Paying operation. Allowable Values: 10 chars Format: YYYY-MM-DD |
| details[].directoriesNames array of strings Conditionally returned | List of directory names associated with the Visa Alias. Allowable Values: 1–128 chars |
Sample response body
JSON
[
{
"summary": {
"aliasesFound": 1,
"aliasesTotal": 1,
"aliasesNotFound": 0,
"aliasesRepeated": 0
},
"details": [
{
"aliasType": "PHONE",
"aliasValue": "123456",
"directories": [
{
"entities": [
{
"id": "1101"
},
{
"id": "1102",
"preferredFor": [
{
"date": "1980-02-01",
"type": "RECEIVE"
}
]
}
],
"directoryName": "DIRECTORY_A"
},
{
"directoryName": "DIRECTORY_B"
}
],
"directoriesName": [
"DIRECTORY_A",
"DIRECTORY_B"
]
}
]
}
]