# Alias Directory Service Search API Reference - [Getting Started with Visa Alias Directory Service](https://developer.visa.com/capabilities/alias-directory-service/docs-getting-started) - [Use Cases and Implementation Examples](https://developer.visa.com/capabilities/alias-directory-service/alias-directory-use-cases) - [Authentication and Encryption](https://developer.visa.com/capabilities/alias-directory-service/docs-authentication) - [How to Use Visa Alias Directory Service](https://developer.visa.com/capabilities/alias-directory-service/docs-how-to) - [How to Use Directory Network Manager](https://developer.visa.com/capabilities/alias-directory-service/docs-how-to-use-dnm) - [How to Use Batch Processing](https://developer.visa.com/capabilities/alias-directory-service/docs-how-to-use-batch) - [Error Codes](https://developer.visa.com/capabilities/alias-directory-service/docs-error-codes) - [Frequently Asked Questions](https://developer.visa.com/capabilities/alias-directory-service/faq) - [Product Terms](https://developer.visa.com/capabilities/alias-directory-service/ProductTerms) - [Request & Response Codes](https://developer.visa.com/request_response_codes) # Alias Lifecycle Management These are the API specifications for Alias Directory 2.0. Alias Lifecycle Management Bundle ## Get All Payment Credentials v1 - Latest Get all _Payment Credentials_ of an existing **Alias** ### Request ##### path Parameters | | | | --- | --- | | aliasId
required | string 36 characters
The UUID generated by Alias Directory which identifies the create report request.
Example: e336c8c8-2945-4be3-af3e-951ec2d01219 | ### Responses #### 200 OK - Get All Payment Credentials Response ##### Response Schema: application/json Array Any of: CardGetResponseBankGetResponse | | | | --- | --- | | accountNumber
required | string [ 12 .. 19 ] characters ^\d*$
Primary account number of the card
Example: "4111111145551142" | | billingAddress
required | object | | | | | | --- | --- | | country
required | string 3 characters
Country code using 3-character ISO 3166 (Alpha 3) format
ISO20022 element name: Creditor -> Postal Address -> Country
Example: "USA" | | addressLine1 | string [ 0 .. 99 ] characters
Address line 1
ISO20022 element name: Creditor -> Postal Address -> Address Line
Example: "1000 Market Street" | | addressLine2 | string [ 0 .. 99 ] characters
Address line 2
ISO20022 element name: Creditor -> Postal Address -> Address Line
Example: "Suite 101" | | buildingNumber | string [ 1 .. 60 ] characters
Building number
ISO20022 element name: Creditor -> Postal Address -> Building Number
Example: "56" | | city | string [ 1 .. 35 ] characters
City
ISO20022 element name: Creditor -> Postal Address -> Town Name
Example: "San Francisco" | | minorSubdivisionCode | string [ 1 .. 50 ] characters
Minor Subdivision Code
ISO20022 element name: Creditor -> Postal Address -> Country Sub Division
Example: "CA" | | postalCode | string [ 1 .. 16 ] characters
Postal code number of the addresses
ISO20022 element name: Creditor -> Postal Address -> Postal Code
Example: "94105" | | state | string [ 1 .. 16 ] characters
State (ISO 3166-2)
Example: "CA" | | streetName | string [ 1 .. 60 ] characters
Street Name
Example: "12" | | | type
required | string
In this case, the value must be `CARD`
Enum:"BANK""CARD"
Example: "CARD" | | accountNumberType | string
Card account number type. Valid values: 'NIUBIZ', 'PAN' and 'TOKEN'.
Enum:"NIUBIZ""PAN""TOKEN"
Example: "TOKEN" | | cardType | string [ 1 .. 70 ] characters
Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Platinum.
Example: "Visa Platinum" | | createdOn | string \d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d\.000Z
Date when it was initially created
Example: "2021-06-21T13:00:00.645Z" | | currencyCode | string 3 characters
Recipient card currency code
Format: 3-character ISO-4217 (Alpha-3) currency code
(Refer to Payouts Endpoint Guide on country-specific required fields and lengths)
ISO20022 field name: Creditor Account Currency
Example: "USD" | | expirationDate | string
Expiration date for the card. This is required for certain markets.
Example: "2026-01" | | externalId | string [ 1 .. 100 ] characters
externalId is a client-provided identifier for the payment credential. If clients already use an identifier for the payment credential in their internal systems, they can re-use the same value here and manage the payment credential with this identifier.
Example: "63421837-d597-4f0f-89e4-930c1a7b9e85" | | id | string 36 characters
This is an UUID generated by Alias Directory which identifies the payment credential
Example: "a44c9553-e687-4f3c-b7e7-a4245d9f238e" | | issuerName | string [ 1 .. 150 ] characters
Name of the issuer of the card
Example: "Bank A" | | lastFourDigits | string 4 characters ^\d*$
Last four digits of the PAN of the card
Example: "1142" | | lastUpdatedOn | string \d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d\.000Z
Date when it was last modified. This field comes in the response only if any field in the PC was modified/updated.
Example: "2021-06-22T15:12:00.322Z" | | nameOnCard | string [ 1 .. 120 ] characters
Name that appears on the Card. Clients in CEMEA and the EU must use only one first letter of customer’s last name followed by dot symbol to create or modify an Alias record. For example, Alias record for customer John Smith should be created or modified by Participant with First and Last name fields as 'John S.'
Example: "Alex Miller" | | preferredFor | Array of objects [ 0 .. 3 ] items
Indicates if a payment credential is a preferred **Receiving**, **Sending**, or **Paying** account. **Receiving** allows for funds to be pushed into the payment credential. **Sending** allows for funds to be sent from the payment credential. **Paying** allows for the payment credential to be used for purchases. More than one preferred type can be used. | | Array | | | | --- | --- | | type
required | string
Enum:"RECEIVE""SEND""PAY" | | date | string
Date and time when set as preferred
Example: "2021-01-01T22:52:46Z" | | | status | string
Payment Credential status. DELETED payment credentials won't be returned.
Enum:"ACTIVE""BLOCKED""DISABLED""EXPIRED"
Example: "ACTIVE" | #### 400 Bad Request. Returned when any field validations fails or when any required fields is missing or when request is inconsistent with the Request definitions. ##### Response Schema: application/json | | | | --- | --- | | errorCode
required | string [ 0 .. 10 ] characters
Code to identify the type of error. The value will be `400` in this case.
Example: "400" | | errorMessages
required | Array of strings
Description of the error reason
Example: ["getPaymentCredentials.aliasId: size must be between 0 and 36"] | #### 404 Not Found. The server can't find the requested resource. ##### Response Schema: application/json | | | | --- | --- | | errorCode
required | string [ 0 .. 10 ] characters
Code to identify the type of error.
Example: "LDS-30002" | | errorMessages
required | Array of strings
Description of the error reason
Example: ["Alias not found"] | #### 500 Internal Server Error ##### Response Schema: application/json | | | | --- | --- | | errorCode
required | string [ 0 .. 10 ] characters
Code to identify the type of error. The value will be `500` in this case.
Example: "500" | | errorMessages
required | Array of strings
Description of the error reason
Example: ["Internal Server Error"] | get/aliasdirectory/v1/aliases/{aliasId}/paymentCredentials Sandbox server https://sandbox.api.visa.com/aliasdirectory/v1/aliases/{aliasId}/paymentCredentials Response samples - 200 - 400 - 404 - 500 application/json ```json [ { "id": "a44c9553-e687-4f3c-b7e7-a4245d9f238e", "accountNumberType": "TOKEN", "type": "CARD", "cardType": "Visa Platinum", "issuerName": "Bank A", "nameOnCard": "Alex Miller", "currencyCode": "USD", "accountNumber": "4111111145551142", "billingAddress": { "city": "San Francisco", "state": "CA", "country": "USA", "postalCode": "94105", "streetName": "12", "addressLine1": "1000 Market Street", "addressLine2": "Suite 101", "buildingNumber": "56", "minorSubdivisionCode": "CA" }, "expirationDate": "2026-01", "lastFourDigits": "1142", "externalId": "63421837-d597-4f0f-89e4-930c1a7b9e85", "preferredFor": [{ "date": "2021-01-01T22:52:46Z", "type": "RECEIVE" }], "status": "ACTIVE", "createdOn": "2021-06-21T13:00:00.645Z", "lastUpdatedOn": "2021-06-22T15:12:00.322Z" } ] ```