Skip to content

AliasapiApi.md

Latest commit

 

History

History
279 lines (201 loc) · 8.41 KB

AliasapiApi.md

File metadata and controls

279 lines (201 loc) · 8.41 KB

AliasapiApi

All URIs are relative to https://sandbox.api.visa.com

Method HTTP request Description
createAlias POST /visadirect/v1/vad/manage/createalias Create Alias
deleteAlias POST /visadirect/v1/vad/manage/deletealias Delete Alias
getAlias GET /visadirect/v1/vad/manage/{guid} GetAlias
resolve POST /visadirect/v1/vad/resolve Resolve
updateAlias POST /visadirect/v1/vad/manage/updatealias Update Alias

createAlias

CreateAliasPOSTResponse createAlias(createAliasPOSTPayload)

Create Alias

Create an alias in the Alias Directory.

Example

// Import classes:
//import com.visa.developer.sample.aliasapi.ApiClient;
//import com.visa.developer.sample.aliasapi.ApiException;
//import com.visa.developer.sample.aliasapi.Configuration;
//import com.visa.developer.sample.aliasapi.auth.*;
//import com.visa.developer.sample.aliasapi.api.AliasapiApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: mutualAuth
HttpBasicAuth mutualAuth = (HttpBasicAuth) defaultClient.getAuthentication("mutualAuth");
mutualAuth.setUsername("YOUR USERNAME");
mutualAuth.setPassword("YOUR PASSWORD");

AliasapiApi apiInstance = new AliasapiApi();
CreateAliasPOSTPayload createAliasPOSTPayload = new CreateAliasPOSTPayload(); // CreateAliasPOSTPayload | Resource body for Create Alias
try {
    CreateAliasPOSTResponse result = apiInstance.createAlias(createAliasPOSTPayload);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AliasapiApi#createAlias");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
createAliasPOSTPayload CreateAliasPOSTPayload Resource body for Create Alias

Return type

CreateAliasPOSTResponse

Authorization

mutualAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

deleteAlias

DeleteAliasPOSTResponse deleteAlias(deleteAliasPOSTPayload)

Delete Alias

Delete alias of a recipient from the Alias Directory.

Example

// Import classes:
//import com.visa.developer.sample.aliasapi.ApiClient;
//import com.visa.developer.sample.aliasapi.ApiException;
//import com.visa.developer.sample.aliasapi.Configuration;
//import com.visa.developer.sample.aliasapi.auth.*;
//import com.visa.developer.sample.aliasapi.api.AliasapiApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: mutualAuth
HttpBasicAuth mutualAuth = (HttpBasicAuth) defaultClient.getAuthentication("mutualAuth");
mutualAuth.setUsername("YOUR USERNAME");
mutualAuth.setPassword("YOUR PASSWORD");

AliasapiApi apiInstance = new AliasapiApi();
DeleteAliasPOSTPayload deleteAliasPOSTPayload = new DeleteAliasPOSTPayload(); // DeleteAliasPOSTPayload | Resource body for Delete Alias
try {
    DeleteAliasPOSTResponse result = apiInstance.deleteAlias(deleteAliasPOSTPayload);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AliasapiApi#deleteAlias");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
deleteAliasPOSTPayload DeleteAliasPOSTPayload Resource body for Delete Alias

Return type

DeleteAliasPOSTResponse

Authorization

mutualAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getAlias

GetAliasGETResponse getAlias()

GetAlias

Get alias and recipient's related data.

Example

// Import classes:
//import com.visa.developer.sample.aliasapi.ApiClient;
//import com.visa.developer.sample.aliasapi.ApiException;
//import com.visa.developer.sample.aliasapi.Configuration;
//import com.visa.developer.sample.aliasapi.auth.*;
//import com.visa.developer.sample.aliasapi.api.AliasapiApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: mutualAuth
HttpBasicAuth mutualAuth = (HttpBasicAuth) defaultClient.getAuthentication("mutualAuth");
mutualAuth.setUsername("YOUR USERNAME");
mutualAuth.setPassword("YOUR PASSWORD");

AliasapiApi apiInstance = new AliasapiApi();
try {
    GetAliasGETResponse result = apiInstance.getAlias();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AliasapiApi#getAlias");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

GetAliasGETResponse

Authorization

mutualAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

resolve

ResolvePOSTResponse resolve(resolvePOSTPayload)

Resolve

Resolve an alias for recipient's primary account number (PAN) and related data.

Example

// Import classes:
//import com.visa.developer.sample.aliasapi.ApiClient;
//import com.visa.developer.sample.aliasapi.ApiException;
//import com.visa.developer.sample.aliasapi.Configuration;
//import com.visa.developer.sample.aliasapi.auth.*;
//import com.visa.developer.sample.aliasapi.api.AliasapiApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: mutualAuth
HttpBasicAuth mutualAuth = (HttpBasicAuth) defaultClient.getAuthentication("mutualAuth");
mutualAuth.setUsername("YOUR USERNAME");
mutualAuth.setPassword("YOUR PASSWORD");

AliasapiApi apiInstance = new AliasapiApi();
ResolvePOSTPayload resolvePOSTPayload = new ResolvePOSTPayload(); // ResolvePOSTPayload | Resource body for Resolve
try {
    ResolvePOSTResponse result = apiInstance.resolve(resolvePOSTPayload);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AliasapiApi#resolve");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
resolvePOSTPayload ResolvePOSTPayload Resource body for Resolve

Return type

ResolvePOSTResponse

Authorization

mutualAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

updateAlias

UpdateAliasPOSTResponse updateAlias(updateAliasPOSTPayload)

Update Alias

Update alias and recipient data in the Alias Directory

Example

// Import classes:
//import com.visa.developer.sample.aliasapi.ApiClient;
//import com.visa.developer.sample.aliasapi.ApiException;
//import com.visa.developer.sample.aliasapi.Configuration;
//import com.visa.developer.sample.aliasapi.auth.*;
//import com.visa.developer.sample.aliasapi.api.AliasapiApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: mutualAuth
HttpBasicAuth mutualAuth = (HttpBasicAuth) defaultClient.getAuthentication("mutualAuth");
mutualAuth.setUsername("YOUR USERNAME");
mutualAuth.setPassword("YOUR PASSWORD");

AliasapiApi apiInstance = new AliasapiApi();
UpdateAliasPOSTPayload updateAliasPOSTPayload = new UpdateAliasPOSTPayload(); // UpdateAliasPOSTPayload | Resource body for Update Alias
try {
    UpdateAliasPOSTResponse result = apiInstance.updateAlias(updateAliasPOSTPayload);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AliasapiApi#updateAlias");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
updateAliasPOSTPayload UpdateAliasPOSTPayload Resource body for Update Alias

Return type

UpdateAliasPOSTResponse

Authorization

mutualAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined