# Alias Directory Service Alias Directory Service ## Version: 1 ### Servers | URL | Description | | --- | ----------- | | https://sandbox.api.visa.com | Sandbox server | --- ### Schemas #### BankName Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BankName | string | | | **Example** 
Bank A
#### AliasInquiryItemAD Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | entities | | Entities where the Alias is present. For example, an entity could be a bank within the remote directory. | No | | aliasType |
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME", "NATIVE_ALIAS", "NATIONAL_ID" | The type of Alias in aliasValue
*Enum:* `"PHONE"`, `"EMAIL"`, `"DIRECTORY_ALIASID"`, `"PAYNAME"`, `"NATIVE_ALIAS"`, `"NATIONAL_ID"`
*Example:* `"PHONE"` | Yes | | aliasValue | | This attribute contains the alias data, e.g. phone number, email address, etc.
If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure.
*Example:* `"1231564987"` | Yes | #### PaymentCredentialCreateUpdateResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | id | | | Yes | | type |
**Available values:** "BANK", "CARD" | Payment credential type
*Enum:* `"BANK"`, `"CARD"`
*Example:* `"CARD"` | Yes | | externalId | | 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"` | No | #### AliasExternalId-1 Schema externalId is a client-provided identifier for the Alias. If clients already use an identifier for the Alias in their internal systems, they can re-use the same value here and manage the Alias with this identifier. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasExternalId-1 | | externalId is a client-provided identifier for the Alias. If clients already use an identifier for the Alias in their internal systems, they can re-use the same value here and manage the Alias with this identifier. | | **Example** 
21267931-7975-4b61-be7a-86915883b2b4
#### AliasExternalId Schema externalId is a client-provided identifier for the Alias. If clients already use an identifier for the Alias in their internal systems, they can re-use the same value here and manage the Alias with this identifier. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasExternalId | string | externalId is a client-provided identifier for the Alias. If clients already use an identifier for the Alias in their internal systems, they can re-use the same value here and manage the Alias with this identifier. | | **Example** 
21267931-7975-4b61-be7a-86915883b2b4
#### BankAliasConfirmResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BankAliasConfirmResponse | { **"type"**: string, **"bankName"**: string } | | | #### PaymentCredentialExternalId Schema 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. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialExternalId | string | 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
#### AlphaCountryCode Schema this field contains ISO3166 country code (Alpha-3). | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AlphaCountryCode | string (We recommend to use the Alpha-3) | this field contains ISO3166 country code (Alpha-3). | | **Example** 
USA
#### PreferredPaymentCredentialsRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type |
**Available values:** "BANK", "CARD" | The type of Alias in aliasValue
*Enum:* `"BANK"`, `"CARD"`
*Example:* `"CARD"` | Yes | | preferredFor | | | No | #### Consent Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | consent | { **"version"**: string, **"presenter"**: string, **"expiryDateTime"**: dateTime, **"intermediaries"**: [ string ], **"validFromDateTime"**: dateTime } | Consent details | No | #### GetBatchResultResponse-1 Schema Response for getBatchResult operation. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | data | | Content of result file. Base64 encoded. The binary file is compressed with Zstd.
*Example:* `"ZXhhbXBsZQ=="` | Yes | #### AliasMetadataResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasMetadataResponse | [ { **"aliasValue"**: string, **"statusDetails"**: { **"code"**: string, **"message"**: string } } ] | | | #### PaymentCredentialItemAliasConfirmResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialItemAliasConfirmResponse | { **"type"**: string, **"issuerName"**: string } or { **"type"**: string, **"bankName"**: string } | | | #### BankConfirmPath Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be: `BANK`
*Example:* `"BANK"` | Yes | | bankName | | Bank name of the payment credential ISO20022 element name: Creditor Agent -> Financial Institution -> Name
*Example:* `"Bank of America"` | Yes | #### ErrorResponseAD Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error.
*Example:* `"404"` | Yes | | errorMessages | | Textual description for the reason of the error | Yes | #### AdditionalAliasId Schema This is the UUID generated by Alias Directory which identifies the Additional Alias | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AdditionalAliasId | string | This is the UUID generated by Alias Directory which identifies the Additional Alias | | **Example** 
e336c8c8-2945-4be3-af3e-951ec2d01219
#### AliasMetadataListRequest-1 Schema List of aliases metadata to create. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasMetadataListRequest-1 | | List of aliases metadata to create. | | #### CreateAdditionalAliasRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type |
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME" | The type of Alias in aliasValue
*Enum:* `"PHONE"`, `"EMAIL"`, `"DIRECTORY_ALIASID"`, `"PAYNAME"`
*Example:* `"PHONE"` | Yes | | value | | A customer unique identifier that represents him in the payment ecosystem where the user move funds. The format will change depending the type.
*Example:* `"1231231234"` | Yes | #### AliasListReportRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | page | integer | the page of the report list, default if non present takes the inital page as
*Example:* `0` | No | | endDate | dateTime | Date when alias was created, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z
*Example:* `"2021-01-01T22:52:46.000Z"` | Yes | | aliasIds | [ string ] | The alias ids to be filtered for the report
*Example:* `["b180e260-db5a-4539-aad8-374705fadc68"]` | No | | startDate | dateTime | Date when alias was created, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z
*Example:* `"2021-01-01T22:52:46.000Z"` | Yes | | aliasTypes | [ string,
**Available values:** "PHONE", "EMAIL" ] | The alias types for the report | No | | aliasValues | [ string ] | The alias values to be filtered for the report
*Example:* `["2547896321"]` | No | | aliasStatuses | [ string,
**Available values:** "ACTIVE", "DISABLED", "BLOCKED", "EXPIRED" ] | The statuses for the report | No | | participantIds | [ string ] | The Participants to be filtered for the report
*Example:* `["5462e634-6c8b-429c-a537-894e0f2e2788"]` | No | | aliasExternalIds | [ string ] | The alias external ids to be filtered for the report
*Example:* `["d8dbdfd2-f0df-4d6d-95fb-9f63af9db7a1"]` | No | #### AssociatedIdsItemResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | id | | | No | | type |
**Available values:** "ALIAS", "PAYMENT_CREDENTIAL" | | No | #### Error400GetPcResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### PreferredPaymentCredentialsNoPreferredForResponse-1 Schema Array of Card or BankAccount | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PreferredPaymentCredentialsNoPreferredForResponse-1 | | Array of Card or BankAccount | | #### TransactionDetails-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | currencyCode | | ISO 4217 currency code. Allows a client to specify the currency of the payment credential returned in the Alias Resolution response. ISO20022 element name: Creditor Account - > Currency
*Example:* `"USD"` | No | #### Error422ResponseAD Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error.
*Example:* `"422"` | Yes | | errorMessages | | Textual description for the reason of the error | Yes | #### AliasInquiryResponseInternal-1 Schema Alias Inquiry Response Payload | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | details | | Alias information associated with found records | No | | summary | { **"aliasesFound"**: undefined (int32), **"aliasesTotal"**: undefined (int32), **"aliasesNotFound"**: undefined (int32), **"aliasesRepeated"**: undefined (int32) } | Summary of found Aliases | Yes | **Example** 
{
  "details": [
    {
      "aliasType": "PHONE",
      "aliasValue": "123456",
      "directories": [
        {
          "entities": [
            {
              "id": "1101"
            },
            {
              "id": "1102",
              "preferredFor": [
                {
                  "date": "1980-02-01T10:00:00Z",
                  "type": "RECEIVE"
                }
              ]
            }
          ],
          "directoryName": "DIRECTORY_A"
        },
        {
          "directoryName": "DIRECTORY_B"
        }
      ],
      "directoriesName": [
        "DIRECTORY_A",
        "DIRECTORY_B"
      ]
    }
  ],
  "summary": {
    "aliasesFound": 1,
    "aliasesTotal": 1,
    "aliasesNotFound": 0,
    "aliasesRepeated": 0
  }
}
#### Error422PcResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error.
*Example:* `"LDS-30012"` | Yes | | errorMessages | | Description of the error reason | Yes | #### AssociatedIdsItemResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | id | string | | No | | type | string,
**Available values:** "ALIAS", "PAYMENT_CREDENTIAL" | | No | #### PreferredTypeResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | date | dateTime | ISO formatted Timestamp
*Example:* `"2021-01-01T22:52:46Z"` | No | | type | string,
**Available values:** "RECEIVE", "SEND", "PAY" | 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.
*Enum:* `"RECEIVE"`, `"SEND"`, `"PAY"`
*Example:* `"RECEIVE"` | No | #### BankAccountDetails-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be `BANK` | No | #### Id-1 Schema UUID to uniquely identify an object. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | Id-1 | | UUID to uniquely identify an object. | | **Example** 
d1162433-d7f9-443a-9a91-0aaa1eb29a7c
#### AliasInquiryEntityItem-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | id | | Id of the entity used to identify the entity
*Example:* `"entity1"` | No | | preferredFor | | Preferred for information for each entity | No | #### UpdatePaymentCredentialStatusRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | status | string,
**Available values:** "ACTIVE", "BLOCKED", "DELETED", "EXPIRED", "DISABLED" | Set the new status for the Payment Credential.
*Enum:* `"ACTIVE"`, `"BLOCKED"`, `"DELETED"`, `"EXPIRED"`, `"DISABLED"` | No | #### Bank Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BIC | string | Bank account Business Identifier Code (BIC) Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> BICFI | No | | type | string | In this case, value must be: `BANK`
*Example:* `"BANK"` | No | | address | { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string } | | Yes | | bankCode | string | Bank account bank code Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification
*Example:* `"173"` | No | | bankName | string | Bank name of the payment credential ISO20022 element name: Creditor Agent -> Financial Institution -> Name
*Example:* `"Bank A"` | Yes | | branchCode | string | Bank account branch code Conditional for select markets. ISO20022 field name: Creditor Agent Branch Identification
*Example:* `"123456"` | No | | accountName | string | Bank account name, i.e., account holder name as recorded on the bank account. 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, the alias record for customer John Smith should be created or modified by the Issuer with first and last name fields as 'John S.' ISO20022 element name: Creditor Account -> Name
*Example:* `"Alex Miller"` | Yes | | accountType | string,
**Available values:** "CHECKING", "SAVING" | Bank account type ISO20022 element name: Creditor Account -> Type
*Enum:* `"CHECKING"`, `"SAVING"` | No | | countryCode | string (We recommend to use the Alpha-3) | Bank account country code.

Format: 3-character ISO-3166 (Alpha-3) country code ISO20022 element name: Creditor Agent -> Financial Institution -> Country
*Example:* `"USA"` | Yes | | bankCodeType | string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT" | Bank account bank code type Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification -> Clearing System Identification
*Enum:* `"ABA"`, `"SORT_CODE"`, `"DEFAULT"` | No | | currencyCode | string | Bank account currency code Format: 3-character ISO-4217 (Alpha-3) currency code ISO20022 element name: Creditor Account -> Currency
*Example:* `"USD"` | Yes | | accountNumber | string | Bank account number ISO20022 element name: Creditor Account Number
*Example:* `"4111111145551140"` | Yes | | accountNumberType | string,
**Available values:** "IBAN", "DEFAULT", "TOKEN" | Bank account number type. Valid values: 'IBAN', 'DEFAULT' and 'TOKEN'. If the IBAN format is not supported in a country, use DEFAULT.
*Enum:* `"IBAN"`, `"DEFAULT"`, `"TOKEN"`
*Example:* `"DEFAULT"` | Yes | #### AliasProfileResponse Schema Profile details for the customer that owns the Alias. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | lastName | string | Last name in English. ISO20022 element name: Creditor -> Name Example: "Miller"
*Example:* `"Miller"` | Yes | | firstName | string | First name in English ISO20022 element name: Creditor -> Name
*Example:* `"Alex"` | Yes | | middleName | string | Middle name in English
*Example:* `"Robert"` | No | | contactInfo | [ { **"type"**: string,
**Available values:** "EMAIL", "PHONE", "DIRECTORY_ALIASID", **"value"**: string } ] | | No | | dateOfBirth | string | Date of birth. ISO20022 element name: Creditor -> Private Identification -> Date of Birth | No | | lastNameLocal | string | Last name in English. ISO20022 element name: Creditor -> Name Example: "Miller"
*Example:* `"Miller"` | No | | preferredName | string | Preferred name (or the 'known-as' name)
*Example:* `"Miller's Shop"` | No | | firstNameLocal | string | First name in local language
*Example:* `"Alexander"` | No | | middleNameLocal | string | Middle name in local language
*Example:* `"Roberto"` | No | #### BIC-1 Schema Business Identifier Code (BIC) of the Sponsor FI (Acquirer) ISO20022 field name: Debtor Agent FI BIC | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BIC-1 | | Business Identifier Code (BIC) of the Sponsor FI (Acquirer) ISO20022 field name: Debtor Agent FI BIC | | **Example** 
AAAABBCC123
#### AliasResolveBasicResponseAD Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | profile | { **"lastName"**: , **"firstName"**: , **"middleName"**: , **"contactInfo"**: , **"dateOfBirth"**: , **"lastNameLocal"**: , **"preferredName"**: , **"firstNameLocal"**: , **"middleNameLocal"**: } | Profile details for the customer that owns the Alias | Yes | | identification | { **"type"**: , **"value"**: , **"verificationDetails"**: { **"authDateTime"**: undefined (date-time), **"verifiedEmail"**: , **"verifiedPhone"**: , **"creationDateTime"**: undefined (date-time), **"authMethodReference"**: } } | Form of identification. This object is optional and only used for specific use cases. | No | | paymentCredentials | | List of payment credentials associated with an Alias | Yes | #### FileId-1 Schema This is the UUID generated by the Report which identifies the File who is part of the report | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | FileId-1 | | This is the UUID generated by the Report which identifies the File who is part of the report | | **Example** 
e336c8c8-2945-4be3-af3e-951ec2d01219
#### Error404AliasResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error.
*Example:* `"LDS-30002"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### AliasMetadataResponseList Schema Alias create response | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliases | [ { **"aliasValue"**: string, **"statusDetails"**: { **"code"**: string, **"message"**: string } } ] | | No | #### CardGetResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | id | string | This is an UUID generated by Alias Directory which identifies the payment credential
*Example:* `"a44c9553-e687-4f3c-b7e7-a4245d9f238e"` | No | | accountNumberType | string,
**Available values:** "NIUBIZ", "PAN", "TOKEN" | Card account number type. Valid values: 'NIUBIZ', 'PAN' and 'TOKEN'.
*Enum:* `"NIUBIZ"`, `"PAN"`, `"TOKEN"`
*Example:* `"TOKEN"` | No | #### PaymentCredentialItemAliasResponseResolve Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialItemAliasResponseResolve | { **"modifiedOn"**: undefined (date-time) } or { **"modifiedOn"**: undefined (date-time) } | | | #### AliasNonDeletedStatuses Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasNonDeletedStatuses | string,
**Available values:** "ACTIVE", "DISABLED", "BLOCKED", "EXPIRED" | | | #### AliasConfirmRequestAD Schema Alias information to confirm the identity of the person associated with the alias | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | filters | | List of the filter to apply in the request | No | | aliasType |
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME", "NATIVE_ALIAS", "NATIONAL_ID" | The type of Alias provided in aliasValue. ISO20022 element name: Proxy -> Type
*Enum:* `"PHONE"`, `"EMAIL"`, `"DIRECTORY_ALIASID"`, `"PAYNAME"`, `"NATIVE_ALIAS"`, `"NATIONAL_ID"`
*Example:* `"PHONE"` | Yes | | aliasValue | | The value of the Alias, e.g., phone number, email address or payname. ISO20022 element name: Proxy -> Identification
*Example:* `"1231231234"` | Yes | | userDetails | { **"userName"**: } | Provides information about the end user who is requesting an Alias Resolution. This is used for risk and fraud prevention purposes. | No | | initiatingPartyId | | The identifier of the party initiating the Alias resolution.
*Example:* `"2d94b7fd-ff00-4985-9058-1d9bd7b69cf4"` | Yes | | transactionDetails | { **"currencyCode"**: } | Additional transaction information which is used in the Alias Confirm request. | No | #### PaymentCredentialItemAliasResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialItemAliasResponse-1 | { **"type"**: , **"cardType"**: , **"issuerName"**: , **"nameOnCard"**: , **"currencyCode"**: , **"accountNumber"**: , **"billingAddress"**: { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: }, **"expirationDate"**: undefined (YYYY-MM), **"lastFourDigits"**: , **"accountNumberType"**:
**Available values:** "NIUBIZ", "TOKEN", "PAN" } & { **"modifiedOn"**: undefined (date-time) } & { **"preferredFor"**: } or { **"BIC"**: , **"type"**: , **"address"**: { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: }, **"bankCode"**: , **"bankName"**: , **"branchCode"**: , **"accountName"**: , **"accountType"**:
**Available values:** "CHECKING", "SAVING", **"countryCode"**: undefined (We recommend to use the Alpha-3), **"bankCodeType"**:
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: , **"accountNumber"**: , **"accountNumberType"**:
**Available values:** "IBAN", "DEFAULT", "TOKEN", "CCI" } & { **"modifiedOn"**: undefined (date-time) } & { **"preferredFor"**: } | | | #### Error400UpdateAliasResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### Filters-1 Schema List of the filter to apply in the request | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | Filters-1 | | List of the filter to apply in the request | | #### BankGetPcAccountDetails Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be `BANK` | No | #### BankAliasResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BankAliasResponse-1 | { **"BIC"**: , **"type"**: , **"address"**: { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: }, **"bankCode"**: , **"bankName"**: , **"branchCode"**: , **"accountName"**: , **"accountType"**:
**Available values:** "CHECKING", "SAVING", **"countryCode"**: undefined (We recommend to use the Alpha-3), **"bankCodeType"**:
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: , **"accountNumber"**: , **"accountNumberType"**:
**Available values:** "IBAN", "DEFAULT", "TOKEN", "CCI" } & { **"modifiedOn"**: undefined (date-time) } & { **"preferredFor"**: } | | | #### CardAliasResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | CardAliasResponse | { **"type"**: string, **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string }, **"expirationDate"**: string (YYYY-MM), **"lastFourDigits"**: string, **"accountNumberType"**: string,
**Available values:** "NIUBIZ", "TOKEN", "PAN" } & { **"modifiedOn"**: dateTime } & { **"preferredFor"**: [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } | | | #### Error400PcStatusResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### GetPlatformRequestResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | programId | string | The Program Id
*Example:* `"baf85624-3cf6-4c52-b91f-b8f3493e7330"` | No | | statusCode | integer | The response status
*Example:* `200` | No | | operationType | string | The operation type
*Example:* `"resolveAlias"` | No | | operationsCount | integer | The operations count
*Example:* `18` | No | | originatorActorId | string | The Originator Actor Id
*Example:* `"012af73f-44d8-4c9c-bbee-628b07faae1c"` | No | #### Error400PcResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### AliasResolveBasicResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | directoryName | string | Name of the external directory where was found the payment
*Example:* `"DIRECTORY_A"` | No | | paymentCredentials | [ { **"type"**: string, **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string }, **"expirationDate"**: string (YYYY-MM), **"lastFourDigits"**: string, **"accountNumberType"**: string,
**Available values:** "NIUBIZ", "TOKEN", "PAN" } & { **"modifiedOn"**: dateTime } & { **"preferredFor"**: [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } or { **"BIC"**: string, **"type"**: string, **"address"**: { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", **"countryCode"**: string (We recommend to use the Alpha-3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", "TOKEN" } & { **"modifiedOn"**: dateTime } & { **"preferredFor"**: [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } ] | List of payment credentials linked to an Alias | No | #### Date-1 Schema Date ISO-8601 Format https://www.w3.org/TR/NOTE-datetime | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | Date-1 | | Date ISO-8601 Format https://www.w3.org/TR/NOTE-datetime | | **Example** 
1980-02-01
#### AliasListReportRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | page | undefined (int32) | the page of the report list, default if non present takes the inital page as
*Example:* `0` | No | | endDate | undefined (date-time) | Date when alias was created, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z
*Example:* `"2021-01-01T22:52:46.000Z"` | Yes | | aliasIds | | The alias ids to be filtered for the report
*Example:* `["b180e260-db5a-4539-aad8-374705fadc68"]` | No | | startDate | undefined (date-time) | Date when alias was created, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z
*Example:* `"2021-01-01T22:52:46.000Z"` | Yes | | aliasTypes | | The alias types for the report | No | | aliasValues | | The alias values to be filtered for the report
*Example:* `["2547896321"]` | No | | aliasStatuses | | The statuses for the report | No | | participantIds | | The Participants to be filtered for the report
*Example:* `["5462e634-6c8b-429c-a537-894e0f2e2788"]` | No | | aliasExternalIds | | The alias external ids to be filtered for the report
*Example:* `["d8dbdfd2-f0df-4d6d-95fb-9f63af9db7a1"]` | No | #### Consent-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | consent | { **"version"**: , **"presenter"**: , **"expiryDateTime"**: undefined (date-time), **"intermediaries"**: , **"validFromDateTime"**: undefined (date-time) } | Consent details | No | #### CreatePaymentCredentialRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | CreatePaymentCredentialRequest-1 | { **"type"**:
**Available values:** "BANK", "CARD", **"externalId"**: , **"preferredFor"**: } & { **"type"**: , **"cardType"**: , **"issuerName"**: , **"nameOnCard"**: , **"currencyCode"**: , **"accountNumber"**: , **"billingAddress"**: { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: }, **"expirationDate"**: undefined (YYYY-MM) } or { **"type"**:
**Available values:** "BANK", "CARD", **"externalId"**: , **"preferredFor"**: } & { **"BIC"**: , **"type"**: , **"address"**: { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: }, **"bankCode"**: , **"bankName"**: , **"branchCode"**: , **"accountName"**: , **"accountType"**:
**Available values:** "CHECKING", "SAVING", **"countryCode"**: undefined (We recommend to use the Alpha-3), **"bankCodeType"**:
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: , **"accountNumber"**: , **"accountNumberType"**:
**Available values:** "IBAN", "DEFAULT", "TOKEN", "CCI" } | | | #### CardAliasResponseResolve-5 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be: `CARD`
*Example:* `"CARD"` | Yes | | cardType | | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Platinum.
*Example:* `"Visa Platinum"` | No | | issuerName | | Name of the issuer of the card
*Example:* `"Bank A"` | No | | nameOnCard | | Name that appears on the Card
*Example:* `"John Doe"` | No | | preferredFor | | 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. | No | | accountNumber | | Primary account number of the card
*Example:* `"4111111145551142"` | Yes | | billingAddress | { **"city"**: , **"state"**: , **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: } | | No | | expirationDate | | Expiration date for the card. This is required when it is expected that Visa tokenizes the credential.
*Example:* `"2022-01"` | No | | lastFourDigits | | Last four digits of the PAN of the card
*Example:* `"1142"` | No | | accountNumberType |
**Available values:** "NIUBIZ", "TOKEN", "PAN" | Card account number type. Valid values: 'NIUBIZ', 'PAN' and 'TOKEN'. When the field is not included, the default value is 'PAN'
*Enum:* `"NIUBIZ"`, `"TOKEN"`, `"PAN"`
*Example:* `"TOKEN"` | Yes | #### CardAliasResponseResolve-4 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be: `CARD`
*Example:* `"CARD"` | Yes | | cardType | | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Platinum.
*Example:* `"Visa Platinum"` | No | | issuerName | | Name of the issuer of the card
*Example:* `"Bank A"` | No | | nameOnCard | | Name that appears on the Card
*Example:* `"John Doe"` | No | | preferredFor | | 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. | No | | accountNumber | | Primary account number of the card
*Example:* `"4111111145551142"` | Yes | | billingAddress | { **"city"**: , **"state"**: , **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: } | | No | | expirationDate | | Expiration date for the card. This is required when it is expected that Visa tokenizes the credential.
*Example:* `"2022-01"` | No | | lastFourDigits | | Last four digits of the PAN of the card
*Example:* `"1142"` | No | | accountNumberType |
**Available values:** "NIUBIZ", "TOKEN", "PAN" | Card account number type. Valid values: 'NIUBIZ', 'PAN' and 'TOKEN'. When the field is not included, the default value is 'PAN'
*Enum:* `"NIUBIZ"`, `"TOKEN"`, `"PAN"`
*Example:* `"TOKEN"` | Yes | #### AliasNonDeletedStatuses-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasNonDeletedStatuses-1 |
**Available values:** "ACTIVE", "DISABLED", "BLOCKED", "EXPIRED" | | | #### CardAliasResponseResolve-3 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be: `CARD`
*Example:* `"CARD"` | Yes | | cardType | | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Platinum.
*Example:* `"Visa Platinum"` | No | | issuerName | | Name of the issuer of the card
*Example:* `"Bank A"` | No | | nameOnCard | | Name that appears on the Card
*Example:* `"John Doe"` | No | | preferredFor | | 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. | No | | accountNumber | | Primary account number of the card
*Example:* `"4111111145551142"` | Yes | | billingAddress | { **"city"**: , **"state"**: , **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: } | | No | | expirationDate | | Expiration date for the card. This is required when it is expected that Visa tokenizes the credential.
*Example:* `"2022-01"` | No | | lastFourDigits | | Last four digits of the PAN of the card
*Example:* `"1142"` | No | | accountNumberType |
**Available values:** "NIUBIZ", "TOKEN", "PAN" | Card account number type. Valid values: 'NIUBIZ', 'PAN' and 'TOKEN'. When the field is not included, the default value is 'PAN'
*Enum:* `"NIUBIZ"`, `"TOKEN"`, `"PAN"`
*Example:* `"TOKEN"` | Yes | #### ErrorResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error. Fixed 404 in this case
*Example:* `"404"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### CardAliasResponseResolve-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be: `CARD`
*Example:* `"CARD"` | Yes | | cardType | | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Platinum.
*Example:* `"Visa Platinum"` | No | | issuerName | | Name of the issuer of the card
*Example:* `"Bank A"` | No | | nameOnCard | | Name that appears on the Card
*Example:* `"John Doe"` | No | | preferredFor | | 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. | No | | accountNumber | | Primary account number of the card
*Example:* `"4111111145551142"` | Yes | | billingAddress | { **"city"**: , **"state"**: , **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: } | | No | | expirationDate | | Expiration date for the card. This is required when it is expected that Visa tokenizes the credential.
*Example:* `"2022-01"` | No | | lastFourDigits | | Last four digits of the PAN of the card
*Example:* `"1142"` | No | | accountNumberType |
**Available values:** "NIUBIZ", "TOKEN", "PAN" | Card account number type. Valid values: 'NIUBIZ', 'PAN' and 'TOKEN'. When the field is not included, the default value is 'PAN'
*Enum:* `"NIUBIZ"`, `"TOKEN"`, `"PAN"`
*Example:* `"TOKEN"` | Yes | #### CardAliasResponseResolve-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be: `CARD`
*Example:* `"CARD"` | Yes | | cardType | | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Platinum.
*Example:* `"Visa Platinum"` | No | | issuerName | | Name of the issuer of the card
*Example:* `"Bank A"` | No | | nameOnCard | | Name that appears on the Card
*Example:* `"John Doe"` | No | | preferredFor | | 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. | No | | accountNumber | | Primary account number of the card
*Example:* `"4111111145551142"` | Yes | | billingAddress | { **"city"**: , **"state"**: , **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: } | | No | | expirationDate | | Expiration date for the card. This is required when it is expected that Visa tokenizes the credential.
*Example:* `"2022-01"` | No | | lastFourDigits | | Last four digits of the PAN of the card
*Example:* `"1142"` | No | | accountNumberType |
**Available values:** "NIUBIZ", "TOKEN", "PAN" | Card account number type. Valid values: 'NIUBIZ', 'PAN' and 'TOKEN'. When the field is not included, the default value is 'PAN'
*Enum:* `"NIUBIZ"`, `"TOKEN"`, `"PAN"`
*Example:* `"TOKEN"` | Yes | #### AliasMetadataStatusDetail Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | code | string | Reason code for response.
*Example:* `"1000"` | No | | message | string | Reason message for response.
*Example:* `"Alias record created"` | No | #### UpdateAliasRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | UpdateAliasRequest-1 | { **"consent"**: { **"version"**: , **"presenter"**: , **"expiryDateTime"**: undefined (date-time), **"intermediaries"**: , **"validFromDateTime"**: undefined (date-time) } } & { **"profile"**: { **"lastName"**: , **"firstName"**: , **"middleName"**: , **"contactInfo"**: , **"dateOfBirth"**: , **"lastNameLocal"**: , **"preferredName"**: , **"firstNameLocal"**: , **"middleNameLocal"**: }, **"identification"**: { **"type"**: , **"value"**: , **"verificationDetails"**: { **"authDateTime"**: undefined (date-time), **"verifiedEmail"**: , **"verifiedPhone"**: , **"creationDateTime"**: undefined (date-time), **"authMethodReference"**: } } } | | | #### PaymentCredentialItemAliasConfirmResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialItemAliasConfirmResponse-1 | { **"type"**: , **"issuerName"**: , **"modifiedOn"**: undefined (date-time), **"nameOnCard"**: , **"currencyCode"**: , **"preferredFor"**: , **"billingAddress"**: { **"country"**: }, **"accountNumberType"**:
**Available values:** "NIUBIZ", "TOKEN", "PAN" } or { **"type"**: , **"address"**: { **"country"**: }, **"bankName"**: , **"modifiedOn"**: undefined (date-time), **"accountName"**: , **"countryCode"**: , **"currencyCode"**: , **"preferredFor"**: , **"accountNumberType"**:
**Available values:** "IBAN", "DEFAULT" } | | | #### AliasInquirySummary Schema Summary of found Aliases | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliasesFound | integer | Number of aliases found | Yes | | aliasesTotal | integer | Number of aliases in request | Yes | | aliasesNotFound | integer | Number of aliases not found | Yes | | aliasesRepeated | integer | Number of aliases repeated | Yes | #### AliasInquiryEntityDetail-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | entities | | A list of entities | No | | directoryName | | The name of the directory
*Example:* `"Directory A"` | No | #### AliasInquiryItem Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliasType | string,
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME" | The type of Alias in aliasValue
*Enum:* `"PHONE"`, `"EMAIL"`, `"DIRECTORY_ALIASID"`, `"PAYNAME"`
*Example:* `"PHONE"` | Yes | | aliasValue | string | This attribute contains the alias data, e.g. phone number, email address, etc.
If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Please note that in the E.164 format, the "+" sign is not included. Below are some examples of phone numbers with different country codes:
Country Country Code Examples
United States 1 1650xxxxxxx
Ukraine 380 38067xxxxxxx
Belarus 375 37529xxxxxxx
Kazakhstan 7 7701xxxxxxx
United Kingdom 44 4478xxxxxxxx
Singapore 65 659xxxxxxx
Hong Kong 852 8529xxxxxxx
Kenya 254 254701xxxxxx

*Example:* `"1231231234"` | Yes | | directories | [ { **"entities"**: [ { **"id"**: string, **"preferredFor"**: [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } ], **"directoryName"**: string } ] | List of directories and entities where the Alias is found | No | | directoriesName | [ string ] | The name of the directory
*Example:* `["Directory A","Directory B"]` | No | #### AliasInquiryItem-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliasType |
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME", "NATIVE_ALIAS", "NATIONAL_ID" | The type of Alias in aliasValue
*Enum:* `"PHONE"`, `"EMAIL"`, `"DIRECTORY_ALIASID"`, `"PAYNAME"`, `"NATIVE_ALIAS"`, `"NATIONAL_ID"`
*Example:* `"PHONE"` | Yes | | aliasValue | | This attribute contains the alias data, e.g. phone number, email address, etc.
If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Please note that in the E.164 format, the "+" sign is not included. Below are some examples of phone numbers with different country codes:
Country Country Code Examples
United States 1 1650xxxxxxx
Ukraine 380 38067xxxxxxx
Belarus 375 37529xxxxxxx
Kazakhstan 7 7701xxxxxxx
United Kingdom 44 4478xxxxxxxx
Singapore 65 659xxxxxxx
Hong Kong 852 8529xxxxxxx
Kenya 254 254701xxxxxx

*Example:* `"1231231234"` | Yes | | directories | | List of directories and entities where the Alias is found | No | | directoriesName | | The name of the directory
*Example:* `["Directory A","Directory B"]` | No | #### AliasMetadataStatusDetail-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | code | | Reason code for response.
*Example:* `"1000"` | No | | message | | Reason message for response.
*Example:* `"Alias record created"` | No | #### AliasId-1 Schema The UUID generated by Alias Directory which identifies the create report request. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasId-1 | | The UUID generated by Alias Directory which identifies the create report request. | | **Example** 
e336c8c8-2945-4be3-af3e-951ec2d01219
#### Error400GetPcsResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### Error400GetAliasResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### Error422UpdateStatusResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error.
*Example:* `"LDS-30013"` | Yes | | errorMessages | | Description of the error reason | Yes | #### AccountNumberType-1 Schema Card account number type. Valid values: 'NIUBIZ', 'PAN' and 'TOKEN'. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AccountNumberType-1 |
**Available values:** "NIUBIZ", "PAN", "TOKEN" | Card account number type. Valid values: 'NIUBIZ', 'PAN' and 'TOKEN'. | | **Example** 
TOKEN
#### AdditionalAliasId-1 Schema This is the UUID generated by Alias Directory which identifies the Additional Alias | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AdditionalAliasId-1 | | This is the UUID generated by Alias Directory which identifies the Additional Alias | | **Example** 
e336c8c8-2945-4be3-af3e-951ec2d01219
#### Error400InquiryResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | | Description of the error reason | Yes | #### BankName-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BankName-1 | | | | **Example** 
Bank A
#### CardConfirmPath Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be: `CARD`
*Example:* `"CARD"` | Yes | | issuerName | | Name of the issuer of the card
*Example:* `"Bank A"` | No | #### ReportId-1 Schema This is the UUID generated by Alias Directory which identifies the Report | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | ReportId-1 | | This is the UUID generated by Alias Directory which identifies the Report | | **Example** 
e336c8c8-2945-4be3-af3e-951ec2d01219
#### GenerateReportRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | format |
**Available values:** "JSON" | Format of created report.
*Enum:* `"JSON"` | No | | filters | { **"endDate"**: undefined (date-time), **"aliasType"**:
**Available values:** "PHONE", "EMAIL", **"startDate"**: undefined (date-time), **"aliasStatuses"**: , **"billingEventTypes"**: } | Define the data included in the report. | No | | reportType |
**Available values:** "PLATFORM_REQUESTS", "DIRECTORY_STATUS", "RESOLUTION_RECONCILIATION", "DIRECTORY_ACTIVITY", "PAYMENT_CREDENTIAL_DETAILS" | Report type to create.
*Enum:* `"PLATFORM_REQUESTS"`, `"DIRECTORY_STATUS"`, `"RESOLUTION_RECONCILIATION"`, `"DIRECTORY_ACTIVITY"`, `"PAYMENT_CREDENTIAL_DETAILS"` | No | #### PaymentCredentialType Schema Payment credential type | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialType | string,
**Available values:** "BANK", "CARD" | Payment credential type | | **Example** 
CARD
#### Error422Response Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error. Fixed 422 in this case
*Example:* `"422"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### Error404IdResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error.
*Example:* `"LDS-30010"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### Error422CreateAliasResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error.
*Example:* `"LDS-30000"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### AliasProfileResponse-1 Schema Profile details for the customer that owns the Alias. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | address | { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: } | | No | | lastName | | Last name in English. ISO20022 element name: Creditor -> Name Example: "Miller"
*Example:* `"Miller"` | Yes | | firstName | | First name in English ISO20022 element name: Creditor -> Name
*Example:* `"Alex"` | Yes | | middleName | | Middle name in English
*Example:* `"Robert"` | No | | contactInfo | | | No | | dateOfBirth | | Date of birth. ISO20022 element name: Creditor -> Private Identification -> Date of Birth | No | | lastNameLocal | | Last name in English. ISO20022 element name: Creditor -> Name Example: "Miller"
*Example:* `"Miller"` | No | | preferredName | | Preferred name (or the 'known-as' name)
*Example:* `"Miller's Shop"` | No | | firstNameLocal | | First name in local language
*Example:* `"Alexander"` | No | | middleNameLocal | | Middle name in local language
*Example:* `"Roberto"` | No | #### FiltersResolve Schema List of the filter to apply in the request | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | FiltersResolve | | List of the filter to apply in the request | | #### Error400GetAliasResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | | Description of the error reason | Yes | #### Error404ReportFileResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error.
*Example:* `"RES-30007"` | Yes | | errorMessages | | Description of the error reason | Yes | #### AliasStatuses-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasStatuses-1 |
**Available values:** "ACTIVE", "DISABLED", "BLOCKED", "EXPIRED", "DELETED" | | | #### BatchId Schema This is the UUID generated by Alias Directory which identifies the Batch process | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BatchId | string | This is the UUID generated by Alias Directory which identifies the Batch process | | **Example** 
e336c8c8-2945-4be3-af3e-951ec2d01219
#### PaymentCredentialItemRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialItemRequest-1 | { **"type"**:
**Available values:** "BANK", "CARD", **"externalId"**: , **"preferredFor"**: } & { **"type"**: , **"cardType"**: , **"issuerName"**: , **"nameOnCard"**: , **"currencyCode"**: , **"accountNumber"**: , **"billingAddress"**: { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: }, **"expirationDate"**: undefined (YYYY-MM) } or { **"type"**:
**Available values:** "BANK", "CARD", **"externalId"**: , **"preferredFor"**: } & { **"BIC"**: , **"type"**: , **"address"**: { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: }, **"bankCode"**: , **"bankName"**: , **"branchCode"**: , **"accountName"**: , **"accountType"**:
**Available values:** "CHECKING", "SAVING", **"countryCode"**: undefined (We recommend to use the Alpha-3), **"bankCodeType"**:
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: , **"accountNumber"**: , **"accountNumberType"**:
**Available values:** "IBAN", "DEFAULT", "TOKEN", "CCI" } | | | #### PaymentCredentialItemAliasResponseResolve-4 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialItemAliasResponseResolve-4 | { **"modifiedOn"**: undefined (date-time) } or { **"modifiedOn"**: undefined (date-time) } | | | #### PaymentCredentialItemAliasResponseResolve-5 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialItemAliasResponseResolve-5 | { **"modifiedOn"**: undefined (date-time) } or { **"modifiedOn"**: undefined (date-time) } | | | #### AliasValueRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliasValue | string | A customer unique identifier that represents him in the payment ecosystem where the user move funds. The format will change depending the type.
*Example:* `"1231231234"` | Yes | #### Error500Response-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 500 in this case
*Example:* `"500"` | Yes | | errorMessages | | Description of the error reason | Yes | #### PaymentCredentialItemAliasResponseResolve-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialItemAliasResponseResolve-2 | { **"modifiedOn"**: undefined (date-time) } or { **"modifiedOn"**: undefined (date-time) } | | | #### PaymentCredentialsList-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialsList-1 | | | | #### PaymentCredentialItemAliasResponseResolve-3 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialItemAliasResponseResolve-3 | { **"modifiedOn"**: undefined (date-time) } or { **"modifiedOn"**: undefined (date-time) } | | | #### PaymentCredentialItemAliasConfirmResponsePath Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialItemAliasConfirmResponsePath | { **"type"**: , **"issuerName"**: } or { **"type"**: , **"bankName"**: } | | | #### GetFileResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | GetFileResponse-1 | | | | #### UserDetails-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | userName | | An identifier that represents the end user who is requesting the information. This field must not contain any PII information.
*Example:* `"username1234"` | Yes | #### Error422Response-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 422 in this case
*Example:* `"422"` | Yes | | errorMessages | | Description of the error reason | Yes | #### GetByExternalIdRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | string,
**Available values:** "ALIAS", "PAYMENT_CREDENTIAL" | The entity type associated to the external Id
*Enum:* `"ALIAS"`, `"PAYMENT_CREDENTIAL"` | Yes | | externalId | string | External Id (maintained by client) associated to the entity `type` | Yes | #### AliasInquiryResponseInternal Schema Alias Inquiry Response Payload | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | details | [ { **"aliasType"**: string,
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME", **"aliasValue"**: string, **"directories"**: [ { **"entities"**: [ { **"id"**: string, **"preferredFor"**: [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } ], **"directoryName"**: string } ], **"directoriesName"**: [ string ] } ] | Alias information associated with found records | No | | summary | { **"aliasesFound"**: integer, **"aliasesTotal"**: integer, **"aliasesNotFound"**: integer, **"aliasesRepeated"**: integer } | Summary of found Aliases | Yes | **Example** 
{
  "details": [
    {
      "aliasType": "PHONE",
      "aliasValue": "123456",
      "directories": [
        {
          "entities": [
            {
              "id": "1101"
            },
            {
              "id": "1102",
              "preferredFor": [
                {
                  "date": "1980-02-01T10:00:00Z",
                  "type": "RECEIVE"
                }
              ]
            }
          ],
          "directoryName": "DIRECTORY_A"
        },
        {
          "directoryName": "DIRECTORY_B"
        }
      ],
      "directoriesName": [
        "DIRECTORY_A",
        "DIRECTORY_B"
      ]
    }
  ],
  "summary": {
    "aliasesFound": 1,
    "aliasesTotal": 1,
    "aliasesNotFound": 0,
    "aliasesRepeated": 0
  }
}
#### BankGetResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | id | | This is an UUID generated by Alias Directory which identifies the payment credential
*Example:* `"a44c9553-e687-4f3c-b7e7-a4245d9f238e"` | No | | type | | In this case, the value must be `BANK`
*Example:* `"BANK"` | No | #### PaymentCredentialCommon Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | string,
**Available values:** "BANK", "CARD" | Payment credential type
*Enum:* `"BANK"`, `"CARD"`
*Example:* `"CARD"` | Yes | | externalId | string | 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"` | No | | preferredFor | [ { **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] | 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. | No | #### AliasInquiryResponseAD Schema Alias Inquiry Response Payload | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | details | | Alias information associated with found records
*Example:* `[{"entities":[{"id":"123","preferredFor":[{"date":"1980-02-01T10:00:00Z","type":"RECEIVE"}]}],"aliasType":"PHONE","aliasValue":"123456789"},{"entities":[{"id":"988","preferredFor":[{"date":"1980-02-01T10:00:00Z","type":"RECEIVE"}]}],"aliasType":"EMAIL","aliasValue":"visa@visa.com"},{"entities":[{"id":"abc"}],"aliasType":"PHONE","aliasValue":"+987456321"}]` | No | #### Error404ReportResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error.
*Example:* `"RES-30004"` | Yes | | errorMessages | | Description of the error reason | Yes | #### PaymentCredentialItemAliasResponseResolve-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialItemAliasResponseResolve-1 | { **"modifiedOn"**: undefined (date-time) } or { **"modifiedOn"**: undefined (date-time) } | | | #### PaymentCredentialType-1 Schema Payment credential type | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialType-1 |
**Available values:** "BANK", "CARD" | Payment credential type | | **Example** 
CARD
#### AliasResolveBasicResponseAD-5 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | profile | { **"lastName"**: , **"firstName"**: , **"middleName"**: , **"contactInfo"**: , **"dateOfBirth"**: , **"lastNameLocal"**: , **"preferredName"**: , **"firstNameLocal"**: , **"middleNameLocal"**: } | Profile details for the customer that owns the Alias | Yes | | identification | { **"type"**: , **"value"**: , **"verificationDetails"**: { **"authDateTime"**: undefined (date-time), **"verifiedEmail"**: , **"verifiedPhone"**: , **"creationDateTime"**: undefined (date-time), **"authMethodReference"**: } } | Form of identification. This object is optional and only used for specific use cases. | No | | paymentCredentials | | List of payment credentials associated with an Alias | Yes | #### AlphaCountryCodeAD Schema this field contains ISO3166 country code (Alpha-3). | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AlphaCountryCodeAD | | this field contains ISO3166 country code (Alpha-3). | | **Example** 
USA
#### CardAliasConfirmResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | CardAliasConfirmResponse-1 | { **"type"**: , **"issuerName"**: , **"modifiedOn"**: undefined (date-time), **"nameOnCard"**: , **"currencyCode"**: , **"preferredFor"**: , **"billingAddress"**: { **"country"**: }, **"accountNumberType"**:
**Available values:** "NIUBIZ", "TOKEN", "PAN" } | | | #### FileId Schema This is the UUID generated by the Report which identifies the File who is part of the report | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | FileId | string | This is the UUID generated by the Report which identifies the File who is part of the report | | **Example** 
e336c8c8-2945-4be3-af3e-951ec2d01219
#### AliasResolveBasicResponseAD-3 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | profile | { **"lastName"**: , **"firstName"**: , **"middleName"**: , **"contactInfo"**: , **"dateOfBirth"**: , **"lastNameLocal"**: , **"preferredName"**: , **"firstNameLocal"**: , **"middleNameLocal"**: } | Profile details for the customer that owns the Alias | Yes | | identification | { **"type"**: , **"value"**: , **"verificationDetails"**: { **"authDateTime"**: undefined (date-time), **"verifiedEmail"**: , **"verifiedPhone"**: , **"creationDateTime"**: undefined (date-time), **"authMethodReference"**: } } | Form of identification. This object is optional and only used for specific use cases. | No | | paymentCredentials | | List of payment credentials associated with an Alias | Yes | #### AliasResolveBasicResponseAD-4 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | profile | { **"lastName"**: , **"firstName"**: , **"middleName"**: , **"contactInfo"**: , **"dateOfBirth"**: , **"lastNameLocal"**: , **"preferredName"**: , **"firstNameLocal"**: , **"middleNameLocal"**: } | Profile details for the customer that owns the Alias | Yes | | identification | { **"type"**: , **"value"**: , **"verificationDetails"**: { **"authDateTime"**: undefined (date-time), **"verifiedEmail"**: , **"verifiedPhone"**: , **"creationDateTime"**: undefined (date-time), **"authMethodReference"**: } } | Form of identification. This object is optional and only used for specific use cases. | No | | paymentCredentials | | List of payment credentials associated with an Alias | Yes | #### AliasInquiryEntityDetail Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | entities | [ { **"id"**: string, **"preferredFor"**: [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } ] | A list of entities | No | | directoryName | string | The name of the directory
*Example:* `"Directory A"` | No | #### AliasResolveBasicResponseAD-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | profile | { **"lastName"**: , **"firstName"**: , **"middleName"**: , **"contactInfo"**: , **"dateOfBirth"**: , **"lastNameLocal"**: , **"preferredName"**: , **"firstNameLocal"**: , **"middleNameLocal"**: } | Profile details for the customer that owns the Alias | Yes | | identification | { **"type"**: , **"value"**: , **"verificationDetails"**: { **"authDateTime"**: undefined (date-time), **"verifiedEmail"**: , **"verifiedPhone"**: , **"creationDateTime"**: undefined (date-time), **"authMethodReference"**: } } | Form of identification. This object is optional and only used for specific use cases. | No | | paymentCredentials | | List of payment credentials associated with an Alias | Yes | #### AliasResolveBasicResponseAD-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | profile | { **"lastName"**: , **"firstName"**: , **"middleName"**: , **"contactInfo"**: , **"dateOfBirth"**: , **"lastNameLocal"**: , **"preferredName"**: , **"firstNameLocal"**: , **"middleNameLocal"**: } | Profile details for the customer that owns the Alias | Yes | | identification | { **"type"**: , **"value"**: , **"verificationDetails"**: { **"authDateTime"**: undefined (date-time), **"verifiedEmail"**: , **"verifiedPhone"**: , **"creationDateTime"**: undefined (date-time), **"authMethodReference"**: } } | Form of identification. This object is optional and only used for specific use cases. | No | | paymentCredentials | | List of payment credentials associated with an Alias | Yes | #### UpdateCard Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | string | In this case, value must be: `CARD`
*Example:* `"CARD"` | No | | cardType | string | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Platinum.
*Example:* `"Visa Platinum"` | No | | issuerName | string | Name of the issuer of the card
*Example:* `"Bank A"` | No | | nameOnCard | string | 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"` | Yes | | currencyCode | string | 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"` | No | | billingAddress | { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string } | | Yes | | expirationDate | string (YYYY-MM) | Expiration date for the card. This is required for certain markets.
*Example:* `"2022-12"` | Yes | #### AliasConfirmBasicResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | profile | { **"lastName"**: , **"firstName"**: , **"middleName"**: , **"lastNameLocal"**: , **"firstNameLocal"**: , **"middleNameLocal"**: } | Profile details for the customer that owns the Alias. | Yes | | aliasType | | The type of Alias resolved.
*Example:* `"PHONE"` | No | | aliasValue | | The value of the Alias resolved.
*Example:* `"1231231234"` | No | | directoryName | | Name of the external directory where was found the payment
*Example:* `"DIRECTORY_A"` | No | | additionalInfo | { **"validationResult"**: { **"status"**:
**Available values:** "MATCH", "NO_MATCH", "NOT_PROVIDED" } } | Additional information returned in the confirm response. | No | | paymentCredentials | | List of payment credentials linked to an Alias | Yes | #### PaymentCredentialPreferredForWithDateItem-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | date | undefined (date-time) | Date and time when set as preferred
*Example:* `"2021-01-01T22:52:46Z"` | Yes | | type |
**Available values:** "RECEIVE", "SEND", "PAY" | Type of preference
*Enum:* `"RECEIVE"`, `"SEND"`, `"PAY"` | Yes | #### AliasResolveBasicResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | profile | { **"lastName"**: , **"firstName"**: , **"middleName"**: , **"contactInfo"**: , **"dateOfBirth"**: , **"lastNameLocal"**: , **"preferredName"**: , **"firstNameLocal"**: , **"middleNameLocal"**: } | Profile details for the customer that owns the Alias. | No | | directoryName | | Name of the external directory where was found the payment
*Example:* `"DIRECTORY_A"` | No | | identification | { **"type"**: , **"value"**: , **"verificationDetails"**: { **"authDateTime"**: undefined (date-time), **"verifiedEmail"**: , **"verifiedPhone"**: , **"creationDateTime"**: undefined (date-time), **"authMethodReference"**: } } | Form of identification. This object is optional and only used for specific use cases. | No | | paymentCredentials | | List of payment credentials linked to an Alias | Yes | #### Error422PcStatusResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 422 in this case
*Example:* `"422"` | Yes | | errorMessages | | Description of the error reason | Yes | #### GetAliasMetadataResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | GetAliasMetadataResponse-1 | | | | #### AccountNumberType Schema Card account number type. Valid values: 'NIUBIZ', 'PAN' and 'TOKEN'. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AccountNumberType | string,
**Available values:** "NIUBIZ", "PAN", "TOKEN" | Card account number type. Valid values: 'NIUBIZ', 'PAN' and 'TOKEN'. | | **Example** 
TOKEN
#### Error422PcResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error.
*Example:* `"LDS-30012"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### AliasInquiryRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliases | | Array of Aliases e.g., phone numbers, email addresses or payname. | Yes | | filters | | List of the filter to apply in the request | No | | userDetails | { **"userName"**: } | | No | | transactionDetails | { **"currencyCode"**: } | | No | #### BankAliasConfirmResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BankAliasConfirmResponse-1 | { **"type"**: , **"address"**: { **"country"**: }, **"bankName"**: , **"modifiedOn"**: undefined (date-time), **"accountName"**: , **"countryCode"**: , **"currencyCode"**: , **"preferredFor"**: , **"accountNumberType"**:
**Available values:** "IBAN", "DEFAULT" } | | | #### AliasResolveBasicResponse-4 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | directoryName | | Name of the external directory where was found the payment
*Example:* `"DIRECTORY_A"` | No | | paymentCredentials | | List of payment credentials linked to an Alias | Yes | #### UpdateAliasRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | UpdateAliasRequest | { **"consent"**: { **"version"**: string, **"presenter"**: string, **"expiryDateTime"**: dateTime, **"intermediaries"**: [ string ], **"validFromDateTime"**: dateTime } } & { **"profile"**: { **"lastName"**: string, **"firstName"**: string, **"middleName"**: string, **"contactInfo"**: [ { **"type"**: string,
**Available values:** "EMAIL", "PHONE", "DIRECTORY_ALIASID", **"value"**: string } ], **"dateOfBirth"**: string, **"lastNameLocal"**: string, **"preferredName"**: string, **"firstNameLocal"**: string, **"middleNameLocal"**: string }, **"identification"**: { **"type"**: string, **"value"**: string, **"verificationDetails"**: { **"authDateTime"**: dateTime, **"verifiedEmail"**: boolean, **"verifiedPhone"**: boolean, **"creationDateTime"**: dateTime, **"authMethodReference"**: string } } } | | | #### BaseAliasResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | profile | { **"address"**: { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: }, **"lastName"**: , **"firstName"**: , **"middleName"**: , **"contactInfo"**: , **"dateOfBirth"**: , **"lastNameLocal"**: , **"preferredName"**: , **"firstNameLocal"**: , **"middleNameLocal"**: } | Profile details for the customer that owns the Alias. | No | #### AliasInquiryDetails-1 Schema Alias information associated with found records | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasInquiryDetails-1 | | Alias information associated with found records | | #### CardRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be: `CARD`
*Example:* `"CARD"` | No | | cardType | | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Platinum.
*Example:* `"Visa Platinum"` | Yes | | issuerName | | Name of the issuer of the card
*Example:* `"Bank A"` | Yes | | nameOnCard | | 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"` | Yes | | currencyCode | | 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"` | No | | accountNumber | | Primary account number of the card
*Example:* `"4111111145551142"` | Yes | | billingAddress | { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: } | | Yes | | expirationDate | undefined (YYYY-MM) | Expiration date for the card. This is required for certain markets.
*Example:* `"2030-01"` | Yes | #### BaseAliasRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | profile | { **"lastName"**: string, **"firstName"**: string, **"middleName"**: string, **"contactInfo"**: [ { **"type"**: string,
**Available values:** "EMAIL", "PHONE", "DIRECTORY_ALIASID", **"value"**: string } ], **"dateOfBirth"**: string, **"lastNameLocal"**: string, **"preferredName"**: string, **"firstNameLocal"**: string, **"middleNameLocal"**: string } | Profile details for the customer that owns the Alias. | Yes | | identification | { **"type"**: string, **"value"**: string, **"verificationDetails"**: { **"authDateTime"**: dateTime, **"verifiedEmail"**: boolean, **"verifiedPhone"**: boolean, **"creationDateTime"**: dateTime, **"authMethodReference"**: string } } | Form of identification. This object is optional and only used for specific use cases. | No | #### UpdateAliasStatusRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | status |
**Available values:** "ACTIVE", "DISABLED" | Set the new status for the Alias.
*Enum:* `"ACTIVE"`, `"DISABLED"` | No | #### Error422CardAlreadyExists-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error.
*Example:* `"CVC-30010"` | Yes | | errorMessages | | Description of the error reason | Yes | #### AssociatedIdType Schema Associated Id type | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AssociatedIdType | string,
**Available values:** "ALIAS", "PAYMENT_CREDENTIAL" | Associated Id type | | **Example** 
PAYMENT_CREDENTIAL
#### AliasInquiryResponse Schema Alias Inquiry Response Payload | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | details | | Alias information associated with found records
*Example:* `[{"entities":[{"id":"123","preferredFor":[{"date":"1980-02-01T10:00:00Z","type":"RECEIVE"}]}],"aliasType":"PHONE","aliasValue":"123456789"},{"entities":[{"id":"988","preferredFor":[{"date":"1980-02-01T10:00:00Z","type":"RECEIVE"}]}],"aliasType":"EMAIL","aliasValue":"visa@visa.com"},{"entities":[{"id":"abc"}],"aliasType":"PHONE","aliasValue":"+987456321"}]` | No | #### Error404ResponseAD Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 404 in this case.
*Example:* `"404"` | Yes | | errorMessages | | Textual description for the reason of the error | Yes | #### BatchProcessRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | data | | Encrypted data containing the requests to be executed in the batch process. Please refer to the product documentation on batch processing for more information on how to generate the encrypted data.
*Example:* `"wpoqObsnVdsomACBb2lmBxhu8vbzVzWGHE6b8O2roVPgeeY4/L0+CdDLNUQ330auPASv38e+8g9M1OkPleF8iTBuEd4UNxMvSMyoRIw5ni9bAN4hG/Xp21FMU+6gB1MUi5guayYpxeVoEW6Zm1IdHBF7NHHiUHQqYvh1710o5/SgQIqF41+lH1Kc/zNGoPiCc23KrmiXHcXVbCemISxKOAYatAn/tz4c1ma9HgE/UuG0+mciRU7eCd3GRJIzCOZR7oimGyfI8oZTq6bjJvEqXv4MUkVc4PbvqpY762+E625gpT5xi768BqwtPMO6eJ/oRNQaS7nkeZzykypN+DxUw1sZ+sn3cYMmPO8ma8L0mPLPp/PWuFY0EP5ef6hHpCcIyVfbaQQJfqHxrPyzpGiOam9vjiT4zNPQAnT80LqWnwK572zp8TXvEDMvBT0tSLjq6XVeZ/mH2f6Yas6x/73zU44ZayMkSytdS/aQnh3OnhDzdczNCyiZ95gobuEui2o1M6/O4mtQWVprxlhcM2QqxSVxqdqIRnnRztCm5ffy6pASNAwanuOJQXzedUdUPVqRN6zwqjibnfnmDrMR4C03R725Pz0xPQexc04Tyepb5gWkDc3jhU7w+ErYBN7NbMFrwrvwVWGC/uOOWwg/qOUu0Qf5iUYza0tSaTHj4e4m4h2FngPV5gKGF9vfiGwz26VvlHsCbPDWsIp5wnh3UgbpCoAOjrUYe7rslFVGLDBa6gLqOCOrquK9EXthonYBsywL63WjdM6kw1QaAJ2478Ic+SGJTQmztccN08irCIVQ02c0vcBQCjlbYoQTXB948PxKP6fxBW5O5GzUrtOemGTMWhQ/V8dOUDNJlo4KdKaQMsoMxgGb6Kk/WAbhtIkXOdDOTgwTZ7mVyoDH6tysTKGNu4uJPOJZd26u2rSXC+umcIwV528qO+Vu1QyF3Aklx+l4rIPOaOzcX35nHEBDO2Eznzn94MMVIW6JinCSt5wbRK9To5wGSFbJ3TUmbJSjbddmQPSzR06sZGX1R8kmDaLr2bGodxPL37JHrpg2uNUW5icEY0m0bKUxx9IupqbQeGJeB/rglh6+QU5nFZ8RzScLnENDxuCxM8D+IY0d8zDOGvKQUmLdgEEQhzOyNcj5lHTrNvH5VvYAtSL5xM+dj5a8v89nTIh+lhwqcKvS1YNlL3ZPcqMTXNzN3yF+XdkSsczzG2y08xXQYV6x89o84Lu5GUlTJUtH1CGuNzR6LGaztqCdMEfyuMdA2raSW3zr01bPFu+zJEtPD2fC1G3R6N3vzXUXBYYghyp7RLDQEaMT6Smv5Lg6CIYw3oLeylKbw9wS6SrEwBas3X8MDHP6KpUKeEe2ihDiyVImeashk9CpO9qQC/lRt5zQg+tkLtLyycBvDU6D59AC8Q/3Xe06EJ/55byERDfzp0gu74SXabiPJeje7z4CHjAy2pL3m8MXFGymZ7ipPAMIjv9ClW2mCzgTqo/eT9b2dcSu1fIKcCH+DjYgmb7UeyY7XK5fqYOxF5cr2UrCTm4zE+ycUVlAZN1C5oDbXJShB9GYl4OkTdrb9P2kIJz3434kbkKjNtFoquv1b5z5EPWWY+H4TkyBd5bg7WBOcjJJ0sUQg53X/Tua4wOcNT+20YhiWR/Wx1dfrA1jDcxLcXgzk0Bo5aWPUU4RzptRIahFZd8b+ZbEknrFlpY1XHRdhD6vXBibDTHNy3lRwFgXF5Tet1RozW8cj0grfLP1+l6x/NhJ/mijjtOgs0pX1YIwuicPPYRjzqssXawqCghjH8G5+ZwTn4MybYtY9BAgnDYaP5Sz9b1N8cnvlqnfulKUqgDfLEkpQCg1qlXLjZnauZ5sRaNlyfoMPB76z5wSUlpvTVVm+2+xI7E8iYSKxTIpSzzoHoaLbI8BnK4GoRzp28j3ol2eXO60EhwuxDHR4i3frTs4/jFUaoRQiDu2KLm9wvsL4+TFlC+mmRyre0H+fpXQfJQ5EKexWWe8Ier+2x0ZyPioULCMxbbvWv96BX+yWrAWhaI6RXWi1tcWtkdoKkeHTyT34yVEYyWWp51/NZM+WTi8pU5NW2BNa6VBEdM8X2XM75ShlNwcNY6TjxzmebfQLp+Z9IA9sOXQyJme1iJ0cbGvhg9d7vnAfXH+wBJWyFgi2sDgrK2VnExEE07ZqBsWMBf75TESnbBnSSh+X0R0VxXHy2PBT9678eoo3MPBLOjOEIJCd0K/nrG753bqo7h3by/fW4/lB2wsfFEsB4i7UCTRzAA64pBmkGM0K8+QIH6osd5qnbO9P+yOOoNkvrqwy6aL21RWNFX0W87+GzDpWEYSPJ0wpP9qfGmfKRuPc0J3GgDDIr1URNn3UgTZSqUJCmIPpyI0Kojc8lRUO8kfyJ42tioYh+WM5BDprltnHRPyNTq7uTwZAHFdY0CVHymlVPe5yB14Gz+8qFRbAtzXkC5wwXK8S0KU4Espp8b3rC+Uy2DeZeIFBBtDJOHH3JNavZBdKafv/TvfBSyfbLb8Uvus8ypgJaQp5lJTwukJJjiTVry8DDu6kxZUfXs9uUhbMwenhjgpWKHBSgeXlGJW7Ms2hkGiuNZlVf34qYvjUdNfxsS6zQrvP+tuk5l9duYqLUgYXBSau+EA6kAiSSwFucns2BhOMEJxCBDGRf0AyYriOKS5OzIgi0lH2SmxqDErMJs5+0/lhxNs6hZU0/mfa40co51AV1Jt/lK/k6uexRALqf9rOQ3wO/oni0u7NehnsHxXi7YJyei/8njF8UAxQ0DSWl2eimMk1H+Zodp33JzGVvedqzcabVtUQaOpt9DoCGjXJ7Ny8a9SIbGnVzRQYY4EGlgJXXr4fJ+jwDKx71Sg1RcMWoDxuyJCkc1YhCb/O7JNISrBV4WX0ilpNSDRUgRUzbF5VpB9v2pPWMWTO9ETyTE65fe3L36fYjF92qf6fphmqpUY35FwlOT9/S31pb4NsYbxcLPIUqgZZcQR/ArQAWxIVfQbl+ZurZ565Ojy7YnoFsL3eakLtJDIGKY8HqAvLPkEeJBl25IPjgtu3trJPKbVX3ZjMvWMezVoZA272jz5NElMAHgvOOlMDALgMGXgQWFf3WezXklJLaq5nD7lAte7NQzfjOKbaDBLXrgNnZ+PxQJWLnLKY0y8G8k482YadksJxXBuYpd/MpFN34f/lTl8na6TzsnaiBkYr2kr8tt5C2rfWOBiPOV2CQJNtcXRY8c0Il54hAk7LIWJGTvpFZdkZBg9GqBy2G1yerJnvhI2zlj6pPZh4BdY/dpxbA85WC5BdnyLRrsdXj0TXrYGuDWkDJbBwWcqTUjwuo82mHMECi5XckuVXP3SXQsDjRuFYeIqhmKtSh/yLj4wWBKtvNP/TC6iOlVZWC6meUIyti99DP2svO6xKH6p2Ek543YiC0u4HoV4VMe3dVj+l0xuLq3yOdP+kHYATSeERLWq1Ph0DfYL/3I5Gxo6b4KkkRAXTyhvARoM/eSladJQ9mUjgyAYM12gQsZZmmWUa9u0PCYtm/Dzz0H8Xne4OfUU82QLLv0PMWrdfGSSfyvWBR9/kBPdwkU/GpAATxcGmzz8uO5p93edRZXyn9Qo68cYQm+QQb4opanfmlhV27EKW3XXXt8OyGQk4p2n+6+SJ2UGWIJ2WwlMjyCVu7CDDtSkN160rGF+BMquxlqFudLRGRga4LumYJ2kuVPgU8inwvJrTKN80WY8PH8B1vtPcGSKzRmT84CsJAThalUUnnSFozXP+nWv3fnFbjBtfSAm9RjX/jg1sy/DILx7LX9bGrT9G8dYK0B4XchPy7UjbXF6qp7Bp0CZjLqbQh1DAW8numBjrrZkKJr1hNyGLACduYZktoFNefGseTj9FJErOyxxXHXSE5vovGZDToDMqrHE/8C1y60AC+CTePjcdYxQdfJADfBsqhm4oXr+z4VD39u3DJIDSaBl2KRjpWFyaHWVOaSss4jDB3lFndfa4C1Kq5KtPBgdXVTIN1tiyytigLLioJBrl8xdYdFVneeZ51lottKu2ktn0M8zaFHQW4KluziPgVMnJYmxlD9eHRASxuaXWMV+qdldk5PfZfowzcOkcIMgUFHRh5o3WOyTSb7ECSJJWS9yaPdAzHXYeTmMWMYf3USv82y0KxgaTfmLrb1zLJiawqby62zNVznJLddfU8kDoscyK0RcgtJiAXRdl84DUZnuQot9JfgmptnAqUujt6FeLhrDCYeXJ7Dx8cKBJhhmIxYR4GsTTUlcTG0HUhllcBOa2raK1fofaOZeYFaHR1PZicwjtUwwrKFyLM/MzzeHLbinRRzZlIoXFBz7949km6k/oLEz+TL/AqfyoFCIxAHTcL69uVzSSBoqpdSFKWJQw1Q3WXipEEwJyVrUGTqLKzEZHG4pVHgfIZBu5qrvaNo/RhV3cFHpnRAEozcWJ+slOzPAUJaoTJ/bNveDGlBns07kFYFqeIIG8y8IqmVlPhzVHf9JvqUVh/ItoUYxM6ehWIB8SPlVfAWQ3U7D1zIJQIawrK9QsFdMM/5Kp65BfxMEPS8KyZh6NvbBm6Bv8Kr50Sf++TjfU5DeUk3MUHYcd9CmT+GOk0hjdm154MV1mk2+VBqp4s9RVvKggD0PnBxbSq6+Nt5enlarjslprVv8PCV8UaTV0z1GBUJd6HQtR+wLEQ05xr8btAxi2s9PT5ggqfCNDEI0BitRp66be1vG/ifcudx++FYIIvhzsYtN6OhTnALpnfAN+zpWY6tAmoJtENnSb5OF8SJx3auIPJL/pxgdMke3UTWBpwFM2H0W9QDXKbdnBTEhL1fl+szA6jIv"` | Yes | | keyId | | This identifies a specific batch operation job. Please use the “id” value retrieved from the /batchKeys endpoint.
*Example:* `"e336c8c8-2945-4be3-af3e-951ec2d01219"` | Yes | | operation |
**Available values:** "CREATE_ALIAS", "DELETE_ALIAS", "UPDATE_BANK_PAYMENT_CREDENTIAL" | The operation to be performed in the batch process, e.g., Create Alias. Only one operation can be used for each batch process request.
*Enum:* `"CREATE_ALIAS"`, `"DELETE_ALIAS"`, `"UPDATE_BANK_PAYMENT_CREDENTIAL"` | Yes | #### BIC Schema Business Identifier Code (BIC) of the Sponsor FI (Acquirer) ISO20022 field name: Debtor Agent FI BIC | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BIC | string | Business Identifier Code (BIC) of the Sponsor FI (Acquirer) ISO20022 field name: Debtor Agent FI BIC | | **Example** 
AAAABBCC123
#### BankAliasResponseResolve Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BIC | | Bank account Business Identifier Code (BIC) Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> BICFI
*Example:* `"12345678"` | No | | type | | In this case, value must be: `BANK`
*Example:* `"BANK"` | Yes | | address | { **"city"**: , **"state"**: , **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: } | | No | | bankCode | | Bank account bank code Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification
*Example:* `"173"` | No | | bankName | | Bank name of the payment credential ISO20022 element name: Creditor Agent -> Financial Institution -> Name
*Example:* `"Bank of America"` | Yes | | branchCode | | Bank account branch code Conditional for select markets. ISO20022 field name: Creditor Agent Branch Identification
*Example:* `"123456"` | No | | accountName | | Bank account name, i.e., accountholder name as recorded on the bank account ISO20022 element name: Creditor Account -> Name
*Example:* `"WALLETX"` | Yes | | accountType |
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN" | Bank account type ISO20022 element name: Creditor Account -> Type
*Enum:* `"CHECKING"`, `"SAVING"`, `"MAESTRA"`, `"VISTA"`, `"LOAN"` | No | | countryCode | | Bank account country code. Format: 3-character ISO-3166 (Alpha-3) country code ISO20022 element name: Creditor Agent -> Financial Institution -> Country
*Example:* `"USA"` | Yes | | bankCodeType |
**Available values:** "ABA", "SORT_CODE", "DEFAULT" | Bank account bank code type Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification -> Clearing System Identification
*Enum:* `"ABA"`, `"SORT_CODE"`, `"DEFAULT"` | No | | currencyCode | | Bank account currency code Format: 3-character ISO-4217 (Alpha-3) currency code ISO20022 element name: Creditor Account -> Currency
*Example:* `"USD"` | Yes | | preferredFor | | 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. | No | | accountNumber | | Bank account number ISO20022 element name: Creditor Account Number
*Example:* `"4111111145551140"` | Yes | | accountNumberType |
**Available values:** "IBAN", "DEFAULT" | Bank account number type. Valid values: "IBAN" and "DEFAULT". If the IBAN format is not supported in a country, use DEFAULT.
*Enum:* `"IBAN"`, `"DEFAULT"`
*Example:* `"DEFAULT"` | Yes | #### Error400CreateAliasResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | | Description of the error reason | Yes | #### AliasValueRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliasValue | | A customer unique identifier that represents him in the payment ecosystem where the user move funds. The format will change depending the type.
*Example:* `"1231231234"` | Yes | #### PaymentCredentialModifiedOn Schema Date of the last update of the payment credential, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialModifiedOn | dateTime | Date of the last update of the payment credential, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z | | **Example** 
2021-01-01T22:52:46.000Z
#### PaymentCredentialPreferredForWithDateItem Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | date | dateTime | Date and time when set as preferred
*Example:* `"2021-01-01T22:52:46Z"` | Yes | | type | string,
**Available values:** "RECEIVE", "SEND", "PAY" | Type of preference
*Enum:* `"RECEIVE"`, `"SEND"`, `"PAY"` | Yes | #### AccountNumber Schema When present, this field contains recipient’s account number at the bank. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AccountNumber | string | When present, this field contains recipient’s account number at the bank. | | **Example** 
3012345678901432
#### Error404AliasResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error.
*Example:* `"LDS-30002"` | Yes | | errorMessages | | Description of the error reason | Yes | #### AliasMetadataRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | action | string,
**Available values:** "ADD", "DELETE" | Mode of Action. ADD creates a new Alias metadata record. If the same Alias value is used, all information will be updated using the latest Create call. For example, the preferredFor can be removed for an existing Alias metadata record by not specifying a preferredFor in a ADD call. DELETE - Deletes an existing Alias metadata record.
*Enum:* `"ADD"`, `"DELETE"`
*Example:* `"ADD"` | Yes | | aliasType | string,
**Available values:** "PHONE", "EMAIL" | The type of Alias in aliasValue
*Enum:* `"PHONE"`, `"EMAIL"`
*Example:* `"PHONE"` | Yes | | aliasValue | string | The value of the Alias.
*Example:* `"19002387857"` | Yes | | preferredPaymentCredentials | [ { **"type"**: string,
**Available values:** "BANK", "CARD", **"preferredFor"**: [ { **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } ] | List of payment credentials to be linked to the Alias. | Yes | #### GenerateReportRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | format | string,
**Available values:** "JSON" | Format of created report.
*Enum:* `"JSON"` | No | | filters | { **"endDate"**: dateTime, **"aliasType"**: string,
**Available values:** "PHONE", "EMAIL", **"startDate"**: dateTime, **"aliasStatuses"**: [ string,
**Available values:** "ACTIVE", "DISABLED", "BLOCKED", "EXPIRED", "DELETED" ], **"billingEventTypes"**: [ string ] } | Define the data included in the report. | No | | reportType | string,
**Available values:** "PLATFORM_REQUESTS", "DIRECTORY_STATUS", "RESOLUTION_RECONCILIATION", "DIRECTORY_ACTIVITY", "PAYMENT_CREDENTIAL_DETAILS" | Report type to create.
*Enum:* `"PLATFORM_REQUESTS"`, `"DIRECTORY_STATUS"`, `"RESOLUTION_RECONCILIATION"`, `"DIRECTORY_ACTIVITY"`, `"PAYMENT_CREDENTIAL_DETAILS"` | No | #### UpdatePaymentCredentialRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | UpdatePaymentCredentialRequest-1 | { **"type"**: , **"cardType"**: , **"issuerName"**: , **"nameOnCard"**: , **"currencyCode"**: , **"billingAddress"**: { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: }, **"expirationDate"**: undefined (YYYY-MM) } & { **"type"**:
**Available values:** "BANK", "CARD", **"externalId"**: , **"preferredFor"**: } or { **"type"**:
**Available values:** "BANK", "CARD", **"externalId"**: , **"preferredFor"**: } & { **"BIC"**: , **"type"**: , **"address"**: { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: }, **"bankCode"**: , **"bankName"**: , **"branchCode"**: , **"accountName"**: , **"accountType"**:
**Available values:** "CHECKING", "SAVING", **"countryCode"**: undefined (We recommend to use the Alpha-3), **"bankCodeType"**:
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: } | | | #### AssociatedId Schema This is an UUID associated to external id | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AssociatedId | string | This is an UUID associated to external id | | **Example** 
a44c9553-e687-4f3c-b7e7-a4245d9f238e
#### GetAliasMetadataRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliases | [ string ] | Array of Aliases e.g., phone numbers or email addresses. | Yes | #### GetAliasMetadataResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | GetAliasMetadataResponse | [ { **"aliasValue"**: string, **"preferredPaymentCredentials"**: [ [ { **"type"**: string,
**Available values:** "BANK", "CARD", **"preferredFor"**: [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } ] ] } or { **"aliasValue"**: string, **"preferredPaymentCredentials"**: [ [ { **"type"**: string,
**Available values:** "BANK", "CARD" } ] ] } ] | | | #### DateTime-1 Schema ISO formatted Timestamp | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | DateTime-1 | undefined (date-time) | ISO formatted Timestamp | | **Example** 
2021-01-01T22:52:46Z
#### PaymentCredentialItemGetResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialItemGetResponse-1 | { **"type"**: , **"cardType"**: , **"issuerName"**: , **"nameOnCard"**: , **"currencyCode"**: , **"accountNumber"**: , **"billingAddress"**: { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: }, **"expirationDate"**: undefined (YYYY-MM), **"lastFourDigits"**: , **"accountNumberType"**:
**Available values:** "NIUBIZ", "TOKEN", "PAN" } & { **"type"**:
**Available values:** "BANK", "CARD", **"externalId"**: , **"preferredFor"**: } & { **"status"**:
**Available values:** "ACTIVE", "BLOCKED", "DISABLED", "EXPIRED", **"createdOn"**: undefined (date-time), **"lastUpdatedOn"**: undefined (date-time) } or { **"BIC"**: , **"type"**: , **"address"**: { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: }, **"bankCode"**: , **"bankName"**: , **"branchCode"**: , **"accountName"**: , **"accountType"**:
**Available values:** "CHECKING", "SAVING", **"countryCode"**: undefined (We recommend to use the Alpha-3), **"bankCodeType"**:
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: , **"accountNumber"**: , **"accountNumberType"**:
**Available values:** "IBAN", "DEFAULT", "TOKEN", "CCI" } & { **"type"**:
**Available values:** "BANK", "CARD", **"externalId"**: , **"preferredFor"**: } & { **"status"**:
**Available values:** "ACTIVE", "BLOCKED", "DISABLED", "EXPIRED", **"createdOn"**: undefined (date-time), **"lastUpdatedOn"**: undefined (date-time) } | | | #### Address Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | string | City ISO20022 element name: Creditor -> Postal Address -> Town Name
*Example:* `"San Francisco"` | No | | state | string (We recommend to use the ISO 3166-2) | State (ISO 3166-2)
*Example:* `"CA"` | No | | country | string (We recommend to use the Alpha-3) | Country code using 3-character ISO 3166 (Alpha 3) format ISO20022 element name: Creditor -> Postal Address -> Country
*Example:* `"USA"` | Yes | | postalCode | string | Postal code number of the addresses ISO20022 element name: Creditor -> Postal Address -> Postal Code
*Example:* `"94105"` | No | | streetName | string | Street Name
*Example:* `"12"` | No | | addressLine1 | string | Address line 1 ISO20022 element name: Creditor -> Postal Address -> Address Line
*Example:* `"1000 Market Street"` | No | | addressLine2 | string | Address line 2 ISO20022 element name: Creditor -> Postal Address -> Address Line
*Example:* `"Suite 101"` | No | | buildingNumber | string | Building number ISO20022 element name: Creditor -> Postal Address -> Building Number
*Example:* `"56"` | No | | minorSubdivisionCode | string | Minor Subdivision Code ISO20022 element name: Creditor -> Postal Address -> Country Sub Division
*Example:* `"CA"` | No | #### PaymentCredentialId Schema This is an UUID generated by Alias Directory which identifies the payment credential | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialId | string | This is an UUID generated by Alias Directory which identifies the payment credential | | **Example** 
a44c9553-e687-4f3c-b7e7-a4245d9f238e
#### Error400InquiryResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### PaymentCredentialCommonResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | string,
**Available values:** "BANK", "CARD" | Payment credential type
*Enum:* `"BANK"`, `"CARD"`
*Example:* `"CARD"` | Yes | | externalId | string | 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"` | No | | preferredFor | [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] | 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. | No | #### BaseAliasResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | profile | { **"lastName"**: string, **"firstName"**: string, **"middleName"**: string, **"contactInfo"**: [ { **"type"**: string,
**Available values:** "EMAIL", "PHONE", "DIRECTORY_ALIASID", **"value"**: string } ], **"dateOfBirth"**: string, **"lastNameLocal"**: string, **"preferredName"**: string, **"firstNameLocal"**: string, **"middleNameLocal"**: string } | Profile details for the customer that owns the Alias. | No | #### PreferredPaymentCredentialsPreferredForResponse-1 Schema Array of Card or BankAccount | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PreferredPaymentCredentialsPreferredForResponse-1 | | Array of Card or BankAccount | | #### ValidationResult Schema Validation result for identity verification. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | status |
**Available values:** "MATCH", "NO_MATCH", "NOT_PROVIDED" | Result of the identity validation.
*Enum:* `"MATCH"`, `"NO_MATCH"`, `"NOT_PROVIDED"` | Yes | #### DateTime Schema ISO formatted Timestamp | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | DateTime | dateTime | ISO formatted Timestamp | | **Example** 
2021-01-01T22:52:46Z
#### PreferredTypeRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | string,
**Available values:** "RECEIVE", "SEND", "PAY" | 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.
*Enum:* `"RECEIVE"`, `"SEND"`, `"PAY"`
*Example:* `"RECEIVE"` | Yes | #### PaymentCredentialItemGetResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialItemGetResponse | { **"type"**: string, **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string }, **"expirationDate"**: string (YYYY-MM), **"lastFourDigits"**: string, **"accountNumberType"**: string,
**Available values:** "NIUBIZ", "TOKEN", "PAN" } & { **"type"**: string,
**Available values:** "BANK", "CARD", **"externalId"**: string, **"preferredFor"**: [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } & { **"status"**: string,
**Available values:** "ACTIVE", "BLOCKED", "DISABLED", "EXPIRED", **"createdOn"**: dateTime, **"lastUpdatedOn"**: dateTime } or { **"BIC"**: string, **"type"**: string, **"address"**: { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", **"countryCode"**: string (We recommend to use the Alpha-3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", "TOKEN" } & { **"type"**: string,
**Available values:** "BANK", "CARD", **"externalId"**: string, **"preferredFor"**: [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } & { **"status"**: string,
**Available values:** "ACTIVE", "BLOCKED", "DISABLED", "EXPIRED", **"createdOn"**: dateTime, **"lastUpdatedOn"**: dateTime } | | | #### AliasListReportResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasListReportResponse-1 | | | | #### PreferredPaymentCredentialsRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | string,
**Available values:** "BANK", "CARD" | The type of Alias in aliasValue
*Enum:* `"BANK"`, `"CARD"`
*Example:* `"CARD"` | Yes | | preferredFor | [ { **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] | | No | #### CreatePaymentCredentialRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | CreatePaymentCredentialRequest | { **"type"**: string,
**Available values:** "BANK", "CARD", **"externalId"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } & { **"type"**: string, **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string }, **"expirationDate"**: string (YYYY-MM) } or { **"type"**: string,
**Available values:** "BANK", "CARD", **"externalId"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } & { **"BIC"**: string, **"type"**: string, **"address"**: { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", **"countryCode"**: string (We recommend to use the Alpha-3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", "TOKEN" } | | | #### CardAliasConfirmResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | CardAliasConfirmResponse | { **"type"**: string, **"issuerName"**: string } | | | #### UpdatePaymentCredentialRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | UpdatePaymentCredentialRequest | { **"type"**: string, **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string }, **"expirationDate"**: string (YYYY-MM) } & { **"type"**: string,
**Available values:** "BANK", "CARD", **"externalId"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } or { **"type"**: string,
**Available values:** "BANK", "CARD", **"externalId"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } & { **"BIC"**: string, **"type"**: string, **"address"**: { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", **"countryCode"**: string (We recommend to use the Alpha-3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string } | | | #### Error400ResolveResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### AssociatedIdType-1 Schema Associated Id type | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AssociatedIdType-1 |
**Available values:** "ALIAS", "PAYMENT_CREDENTIAL" | Associated Id type | | **Example** 
PAYMENT_CREDENTIAL
#### Error400UpdateAliasResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | | Description of the error reason | Yes | #### CardUpdateDetails-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, the value must be `CARD`
*Example:* `"CARD"` | No | #### UpdatePaymentCredentialStatusRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | status |
**Available values:** "ACTIVE", "BLOCKED", "DELETED", "EXPIRED", "DISABLED" | Set the new status for the Payment Credential.
*Enum:* `"ACTIVE"`, `"BLOCKED"`, `"DELETED"`, `"EXPIRED"`, `"DISABLED"` | No | #### Error400ExternalIdResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | | Description of the error reason | Yes | #### Error400ResponseAD Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 400 in this case.
*Example:* `"400"` | Yes | | errorMessages | | Textual description for the reason of the error | Yes | #### GetAliasMetadataRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliases | | Array of Aliases e.g., phone numbers or email addresses. | Yes | #### AliasInquiryDetails Schema Alias information associated with found records | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasInquiryDetails | [ { **"aliasType"**: string,
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME", **"aliasValue"**: string, **"directories"**: [ { **"entities"**: [ { **"id"**: string, **"preferredFor"**: [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } ], **"directoryName"**: string } ], **"directoriesName"**: [ string ] } ] | Alias information associated with found records | | #### Error400CreateAliasResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### Error500ResponseAD Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 500 in this case.
*Example:* `"500"` | Yes | | errorMessages | | Textual description for the reason of the error | Yes | #### PaymentCredentialOnePreferredOnAD-5 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | modifiedOn | undefined (date-time) | Date of the last update of the payment credential | No | #### Bank-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BIC | | Bank account Business Identifier Code (BIC) Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> BICFI | No | | type | | In this case, value must be: `BANK`
*Example:* `"BANK"` | Yes | | address | { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: } | | Yes | | bankCode | | Bank account bank code Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification
*Example:* `"173"` | No | | bankName | | Bank name of the payment credential ISO20022 element name: Creditor Agent -> Financial Institution -> Name
*Example:* `"Bank A"` | Yes | | branchCode | | Bank account branch code Conditional for select markets. ISO20022 field name: Creditor Agent Branch Identification
*Example:* `"123456"` | No | | accountName | | Bank account name, i.e., account holder name as recorded on the bank account. 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, the alias record for customer John Smith should be created or modified by the Issuer with first and last name fields as 'John S.' ISO20022 element name: Creditor Account -> Name
*Example:* `"Alex Miller"` | Yes | | accountType |
**Available values:** "CHECKING", "SAVING" | Bank account type ISO20022 element name: Creditor Account -> Type
*Enum:* `"CHECKING"`, `"SAVING"` | No | | countryCode | undefined (We recommend to use the Alpha-3) | Bank account country code.

Format: 3-character ISO-3166 (Alpha-3) country code ISO20022 element name: Creditor Agent -> Financial Institution -> Country
*Example:* `"USA"` | Yes | | bankCodeType |
**Available values:** "ABA", "SORT_CODE", "DEFAULT" | Bank account bank code type Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification -> Clearing System Identification
*Enum:* `"ABA"`, `"SORT_CODE"`, `"DEFAULT"` | No | | currencyCode | | Bank account currency code Format: 3-character ISO-4217 (Alpha-3) currency code ISO20022 element name: Creditor Account -> Currency
*Example:* `"USD"` | Yes | | accountNumber | | Bank account number ISO20022 element name: Creditor Account Number
*Example:* `"4111111145551140"` | Yes | | accountNumberType |
**Available values:** "IBAN", "DEFAULT", "TOKEN", "CCI" | Bank account number type. Valid values: 'IBAN', 'DEFAULT', 'TOKEN' and 'CCI'. If the IBAN format is not supported in a country, use DEFAULT.
*Enum:* `"IBAN"`, `"DEFAULT"`, `"TOKEN"`, `"CCI"`
*Example:* `"DEFAULT"` | Yes | #### PaymentCredentialOnePreferredOnAD-4 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | modifiedOn | undefined (date-time) | Date of the last update of the payment credential | No | #### PaymentCredentialOnePreferredOnAD-3 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | modifiedOn | undefined (date-time) | Date of the last update of the payment credential | No | #### BatchId-1 Schema This is the UUID generated by Alias Directory which identifies the Batch process | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BatchId-1 | | This is the UUID generated by Alias Directory which identifies the Batch process | | **Example** 
e336c8c8-2945-4be3-af3e-951ec2d01219
#### Error400PcStatusResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | | Description of the error reason | Yes | #### Card Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | string | In this case, value must be: `CARD`
*Example:* `"CARD"` | No | | cardType | string | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Platinum.
*Example:* `"Visa Platinum"` | No | | issuerName | string | Name of the issuer of the card
*Example:* `"Bank A"` | No | | nameOnCard | string | 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"` | No | | currencyCode | string | 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"` | No | | accountNumber | string | Primary account number of the card
*Example:* `"4111111145551142"` | Yes | | billingAddress | { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string } | | Yes | | expirationDate | string (YYYY-MM) | Expiration date for the card. This is required for certain markets.
*Example:* `"2026-01"` | No | | lastFourDigits | string | Last four digits of the PAN of the card
*Example:* `"1142"` | No | | accountNumberType | string,
**Available values:** "NIUBIZ", "TOKEN", "PAN" | Card account number type. Valid values: 'NIUBIZ', 'PAN' and 'TOKEN'. When the field is not included, the default value is 'PAN'
*Enum:* `"NIUBIZ"`, `"TOKEN"`, `"PAN"`
*Example:* `"TOKEN"` | No | #### PaymentCredentialsList Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialsList | [ { **"type"**: string, **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string }, **"expirationDate"**: string (YYYY-MM), **"lastFourDigits"**: string, **"accountNumberType"**: string,
**Available values:** "NIUBIZ", "TOKEN", "PAN" } & { **"type"**: string,
**Available values:** "BANK", "CARD", **"externalId"**: string, **"preferredFor"**: [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } & { **"status"**: string,
**Available values:** "ACTIVE", "BLOCKED", "DISABLED", "EXPIRED", **"createdOn"**: dateTime, **"lastUpdatedOn"**: dateTime } or { **"BIC"**: string, **"type"**: string, **"address"**: { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", **"countryCode"**: string (We recommend to use the Alpha-3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", "TOKEN" } & { **"type"**: string,
**Available values:** "BANK", "CARD", **"externalId"**: string, **"preferredFor"**: [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } & { **"status"**: string,
**Available values:** "ACTIVE", "BLOCKED", "DISABLED", "EXPIRED", **"createdOn"**: dateTime, **"lastUpdatedOn"**: dateTime } ] | | | #### Error400GetPcResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | | Description of the error reason | Yes | #### PaymentCredentialAuditTrail Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | status | string,
**Available values:** "ACTIVE", "BLOCKED", "DISABLED", "EXPIRED" | Payment Credential status. DELETED payment credentials won't be returned.
*Enum:* `"ACTIVE"`, `"BLOCKED"`, `"DISABLED"`, `"EXPIRED"`
*Example:* `"ACTIVE"` | No | | createdOn | dateTime | Date when it was initially created
*Example:* `"2021-06-21T13:00:00.645Z"` | No | | lastUpdatedOn | dateTime | 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"` | No | #### Card-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be: `CARD`
*Example:* `"CARD"` | Yes | | cardType | | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Platinum.
*Example:* `"Visa Platinum"` | No | | issuerName | | Name of the issuer of the card
*Example:* `"Bank A"` | No | | nameOnCard | | 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"` | No | | currencyCode | | 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"` | No | | accountNumber | | Primary account number of the card
*Example:* `"4111111145551142"` | Yes | | billingAddress | { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: } | | Yes | | expirationDate | undefined (YYYY-MM) | Expiration date for the card. This is required for certain markets.
*Example:* `"2026-01"` | No | | lastFourDigits | | Last four digits of the PAN of the card
*Example:* `"1142"` | No | | accountNumberType |
**Available values:** "NIUBIZ", "TOKEN", "PAN" | Card account number type. Valid values: 'NIUBIZ', 'PAN' and 'TOKEN'. When the field is not included, the default value is 'PAN'
*Enum:* `"NIUBIZ"`, `"TOKEN"`, `"PAN"`
*Example:* `"TOKEN"` | No | #### Error400IdResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### FiltersInquiry Schema List of the filter to apply in the request | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | FiltersInquiry | | List of the filter to apply in the request | | #### CardAliasResponseResolve Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be: `CARD`
*Example:* `"CARD"` | Yes | | cardType | | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Platinum.
*Example:* `"Visa Platinum"` | No | | issuerName | | Name of the issuer of the card
*Example:* `"Bank A"` | No | | nameOnCard | | Name that appears on the Card
*Example:* `"John Doe"` | No | | preferredFor | | 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. | No | | accountNumber | | Primary account number of the card
*Example:* `"4111111145551142"` | Yes | | billingAddress | { **"city"**: , **"state"**: , **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: } | | No | | expirationDate | | Expiration date for the card. This is required when it is expected that Visa tokenizes the credential.
*Example:* `"2022-01"` | No | | lastFourDigits | | Last four digits of the PAN of the card
*Example:* `"1142"` | No | | accountNumberType |
**Available values:** "NIUBIZ", "TOKEN", "PAN" | Card account number type. Valid values: 'NIUBIZ', 'PAN' and 'TOKEN'. When the field is not included, the default value is 'PAN'
*Enum:* `"NIUBIZ"`, `"TOKEN"`, `"PAN"`
*Example:* `"TOKEN"` | Yes | #### Error422ResolveResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error.
*Example:* `"DCC-30003"` | Yes | | errorMessages | | Description of the error reason | Yes | #### AlphaCountryCode-1 Schema this field contains ISO3166 country code (Alpha-3). | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AlphaCountryCode-1 | undefined (We recommend to use the Alpha-3) | this field contains ISO3166 country code (Alpha-3). | | **Example** 
USA
#### Id Schema UUID to uniquely identify an object. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | Id | string | UUID to uniquely identify an object. | | **Example** 
d1162433-d7f9-443a-9a91-0aaa1eb29a7c
#### PaymentCredentialExternalId-1 Schema 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. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialExternalId-1 | | 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
#### Error404ReportFileResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error.
*Example:* `"RES-30007"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### AccountName Schema When present, this field contains recipient’s account name at the bank. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AccountName | string | When present, this field contains recipient’s account name at the bank. | | **Example** 
John Doe
#### CreateAliasMetadataRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliases | | List of aliases metadata to create. | No | #### AliasInquiryRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliases | [ string ] | Array of Aliases e.g., phone numbers, email addresses or payname. | Yes | | filters | [ { **"field"**: string,
**Available values:** "DIRECTORY_NAME", "EXCLUDED_DIRECTORY_NAME", "ENTITY_ID", **"value"**: [ string ] } ] | List of the filter to apply in the request | No | | userDetails | { **"userName"**: string } | | No | | transactionDetails | { **"currencyCode"**: string } | | No | #### AliasMetadataResponseList-1 Schema Alias create response | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliases | | | No | #### AliasConfirmBasicResponseAD Schema Confirm response from a Remote Directory. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | profile | { **"lastName"**: , **"firstName"**: , **"middleName"**: , **"contactInfo"**: , **"lastNameLocal"**: , **"firstNameLocal"**: , **"middleNameLocal"**: } | Profile details for the customer that owns the Alias. | Yes | | aliasType | | The type of Alias resolved.
*Example:* `"PHONE"` | No | | aliasValue | | The value of the Alias resolved.
*Example:* `"1231231234"` | No | | paymentCredentials | | List of payment credentials linked to an Alias | Yes | #### AliasResolveRequest-1 Schema Alias information to resolve and return payment credentials | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | filters | | List of the filter to apply in the request | No | | aliasType |
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME", "NATIVE_ALIAS", "NATIONAL_ID" | The type of Alias provided in aliasValue. ISO20022 element name: Proxy -> Type
*Enum:* `"PHONE"`, `"EMAIL"`, `"DIRECTORY_ALIASID"`, `"PAYNAME"`, `"NATIVE_ALIAS"`, `"NATIONAL_ID"`
*Example:* `"PHONE"` | Yes | | aliasValue | | The value of the Alias, e.g., phone number, email address or payname. ISO20022 element name: Proxy -> Identification **Phone Number** If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Please note that in the E.164 format, the "+" sign is not included. Below are some examples of phone numbers with different country codes:
Country Country Code Examples
United States 1 1650xxxxxxx
Ukraine 380 38067xxxxxxx
Belarus 375 37529xxxxxxx
Kazakhstan 7 7701xxxxxxx
United Kingdom 44 4478xxxxxxxx
Singapore 65 659xxxxxxx
Hong Kong 852 8529xxxxxxx
Kenya 254 254701xxxxxx
**Payname** Format: “+personalidentifier.domain” **Prefix:** ‘+’ character. Uniquely identifies Visa+ from other existing social media or payment identifiers. Consumers of Visa+ APIs must send all paynames with the ‘+’ sign as the first position of the field. If sent to Visa without a ‘+’ in the first position, the payname is rejected **Personal Identifier:** Can be defined by the Consumer or suggested by the Payname Requestor. Can contain numbers, letters, hyphen (-), underscore (_), and special accented characters as outlined in technical notes. Visa will ensure the uniqueness of each Visa+ payname within the domain. **Delimiter:** '.' character. Seperates the personal identifier from the domain. **Domain:** Payname Requestor selects the domain during the enrollment process. Clients may own more than one domain. The domain is limited to letters and numbers; special characters are not permitted. The domain is considered to be the last segment after the final period. Example: +demouser.domain, +test.customdomain **If payname is used for alias please refer to the "How to section" within product documentation for more details.**
*Example:* `"1231231234"` | Yes | | userDetails | { **"userName"**: } | | No | | transactionDetails | { **"currencyCode"**: } | | No | #### AliasInquirySummary-1 Schema Summary of found Aliases | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliasesFound | undefined (int32) | Number of aliases found | Yes | | aliasesTotal | undefined (int32) | Number of aliases in request | Yes | | aliasesNotFound | undefined (int32) | Number of aliases not found | Yes | | aliasesRepeated | undefined (int32) | Number of aliases repeated | Yes | #### GenerateReportFiltersRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | endDate | dateTime | Date when the report period ends. Use ISO UTC format YYYY-MM-DDThh:mm:ss.000Z
*Example:* `"2021-01-01T22:52:46.000Z"` | No | | aliasType | string,
**Available values:** "PHONE", "EMAIL" | Type of Alias
*Enum:* `"PHONE"`, `"EMAIL"` | No | | startDate | dateTime | Date when the report period starts. Use ISO UTC format YYYY-MM-DDThh:mm:ss.000Z
*Example:* `"2021-01-01T22:52:46.000Z"` | No | | aliasStatuses | [ string,
**Available values:** "ACTIVE", "DISABLED", "BLOCKED", "EXPIRED", "DELETED" ] | Status of the Alias | No | | billingEventTypes | [ string ] | Defines the event types to include in the report. Possible values are: aliasInquiry, createAlias, createBatch, createPaymentCredential, createReport, deleteAlias, deletePaymentCredential, getAlias, getAliasId, getAliasOnlineReport, getBatch, getBatchKeys, getBatchResult, getByExternalId, getPaymentCredential, getPaymentCredentials, getReport, getReportFile, resolveAlias, updateAlias, updateAliasStatus, updateBankPaymentCredential. | No | #### AliasListReportResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasListReportResponse | [ { **"id"**: string, **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", "BLOCKED", "EXPIRED", "DELETED", **"aliasType"**: string,
**Available values:** "PHONE", "EMAIL", **"createdOn"**: dateTime, **"aliasValue"**: string, **"externalId"**: string, **"lastModifiedOn"**: dateTime } ] | | | #### GetAliasMetadataObjectNoPreferredFor Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliasValue | string | The value of the Alias, e.g., phone number or email address.
*Example:* `"1231231234"` | Yes | | preferredPaymentCredentials | [ [ { **"type"**: string,
**Available values:** "BANK", "CARD" } ] ] | | Yes | #### AliasInquiryRequestAD Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliases | | Array of Aliases e.g., phone numbers, email addresses or payname.
*Example:* `["123456789","visa@visa.com","+987456321"]` | Yes | | userDetails | { **"userName"**: } | Provides information about the end user who is requesting an Alias Resolution. This is used for risk and fraud prevention purposes. | No | | initiatingPartyId | | The identifier of the party initiating the Alias inquiry.
*Example:* `"2d94b7fd-ff00-4985-9058-1d9bd7b69cf4"` | Yes | | transactionDetails | { **"currencyCode"**: } | Additional transaction information which is used in the Alias Inquiry request. For example, clients may request for a particular currency type in the Alias resolution result. | No | #### Error400IdResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | | Description of the error reason | Yes | #### GetAliasMetadataObjectNoPreferredFor-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliasValue | | The value of the Alias, e.g., phone number or email address.
*Example:* `"1231231234"` | Yes | | preferredPaymentCredentials | | | Yes | #### CardGetPcDetails-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, the value must be `CARD`
*Example:* `"CARD"` | No | #### PaymentCredentialOnePreferredOnAD-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | modifiedOn | undefined (date-time) | Date of the last update of the payment credential | No | #### PaymentCredentialOnePreferredOnAD-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | modifiedOn | undefined (date-time) | Date of the last update of the payment credential | No | #### Error500Response Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error. Fixed 500 in this case
*Example:* `"500"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### GetBatchResultResponse Schema Response for getBatchResult operation. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | data | string | Content of result file. Base64 encoded. The binary file is compressed with Zstd.
*Example:* `"ZXhhbXBsZQ=="` | Yes | #### PaymentCredentialId-1 Schema This is an UUID generated by Alias Directory which identifies the payment credential | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialId-1 | | This is an UUID generated by Alias Directory which identifies the payment credential | | **Example** 
a44c9553-e687-4f3c-b7e7-a4245d9f238e
#### AliasType Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasType | string,
**Available values:** "PHONE", "EMAIL" | | | #### CreateAliasRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliasType | string,
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME" | The type of Alias provided in aliasValue
*Enum:* `"PHONE"`, `"EMAIL"`, `"DIRECTORY_ALIASID"`, `"PAYNAME"`
*Example:* `"PHONE"` | Yes | | aliasValue | string | The value of the Alias, e.g., phone number, email address or payname. **Phone Number** If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Please note that in the E.164 format, the "+" sign is not included. Below are some examples of phone numbers with different country codes:
Country Country Code Examples
United States 1 1650xxxxxxx
Ukraine 380 38067xxxxxxx
Belarus 375 37529xxxxxxx
Kazakhstan 7 7701xxxxxxx
United Kingdom 44 4478xxxxxxxx
Singapore 65 659xxxxxxx
Hong Kong 852 8529xxxxxxx
Kenya 254 254701xxxxxx
**Payname** Format: “+personalidentifier.domain” **Prefix:** ‘+’ character. Uniquely identifies Visa+ from other existing social media or payment identifiers. Consumers of Visa+ APIs must send all paynames with the ‘+’ sign as the first position of the field. If sent to Visa without a ‘+’ in the first position, the payname is rejected **Personal Identifier:** Can be defined by the Consumer or suggested by the Payname Requestor. Can contain numbers, letters, hyphen (-), underscore (_), and special accented characters as outlined in technical notes. Visa will ensure the uniqueness of each Visa+ payname within the domain. **Delimiter:** '.' character. Seperates the personal identifier from the domain. **Domain:** Payname Requestor selects the domain during the enrollment process. Clients may own more than one domain. The domain is limited to letters and numbers; special characters are not permitted. The domain is considered to be the last segment after the final period. Example: +demouser.domain, +testUser.customdomain **If payname is used for alias please refer to the "How to section" within product documentation for more details.**
*Example:* `"1231231234"` | Yes | | externalId | string | externalId is a client-provided identifier for the Alias. If clients already use an identifier for the Alias in their internal systems, they can re-use the same value here and manage the Alias with this identifier.
*Example:* `"21267931-7975-4b61-be7a-86915883b2b4"` | No | | paymentCredentials | [ { **"type"**: string,
**Available values:** "BANK", "CARD", **"externalId"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } & { **"type"**: string, **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string }, **"expirationDate"**: string (YYYY-MM) } or { **"type"**: string,
**Available values:** "BANK", "CARD", **"externalId"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } & { **"BIC"**: string, **"type"**: string, **"address"**: { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", **"countryCode"**: string (We recommend to use the Alpha-3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", "TOKEN" } ] | List of payment credentials to be linked to the Alias. Multiple payment credential types can be added with a Create Alias call. However, only one of each payment credential type can be added with a Create Alias call. For example, a Create Alias call can include a card and bank account. However, it cannot include two bank accounts. A second bank account can be linked to the same Alias using the Create Payment Credential API. | Yes | #### PaymentCredentialOnePreferredOn Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | modifiedOn | dateTime | Date of the last update | No | #### AliasConfirmRequest Schema Alias information to confirm the identity of the Alias owner | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | filters | | List of the filter to apply in the request | No | | aliasType |
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME", "NATIVE_ALIAS", "NATIONAL_ID" | The type of Alias provided in aliasValue. ISO20022 element name: Proxy -> Type
*Enum:* `"PHONE"`, `"EMAIL"`, `"DIRECTORY_ALIASID"`, `"PAYNAME"`, `"NATIVE_ALIAS"`, `"NATIONAL_ID"`
*Example:* `"PHONE"` | Yes | | aliasValue | | The value of the Alias, e.g., phone number, email address or payname. ISO20022 element name: Proxy -> Identification **Phone Number** If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Please note that in the E.164 format, the "+" sign is not included. Below are some examples of phone numbers with different country codes:
Country Country Code Examples
United States 1 1650xxxxxxx
Ukraine 380 38067xxxxxxx
Belarus 375 37529xxxxxxx
Kazakhstan 7 7701xxxxxxx
United Kingdom 44 4478xxxxxxxx
Singapore 65 659xxxxxxx
Hong Kong 852 8529xxxxxxx
Kenya 254 254701xxxxxx
**Payname** Format: “+personalidentifier.domain” **Prefix:** ‘+’ character. Uniquely identifies Visa+ from other existing social media or payment identifiers. Consumers of Visa+ APIs must send all paynames with the ‘+’ sign as the first position of the field. If sent to Visa without a ‘+’ in the first position, the payname is rejected **Personal Identifier:** Can be defined by the Consumer or suggested by the Payname Requestor. Can contain numbers, letters, hyphen (-), underscore (_), and special accented characters as outlined in technical notes. Visa will ensure the uniqueness of each Visa+ payname within the domain. **Delimiter:** '.' character. Seperates the personal identifier from the domain. **Domain:** Payname Requestor selects the domain during the enrollment process. Clients may own more than one domain. The domain is limited to letters and numbers; special characters are not permitted. The domain is considered to be the last segment after the final period. Example: +demouser.domain, +test.customdomain **If payname is used for alias please refer to the "How to section" within product documentation for more details.**
*Example:* `"1231231234"` | Yes | | userDetails | { **"userName"**: } | | No | | transactionDetails | { **"currencyCode"**: , **"contactNumberLast4"**: } | | No | #### AliasMetadataRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | action |
**Available values:** "ADD", "DELETE" | Mode of Action. ADD creates a new Alias metadata record. If the same Alias value is used, all information will be updated using the latest Create call. For example, the preferredFor can be removed for an existing Alias metadata record by not specifying a preferredFor in a ADD call. DELETE - Deletes an existing Alias metadata record.
*Enum:* `"ADD"`, `"DELETE"`
*Example:* `"ADD"` | Yes | | aliasType |
**Available values:** "PHONE", "EMAIL" | The type of Alias in aliasValue
*Enum:* `"PHONE"`, `"EMAIL"`
*Example:* `"PHONE"` | Yes | | aliasValue | | The value of the Alias.
*Example:* `"19002387857"` | Yes | | preferredPaymentCredentials | | List of payment credentials to be linked to the Alias. | Yes | #### Error422UpdateStatusResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error.
*Example:* `"LDS-30013"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### AddressAD Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | | City ISO20022 element name: Creditor -> Postal Address -> Town Name
*Example:* `"San Francisco"` | No | | state | | State (ISO 3166-2)
*Example:* `"CA"` | No | | country | undefined (We recommend to use the Alpha-3) | Country code using 3-character ISO 3166 (Alpha 3) format ISO20022 element name: Creditor -> Postal Address -> Country
*Example:* `"USA"` | Yes | | postalCode | | Postal code number of the addresses. ISO20022 element name: Creditor -> Postal Address -> Postal Code
*Example:* `"94105"` | No | | streetName | | Street name
*Example:* `"Street Name"` | No | | addressLine1 | | The first address line for the given record. ISO20022 element name: Creditor -> Postal Address -> Address Line
*Example:* `"1000 Market Street"` | No | | addressLine2 | | The second address line for the given record. ISO20022 element name: Creditor -> Postal Address -> Address Line
*Example:* `"Suite 101"` | No | | buildingNumber | | Building number ISO20022 element name: Creditor -> Postal Address -> Building Number
*Example:* `"56"` | No | | minorSubdivisionCode | | Minor Subdivision Code ISO20022 element name: Creditor -> Postal Address -> Country Sub Division
*Example:* `"CA"` | No | #### Error404ReportResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error.
*Example:* `"RES-30004"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### PaymentCredentialItemRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialItemRequest | { **"type"**: string,
**Available values:** "BANK", "CARD", **"externalId"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } & { **"type"**: string, **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string }, **"expirationDate"**: string (YYYY-MM) } or { **"type"**: string,
**Available values:** "BANK", "CARD", **"externalId"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } & { **"BIC"**: string, **"type"**: string, **"address"**: { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", **"countryCode"**: string (We recommend to use the Alpha-3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", "TOKEN" } | | | #### CardAliasResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | CardAliasResponse-1 | { **"type"**: , **"cardType"**: , **"issuerName"**: , **"nameOnCard"**: , **"currencyCode"**: , **"accountNumber"**: , **"billingAddress"**: { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: }, **"expirationDate"**: undefined (YYYY-MM), **"lastFourDigits"**: , **"accountNumberType"**:
**Available values:** "NIUBIZ", "TOKEN", "PAN" } & { **"modifiedOn"**: undefined (date-time) } & { **"preferredFor"**: } | | | #### Error400GetPcsResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | | Description of the error reason | Yes | #### PaymentCredentialOnePreferredOn-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | modifiedOn | undefined (date-time) | Date of the last update | No | #### PaymentCredentialPreferredForWithDateList Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | preferredFor | [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] | 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. | No | #### CardDetailsRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, the value must be `CARD`
*Example:* `"CARD"` | No | #### CardConfirm Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | string | In this case, value must be: `CARD`
*Example:* `"CARD"` | No | | issuerName | string | Name of the issuer of the card
*Example:* `"Bank A"` | No | #### AccountNumber-1 Schema When present, this field contains recipient’s account number at the bank. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AccountNumber-1 | | When present, this field contains recipient’s account number at the bank. | | **Example** 
3012345678901432
#### Error404IdResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error.
*Example:* `"LDS-30010"` | Yes | | errorMessages | | Description of the error reason | Yes | #### AssociatedId-1 Schema This is an UUID associated to external id | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AssociatedId-1 | | This is an UUID associated to external id | | **Example** 
a44c9553-e687-4f3c-b7e7-a4245d9f238e
#### AliasStatuses Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasStatuses | string,
**Available values:** "ACTIVE", "DISABLED", "BLOCKED", "EXPIRED", "DELETED" | | | #### BankUpdate Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BIC | string | Bank account Business Identifier Code (BIC) Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> BICFI | No | | type | string | In this case, value must be: `BANK`
*Example:* `"BANK"` | No | | address | { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string } | | Yes | | bankCode | string | Bank account bank code Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification
*Example:* `"173"` | No | | bankName | string | Bank name of the payment credential ISO20022 element name: Creditor Agent -> Financial Institution -> Name
*Example:* `"Bank A"` | Yes | | branchCode | string | Bank account branch code Conditional for select markets. ISO20022 field name: Creditor Agent Branch Identification
*Example:* `"123456"` | No | | accountName | string | Bank account name, i.e., account holder name as recorded on the bank account. 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, the alias record for customer John Smith should be created or modified by the Issuer with first and last name fields as 'John S.' ISO20022 element name: Creditor Account -> Name
*Example:* `"Alex Miller"` | Yes | | accountType | string,
**Available values:** "CHECKING", "SAVING" | Bank account type ISO20022 element name: Creditor Account -> Type
*Enum:* `"CHECKING"`, `"SAVING"` | No | | countryCode | string (We recommend to use the Alpha-3) | Bank account country code.

Format: 3-character ISO-3166 (Alpha-3) country code ISO20022 element name: Creditor Agent -> Financial Institution -> Country
*Example:* `"USA"` | Yes | | bankCodeType | string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT" | Bank account bank code type Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification -> Clearing System Identification
*Enum:* `"ABA"`, `"SORT_CODE"`, `"DEFAULT"` | No | | currencyCode | string | Bank account currency code Format: 3-character ISO-4217 (Alpha-3) currency code ISO20022 element name: Creditor Account -> Currency
*Example:* `"USD"` | Yes | #### CardGetResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | id | | This is an UUID generated by Alias Directory which identifies the payment credential
*Example:* `"a44c9553-e687-4f3c-b7e7-a4245d9f238e"` | No | | accountNumberType |
**Available values:** "NIUBIZ", "PAN", "TOKEN" | Card account number type. Valid values: 'NIUBIZ', 'PAN' and 'TOKEN'.
*Enum:* `"NIUBIZ"`, `"PAN"`, `"TOKEN"`
*Example:* `"TOKEN"` | No | #### BankAliasResponseResolve-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BIC | | Bank account Business Identifier Code (BIC) Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> BICFI
*Example:* `"12345678"` | No | | type | | In this case, value must be: `BANK`
*Example:* `"BANK"` | Yes | | address | { **"city"**: , **"state"**: , **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: } | | No | | bankCode | | Bank account bank code Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification
*Example:* `"173"` | No | | bankName | | Bank name of the payment credential ISO20022 element name: Creditor Agent -> Financial Institution -> Name
*Example:* `"Bank of America"` | Yes | | branchCode | | Bank account branch code Conditional for select markets. ISO20022 field name: Creditor Agent Branch Identification
*Example:* `"123456"` | No | | accountName | | Bank account name, i.e., accountholder name as recorded on the bank account ISO20022 element name: Creditor Account -> Name
*Example:* `"WALLETX"` | Yes | | accountType |
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN" | Bank account type ISO20022 element name: Creditor Account -> Type
*Enum:* `"CHECKING"`, `"SAVING"`, `"MAESTRA"`, `"VISTA"`, `"LOAN"` | No | | countryCode | | Bank account country code. Format: 3-character ISO-3166 (Alpha-3) country code ISO20022 element name: Creditor Agent -> Financial Institution -> Country
*Example:* `"USA"` | Yes | | bankCodeType |
**Available values:** "ABA", "SORT_CODE", "DEFAULT" | Bank account bank code type Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification -> Clearing System Identification
*Enum:* `"ABA"`, `"SORT_CODE"`, `"DEFAULT"` | No | | currencyCode | | Bank account currency code Format: 3-character ISO-4217 (Alpha-3) currency code ISO20022 element name: Creditor Account -> Currency
*Example:* `"USD"` | Yes | | preferredFor | | 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. | No | | accountNumber | | Bank account number ISO20022 element name: Creditor Account Number
*Example:* `"4111111145551140"` | Yes | | accountNumberType |
**Available values:** "IBAN", "DEFAULT" | Bank account number type. Valid values: "IBAN" and "DEFAULT". If the IBAN format is not supported in a country, use DEFAULT.
*Enum:* `"IBAN"`, `"DEFAULT"`
*Example:* `"DEFAULT"` | Yes | #### BankAliasResponseResolve-4 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BIC | | Bank account Business Identifier Code (BIC) Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> BICFI
*Example:* `"12345678"` | No | | type | | In this case, value must be: `BANK`
*Example:* `"BANK"` | Yes | | address | { **"city"**: , **"state"**: , **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: } | | No | | bankCode | | Bank account bank code Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification
*Example:* `"173"` | No | | bankName | | Bank name of the payment credential ISO20022 element name: Creditor Agent -> Financial Institution -> Name
*Example:* `"Bank of America"` | Yes | | branchCode | | Bank account branch code Conditional for select markets. ISO20022 field name: Creditor Agent Branch Identification
*Example:* `"123456"` | No | | accountName | | Bank account name, i.e., accountholder name as recorded on the bank account ISO20022 element name: Creditor Account -> Name
*Example:* `"WALLETX"` | Yes | | accountType |
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN" | Bank account type ISO20022 element name: Creditor Account -> Type
*Enum:* `"CHECKING"`, `"SAVING"`, `"MAESTRA"`, `"VISTA"`, `"LOAN"` | No | | countryCode | | Bank account country code. Format: 3-character ISO-3166 (Alpha-3) country code ISO20022 element name: Creditor Agent -> Financial Institution -> Country
*Example:* `"USA"` | Yes | | bankCodeType |
**Available values:** "ABA", "SORT_CODE", "DEFAULT" | Bank account bank code type Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification -> Clearing System Identification
*Enum:* `"ABA"`, `"SORT_CODE"`, `"DEFAULT"` | No | | currencyCode | | Bank account currency code Format: 3-character ISO-4217 (Alpha-3) currency code ISO20022 element name: Creditor Account -> Currency
*Example:* `"USD"` | Yes | | preferredFor | | 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. | No | | accountNumber | | Bank account number ISO20022 element name: Creditor Account Number
*Example:* `"4111111145551140"` | Yes | | accountNumberType |
**Available values:** "IBAN", "DEFAULT" | Bank account number type. Valid values: "IBAN" and "DEFAULT". If the IBAN format is not supported in a country, use DEFAULT.
*Enum:* `"IBAN"`, `"DEFAULT"`
*Example:* `"DEFAULT"` | Yes | #### PaymentCredentialPreferredForWithDateList-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | preferredFor | | 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. | No | #### BankAliasResponseResolve-5 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BIC | | Bank account Business Identifier Code (BIC) Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> BICFI
*Example:* `"12345678"` | No | | type | | In this case, value must be: `BANK`
*Example:* `"BANK"` | Yes | | address | { **"city"**: , **"state"**: , **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: } | | No | | bankCode | | Bank account bank code Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification
*Example:* `"173"` | No | | bankName | | Bank name of the payment credential ISO20022 element name: Creditor Agent -> Financial Institution -> Name
*Example:* `"Bank of America"` | Yes | | branchCode | | Bank account branch code Conditional for select markets. ISO20022 field name: Creditor Agent Branch Identification
*Example:* `"123456"` | No | | accountName | | Bank account name, i.e., accountholder name as recorded on the bank account ISO20022 element name: Creditor Account -> Name
*Example:* `"WALLETX"` | Yes | | accountType |
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN" | Bank account type ISO20022 element name: Creditor Account -> Type
*Enum:* `"CHECKING"`, `"SAVING"`, `"MAESTRA"`, `"VISTA"`, `"LOAN"` | No | | countryCode | | Bank account country code. Format: 3-character ISO-3166 (Alpha-3) country code ISO20022 element name: Creditor Agent -> Financial Institution -> Country
*Example:* `"USA"` | Yes | | bankCodeType |
**Available values:** "ABA", "SORT_CODE", "DEFAULT" | Bank account bank code type Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification -> Clearing System Identification
*Enum:* `"ABA"`, `"SORT_CODE"`, `"DEFAULT"` | No | | currencyCode | | Bank account currency code Format: 3-character ISO-4217 (Alpha-3) currency code ISO20022 element name: Creditor Account -> Currency
*Example:* `"USD"` | Yes | | preferredFor | | 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. | No | | accountNumber | | Bank account number ISO20022 element name: Creditor Account Number
*Example:* `"4111111145551140"` | Yes | | accountNumberType |
**Available values:** "IBAN", "DEFAULT" | Bank account number type. Valid values: "IBAN" and "DEFAULT". If the IBAN format is not supported in a country, use DEFAULT.
*Enum:* `"IBAN"`, `"DEFAULT"`
*Example:* `"DEFAULT"` | Yes | #### PaymentCredentialModifiedOn-1 Schema Date of the last update of the payment credential, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialModifiedOn-1 | undefined (date-time) | Date of the last update of the payment credential, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z | | **Example** 
2021-01-01T22:52:46.000Z
#### BankAliasResponseResolve-2 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BIC | | Bank account Business Identifier Code (BIC) Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> BICFI
*Example:* `"12345678"` | No | | type | | In this case, value must be: `BANK`
*Example:* `"BANK"` | Yes | | address | { **"city"**: , **"state"**: , **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: } | | No | | bankCode | | Bank account bank code Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification
*Example:* `"173"` | No | | bankName | | Bank name of the payment credential ISO20022 element name: Creditor Agent -> Financial Institution -> Name
*Example:* `"Bank of America"` | Yes | | branchCode | | Bank account branch code Conditional for select markets. ISO20022 field name: Creditor Agent Branch Identification
*Example:* `"123456"` | No | | accountName | | Bank account name, i.e., accountholder name as recorded on the bank account ISO20022 element name: Creditor Account -> Name
*Example:* `"WALLETX"` | Yes | | accountType |
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN" | Bank account type ISO20022 element name: Creditor Account -> Type
*Enum:* `"CHECKING"`, `"SAVING"`, `"MAESTRA"`, `"VISTA"`, `"LOAN"` | No | | countryCode | | Bank account country code. Format: 3-character ISO-3166 (Alpha-3) country code ISO20022 element name: Creditor Agent -> Financial Institution -> Country
*Example:* `"USA"` | Yes | | bankCodeType |
**Available values:** "ABA", "SORT_CODE", "DEFAULT" | Bank account bank code type Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification -> Clearing System Identification
*Enum:* `"ABA"`, `"SORT_CODE"`, `"DEFAULT"` | No | | currencyCode | | Bank account currency code Format: 3-character ISO-4217 (Alpha-3) currency code ISO20022 element name: Creditor Account -> Currency
*Example:* `"USD"` | Yes | | preferredFor | | 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. | No | | accountNumber | | Bank account number ISO20022 element name: Creditor Account Number
*Example:* `"4111111145551140"` | Yes | | accountNumberType |
**Available values:** "IBAN", "DEFAULT" | Bank account number type. Valid values: "IBAN" and "DEFAULT". If the IBAN format is not supported in a country, use DEFAULT.
*Enum:* `"IBAN"`, `"DEFAULT"`
*Example:* `"DEFAULT"` | Yes | #### BankAliasResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BankAliasResponse | { **"BIC"**: string, **"type"**: string, **"address"**: { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", **"countryCode"**: string (We recommend to use the Alpha-3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", "TOKEN" } & { **"modifiedOn"**: dateTime } & { **"preferredFor"**: [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } | | | #### BankAliasResponseResolve-3 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BIC | | Bank account Business Identifier Code (BIC) Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> BICFI
*Example:* `"12345678"` | No | | type | | In this case, value must be: `BANK`
*Example:* `"BANK"` | Yes | | address | { **"city"**: , **"state"**: , **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: } | | No | | bankCode | | Bank account bank code Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification
*Example:* `"173"` | No | | bankName | | Bank name of the payment credential ISO20022 element name: Creditor Agent -> Financial Institution -> Name
*Example:* `"Bank of America"` | Yes | | branchCode | | Bank account branch code Conditional for select markets. ISO20022 field name: Creditor Agent Branch Identification
*Example:* `"123456"` | No | | accountName | | Bank account name, i.e., accountholder name as recorded on the bank account ISO20022 element name: Creditor Account -> Name
*Example:* `"WALLETX"` | Yes | | accountType |
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN" | Bank account type ISO20022 element name: Creditor Account -> Type
*Enum:* `"CHECKING"`, `"SAVING"`, `"MAESTRA"`, `"VISTA"`, `"LOAN"` | No | | countryCode | | Bank account country code. Format: 3-character ISO-3166 (Alpha-3) country code ISO20022 element name: Creditor Agent -> Financial Institution -> Country
*Example:* `"USA"` | Yes | | bankCodeType |
**Available values:** "ABA", "SORT_CODE", "DEFAULT" | Bank account bank code type Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification -> Clearing System Identification
*Enum:* `"ABA"`, `"SORT_CODE"`, `"DEFAULT"` | No | | currencyCode | | Bank account currency code Format: 3-character ISO-4217 (Alpha-3) currency code ISO20022 element name: Creditor Account -> Currency
*Example:* `"USD"` | Yes | | preferredFor | | 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. | No | | accountNumber | | Bank account number ISO20022 element name: Creditor Account Number
*Example:* `"4111111145551140"` | Yes | | accountNumberType |
**Available values:** "IBAN", "DEFAULT" | Bank account number type. Valid values: "IBAN" and "DEFAULT". If the IBAN format is not supported in a country, use DEFAULT.
*Enum:* `"IBAN"`, `"DEFAULT"`
*Example:* `"DEFAULT"` | Yes | #### CreateAliasRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliasType |
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME" | The type of Alias provided in aliasValue
*Enum:* `"PHONE"`, `"EMAIL"`, `"DIRECTORY_ALIASID"`, `"PAYNAME"`
*Example:* `"PHONE"` | Yes | | aliasValue | | The value of the Alias, e.g., phone number, email address or payname. **Phone Number** If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Please note that in the E.164 format, the "+" sign is not included. Below are some examples of phone numbers with different country codes:
Country Country Code Examples
United States 1 1650xxxxxxx
Ukraine 380 38067xxxxxxx
Belarus 375 37529xxxxxxx
Kazakhstan 7 7701xxxxxxx
United Kingdom 44 4478xxxxxxxx
Singapore 65 659xxxxxxx
Hong Kong 852 8529xxxxxxx
Kenya 254 254701xxxxxx
**Payname** Format: “+personalidentifier.domain” **Prefix:** ‘+’ character. Uniquely identifies Visa+ from other existing social media or payment identifiers. Consumers of Visa+ APIs must send all paynames with the ‘+’ sign as the first position of the field. If sent to Visa without a ‘+’ in the first position, the payname is rejected **Personal Identifier:** Can be defined by the Consumer or suggested by the Payname Requestor. Can contain numbers, letters, hyphen (-), underscore (_), and special accented characters as outlined in technical notes. Visa will ensure the uniqueness of each Visa+ payname within the domain. **Delimiter:** '.' character. Seperates the personal identifier from the domain. **Domain:** Payname Requestor selects the domain during the enrollment process. Clients may own more than one domain. The domain is limited to letters and numbers; special characters are not permitted. The domain is considered to be the last segment after the final period. Example: +demouser.domain, +testUser.customdomain **If payname is used for alias please refer to the "How to section" within product documentation for more details.**
*Example:* `"1231231234"` | Yes | | externalId | | externalId is a client-provided identifier for the Alias. If clients already use an identifier for the Alias in their internal systems, they can re-use the same value here and manage the Alias with this identifier.
*Example:* `"21267931-7975-4b61-be7a-86915883b2b4"` | No | | paymentCredentials | | List of payment credentials to be linked to the Alias. Multiple payment credential types can be added with a Create Alias call. However, only one of each payment credential type can be added with a Create Alias call. For example, a Create Alias call can include a card and bank account. However, it cannot include two bank accounts. A second bank account can be linked to the same Alias using the Create Payment Credential API. | Yes | #### GetAliasMetadataObjectPreferredFor-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliasValue | | The value of the Alias, e.g., phone number or email address.
*Example:* `"19002387857"` | Yes | | preferredPaymentCredentials | | | Yes | #### AliasMetadataListRequest Schema List of aliases metadata to create. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasMetadataListRequest | [ { **"action"**: string,
**Available values:** "ADD", "DELETE", **"aliasType"**: string,
**Available values:** "PHONE", "EMAIL", **"aliasValue"**: string, **"preferredPaymentCredentials"**: [ { **"type"**: string,
**Available values:** "BANK", "CARD", **"preferredFor"**: [ { **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } ] } ] | List of aliases metadata to create. | | #### CreateAliasMetadataRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliases | [ { **"action"**: string,
**Available values:** "ADD", "DELETE", **"aliasType"**: string,
**Available values:** "PHONE", "EMAIL", **"aliasValue"**: string, **"preferredPaymentCredentials"**: [ { **"type"**: string,
**Available values:** "BANK", "CARD", **"preferredFor"**: [ { **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } ] } ] | List of aliases metadata to create. | No | #### PreferredPaymentCredentialsNoPreferredForResponse Schema Array of Card or BankAccount | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PreferredPaymentCredentialsNoPreferredForResponse | [ { **"type"**: string,
**Available values:** "BANK", "CARD" } ] | Array of Card or BankAccount | | #### GetReportResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | id | string | reportId from the Get Report request
*Example:* `"a77ef5c5-c972-467b-9a11-ac550183b495"` | No | | format | string,
**Available values:** "JSON" | The report file format
*Enum:* `"JSON"`
*Example:* `"JSON"` | No | | status | string,
**Available values:** "CREATED", "IN_PROGRESS", "COMPLETED" | Report status
*Enum:* `"CREATED"`, `"IN_PROGRESS"`, `"COMPLETED"`
*Example:* `"COMPLETED"` | No | | fileIds | [ string ] | List of file IDs. Some reports may have multiple files due to the size of the report. | No | | reportType | string,
**Available values:** "PLATFORM_REQUESTS", "DIRECTORY_STATUS", "PAYMENT_CREDENTIAL_DETAILS" | The report type
*Enum:* `"PLATFORM_REQUESTS"`, `"DIRECTORY_STATUS"`, `"PAYMENT_CREDENTIAL_DETAILS"`
*Example:* `"PLATFORM_REQUESTS"` | No | | creationDateTime | dateTime | Report creation timestamp. ISO UTC format YYYY-MM-DDThh:mm:ss.000Z
*Example:* `"2021-01-01T22:52:46.000Z"` | No | | dataClassification | string | The data classification of the report
*Example:* `"VERY_IMPORTANT"` | No | | expirationDateTime | dateTime | The report will not be available for download after this date. ISO UTC format YYYY-MM-DDThh:mm:ss.000Z
*Example:* `"2021-01-01T22:52:46.000Z"` | No | #### Error404AdditionalAliasResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error.
*Example:* `"LDS-30017"` | Yes | | errorMessages | | Description of the error reason | Yes | #### Filters Schema List of the filter to apply in the request | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | Filters | [ { **"field"**: string,
**Available values:** "DIRECTORY_NAME", "EXCLUDED_DIRECTORY_NAME", "ENTITY_ID", **"value"**: [ string ] } ] | List of the filter to apply in the request | | #### UserDetails Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | userName | string | An identifier that represents the end user who is requesting the information. This field must not contain any PII information.
*Example:* `"username1234"` | Yes | #### Error422PcStatusResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error. Fixed 422 in this case
*Example:* `"422"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### GetFileResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | GetFileResponse | [ { **"programId"**: string, **"statusCode"**: integer, **"operationType"**: string, **"operationsCount"**: integer, **"originatorActorId"**: string } ] | | | #### BankAccountDetails Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be `BANK` | No | #### BankGetResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | id | string | This is an UUID generated by Alias Directory which identifies the payment credential
*Example:* `"a44c9553-e687-4f3c-b7e7-a4245d9f238e"` | No | | type | | In this case, the value must be `BANK`
*Example:* `"BANK"` | No | #### CardDetailsRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, the value must be `CARD`
*Example:* `"CARD"` | No | #### CardRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | string | In this case, value must be: `CARD`
*Example:* `"CARD"` | No | | cardType | string | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Platinum.
*Example:* `"Visa Platinum"` | Yes | | issuerName | string | Name of the issuer of the card
*Example:* `"Bank A"` | Yes | | nameOnCard | string | 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"` | Yes | | currencyCode | string | 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"` | No | | accountNumber | string | Primary account number of the card
*Example:* `"4111111145551142"` | Yes | | billingAddress | { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string } | | Yes | | expirationDate | string (YYYY-MM) | Expiration date for the card. This is required for certain markets.
*Example:* `"2030-01"` | Yes | #### Error422CreateAliasResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error.
*Example:* `"LDS-30000"` | Yes | | errorMessages | | Description of the error reason | Yes | #### UpdateCard-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be: `CARD`
*Example:* `"CARD"` | No | | cardType | | Card type description. Reference to Field 62.23—Product ID of available card products. e.g. Visa Platinum.
*Example:* `"Visa Platinum"` | No | | issuerName | | Name of the issuer of the card
*Example:* `"Bank A"` | No | | nameOnCard | | 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"` | Yes | | currencyCode | | 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"` | No | | billingAddress | { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: } | | Yes | | expirationDate | undefined (YYYY-MM) | Expiration date for the card. This is required for certain markets.
*Example:* `"2022-12"` | Yes | #### Error422CardAlreadyExists Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error.
*Example:* `"CVC-30010"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### ErrorResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 404 in this case
*Example:* `"404"` | Yes | | errorMessages | | Description of the error reason | Yes | #### AdditionalInfo Schema Additional information returned in the confirm response. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | validationResult | { **"status"**:
**Available values:** "MATCH", "NO_MATCH", "NOT_PROVIDED" } | Validation result for identity verification. | No | #### BankAccountDetailsUpdate-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be `BANK` | No | #### Error400Response-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | | Description of the error reason | Yes | #### BankAccountDetailsUpdate Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be `BANK` | No | #### TransactionDetailsConfirm Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | currencyCode | | ISO 4217 currency code. Allows a client to specify the currency of the payment credential returned in the Alias Confirm response. ISO20022 element name: Creditor Account - > Currency
*Example:* `"USD"` | No | | contactNumberLast4 | | Last 4 digits of the contact number, used for identity verification in confirm flow.
*Example:* `"1234"` | No | #### BaseAliasRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | profile | { **"lastName"**: , **"firstName"**: , **"middleName"**: , **"contactInfo"**: , **"dateOfBirth"**: , **"lastNameLocal"**: , **"preferredName"**: , **"firstNameLocal"**: , **"middleNameLocal"**: } | Profile details for the customer that owns the Alias. | Yes | | identification | { **"type"**: , **"value"**: , **"verificationDetails"**: { **"authDateTime"**: undefined (date-time), **"verifiedEmail"**: , **"verifiedPhone"**: , **"creationDateTime"**: undefined (date-time), **"authMethodReference"**: } } | Form of identification. This object is optional and only used for specific use cases. | No | #### CardConfirm-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be: `CARD`
*Example:* `"CARD"` | Yes | | issuerName | | Name of the issuer of the card
*Example:* `"Bank A"` | No | | modifiedOn | undefined (date-time) | Date and time when the payment credential was last modified | No | | nameOnCard | | Name that appears on the Card
*Example:* `"Alex Miller"` | No | | currencyCode | | ISO 4217 currency code (Alpha-3)
*Example:* `"USD"` | No | | preferredFor | | | No | | billingAddress | { **"country"**: } | | Yes | | accountNumberType |
**Available values:** "NIUBIZ", "TOKEN", "PAN" | Card account number type
*Enum:* `"NIUBIZ"`, `"TOKEN"`, `"PAN"` | Yes | #### PreferredTypeRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type |
**Available values:** "RECEIVE", "SEND", "PAY" | 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.
*Enum:* `"RECEIVE"`, `"SEND"`, `"PAY"`
*Example:* `"RECEIVE"` | Yes | #### UpdateAliasStatusRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | status | string,
**Available values:** "ACTIVE", "DISABLED" | Set the new status for the Alias.
*Enum:* `"ACTIVE"`, `"DISABLED"` | No | #### CardUpdateDetails Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, the value must be `CARD`
*Example:* `"CARD"` | No | #### Error400PcResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | | Description of the error reason | Yes | #### Error404PcResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error.
*Example:* `"LDS-30011"` | Yes | | errorMessages | | Description of the error reason | Yes | #### AliasResolveRequest Schema Alias information to resolve and return payment credentials | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | filters | [ { **"field"**: string,
**Available values:** "DIRECTORY_NAME", "EXCLUDED_DIRECTORY_NAME", "ENTITY_ID", **"value"**: [ string ] } ] | List of the filter to apply in the request | No | | aliasType | string,
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME" | The type of Alias provided in aliasValue. ISO20022 element name: Proxy -> Type
*Enum:* `"PHONE"`, `"EMAIL"`, `"DIRECTORY_ALIASID"`, `"PAYNAME"`
*Example:* `"PHONE"` | Yes | | aliasValue | string | The value of the Alias, e.g., phone number, email address or payname. ISO20022 element name: Proxy -> Identification **Phone Number** If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Please note that in the E.164 format, the "+" sign is not included. Below are some examples of phone numbers with different country codes:
Country Country Code Examples
United States 1 1650xxxxxxx
Ukraine 380 38067xxxxxxx
Belarus 375 37529xxxxxxx
Kazakhstan 7 7701xxxxxxx
United Kingdom 44 4478xxxxxxxx
Singapore 65 659xxxxxxx
Hong Kong 852 8529xxxxxxx
Kenya 254 254701xxxxxx
**Payname** Format: “+personalidentifier.domain” **Prefix:** ‘+’ character. Uniquely identifies Visa+ from other existing social media or payment identifiers. Consumers of Visa+ APIs must send all paynames with the ‘+’ sign as the first position of the field. If sent to Visa without a ‘+’ in the first position, the payname is rejected **Personal Identifier:** Can be defined by the Consumer or suggested by the Payname Requestor. Can contain numbers, letters, hyphen (-), underscore (_), and special accented characters as outlined in technical notes. Visa will ensure the uniqueness of each Visa+ payname within the domain. **Delimiter:** '.' character. Seperates the personal identifier from the domain. **Domain:** Payname Requestor selects the domain during the enrollment process. Clients may own more than one domain. The domain is limited to letters and numbers; special characters are not permitted. The domain is considered to be the last segment after the final period. Example: +demouser.domain, +test.customdomain **If payname is used for alias please refer to the "How to section" within product documentation for more details.**
*Example:* `"1231231234"` | Yes | | userDetails | { **"userName"**: string } | | No | | transactionDetails | { **"currencyCode"**: string } | | No | #### AliasInquiryEntityItemAD Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | id | | Id of the entity used to identify the entity
*Example:* `"entity1"` | Yes | | preferredFor | | 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. | No | #### AliasType-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasType-1 |
**Available values:** "PHONE", "EMAIL" | | | #### PaymentCredentialCreateUpdateResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | id | string | | Yes | | type | string,
**Available values:** "BANK", "CARD" | Payment credential type
*Enum:* `"BANK"`, `"CARD"`
*Example:* `"CARD"` | Yes | | externalId | string | 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"` | No | #### AliasResolveRequestAD Schema Alias information to resolve and return payment credentials | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | filters | | List of the filter to apply in the request | No | | aliasType |
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME", "NATIVE_ALIAS", "NATIONAL_ID" | The type of Alias provided in aliasValue. ISO20022 element name: Proxy -> Type
*Enum:* `"PHONE"`, `"EMAIL"`, `"DIRECTORY_ALIASID"`, `"PAYNAME"`, `"NATIVE_ALIAS"`, `"NATIONAL_ID"`
*Example:* `"PHONE"` | Yes | | aliasValue | | The value of the Alias, e.g., phone number, email address or payname. ISO20022 element name: Proxy -> Identification
*Example:* `"1231231234"` | Yes | | userDetails | { **"userName"**: } | Provides information about the end user who is requesting an Alias Resolution. This is used for risk and fraud prevention purposes. | No | | initiatingPartyId | | The identifier of the party initiating the Alias resolution.
*Example:* `"2d94b7fd-ff00-4985-9058-1d9bd7b69cf4"` | Yes | | transactionDetails | { **"currencyCode"**: } | Additional transaction information which is used in the Alias Resolution request. For example, clients may request for a particular currency type in the Alias resolution result. | No | #### AliasMetadataResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasMetadataResponse-1 | | | | #### GetPlatformRequestResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | programId | | The Program Id
*Example:* `"baf85624-3cf6-4c52-b91f-b8f3493e7330"` | No | | statusCode | undefined (int32) | The response status
*Example:* `200` | No | | operationType | | The operation type
*Example:* `"resolveAlias"` | No | | operationsCount | undefined (int32) | The operations count
*Example:* `18` | No | | originatorActorId | | The Originator Actor Id
*Example:* `"012af73f-44d8-4c9c-bbee-628b07faae1c"` | No | #### AliasConfirmBasicResponseAD-1 Schema Confirm response from a Remote Directory. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | profile | { **"lastName"**: , **"firstName"**: , **"middleName"**: , **"contactInfo"**: , **"lastNameLocal"**: , **"firstNameLocal"**: , **"middleNameLocal"**: } | Profile details for the customer that owns the Alias. | Yes | | aliasType | | The type of Alias resolved.
*Example:* `"PHONE"` | No | | aliasValue | | The value of the Alias resolved.
*Example:* `"1231231234"` | No | | paymentCredentials | | List of payment credentials linked to an Alias | Yes | #### GetByExternalIdRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type |
**Available values:** "ALIAS", "PAYMENT_CREDENTIAL" | The entity type associated to the external Id
*Enum:* `"ALIAS"`, `"PAYMENT_CREDENTIAL"` | Yes | | externalId | | External Id (maintained by client) associated to the entity `type` | Yes | #### AliasConfirmRequest-3 Schema Alias information to confirm the identity of the Alias owner | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | filters | | List of the filter to apply in the request | No | | aliasType |
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME", "NATIVE_ALIAS", "NATIONAL_ID" | The type of Alias provided in aliasValue. ISO20022 element name: Proxy -> Type
*Enum:* `"PHONE"`, `"EMAIL"`, `"DIRECTORY_ALIASID"`, `"PAYNAME"`, `"NATIVE_ALIAS"`, `"NATIONAL_ID"`
*Example:* `"PHONE"` | Yes | | aliasValue | | The value of the Alias, e.g., phone number, email address or payname. ISO20022 element name: Proxy -> Identification **Phone Number** If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Please note that in the E.164 format, the "+" sign is not included. Below are some examples of phone numbers with different country codes:
Country Country Code Examples
United States 1 1650xxxxxxx
Ukraine 380 38067xxxxxxx
Belarus 375 37529xxxxxxx
Kazakhstan 7 7701xxxxxxx
United Kingdom 44 4478xxxxxxxx
Singapore 65 659xxxxxxx
Hong Kong 852 8529xxxxxxx
Kenya 254 254701xxxxxx
**Payname** Format: “+personalidentifier.domain” **Prefix:** ‘+’ character. Uniquely identifies Visa+ from other existing social media or payment identifiers. Consumers of Visa+ APIs must send all paynames with the ‘+’ sign as the first position of the field. If sent to Visa without a ‘+’ in the first position, the payname is rejected **Personal Identifier:** Can be defined by the Consumer or suggested by the Payname Requestor. Can contain numbers, letters, hyphen (-), underscore (_), and special accented characters as outlined in technical notes. Visa will ensure the uniqueness of each Visa+ payname within the domain. **Delimiter:** '.' character. Seperates the personal identifier from the domain. **Domain:** Payname Requestor selects the domain during the enrollment process. Clients may own more than one domain. The domain is limited to letters and numbers; special characters are not permitted. The domain is considered to be the last segment after the final period. Example: +demouser.domain, +test.customdomain **If payname is used for alias please refer to the "How to section" within product documentation for more details.**
*Example:* `"1231231234"` | Yes | | userDetails | { **"userName"**: } | | No | | transactionDetails | { **"currencyCode"**: , **"contactNumberLast4"**: } | | No | #### AliasConfirmRequest-2 Schema Alias information to confirm the identity of the Alias owner | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | filters | | List of the filter to apply in the request | No | | aliasType |
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME", "NATIVE_ALIAS", "NATIONAL_ID" | The type of Alias provided in aliasValue. ISO20022 element name: Proxy -> Type
*Enum:* `"PHONE"`, `"EMAIL"`, `"DIRECTORY_ALIASID"`, `"PAYNAME"`, `"NATIVE_ALIAS"`, `"NATIONAL_ID"`
*Example:* `"PHONE"` | Yes | | aliasValue | | The value of the Alias, e.g., phone number, email address or payname. ISO20022 element name: Proxy -> Identification **Phone Number** If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Please note that in the E.164 format, the "+" sign is not included. Below are some examples of phone numbers with different country codes:
Country Country Code Examples
United States 1 1650xxxxxxx
Ukraine 380 38067xxxxxxx
Belarus 375 37529xxxxxxx
Kazakhstan 7 7701xxxxxxx
United Kingdom 44 4478xxxxxxxx
Singapore 65 659xxxxxxx
Hong Kong 852 8529xxxxxxx
Kenya 254 254701xxxxxx
**Payname** Format: “+personalidentifier.domain” **Prefix:** ‘+’ character. Uniquely identifies Visa+ from other existing social media or payment identifiers. Consumers of Visa+ APIs must send all paynames with the ‘+’ sign as the first position of the field. If sent to Visa without a ‘+’ in the first position, the payname is rejected **Personal Identifier:** Can be defined by the Consumer or suggested by the Payname Requestor. Can contain numbers, letters, hyphen (-), underscore (_), and special accented characters as outlined in technical notes. Visa will ensure the uniqueness of each Visa+ payname within the domain. **Delimiter:** '.' character. Seperates the personal identifier from the domain. **Domain:** Payname Requestor selects the domain during the enrollment process. Clients may own more than one domain. The domain is limited to letters and numbers; special characters are not permitted. The domain is considered to be the last segment after the final period. Example: +demouser.domain, +test.customdomain **If payname is used for alias please refer to the "How to section" within product documentation for more details.**
*Example:* `"1231231234"` | Yes | | userDetails | { **"userName"**: } | | No | | transactionDetails | { **"currencyCode"**: , **"contactNumberLast4"**: } | | No | #### AliasConfirmRequest-5 Schema Alias information to confirm the identity of the Alias owner | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | filters | | List of the filter to apply in the request | No | | aliasType |
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME", "NATIVE_ALIAS", "NATIONAL_ID" | The type of Alias provided in aliasValue. ISO20022 element name: Proxy -> Type
*Enum:* `"PHONE"`, `"EMAIL"`, `"DIRECTORY_ALIASID"`, `"PAYNAME"`, `"NATIVE_ALIAS"`, `"NATIONAL_ID"`
*Example:* `"PHONE"` | Yes | | aliasValue | | The value of the Alias, e.g., phone number, email address or payname. ISO20022 element name: Proxy -> Identification **Phone Number** If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Please note that in the E.164 format, the "+" sign is not included. Below are some examples of phone numbers with different country codes:
Country Country Code Examples
United States 1 1650xxxxxxx
Ukraine 380 38067xxxxxxx
Belarus 375 37529xxxxxxx
Kazakhstan 7 7701xxxxxxx
United Kingdom 44 4478xxxxxxxx
Singapore 65 659xxxxxxx
Hong Kong 852 8529xxxxxxx
Kenya 254 254701xxxxxx
**Payname** Format: “+personalidentifier.domain” **Prefix:** ‘+’ character. Uniquely identifies Visa+ from other existing social media or payment identifiers. Consumers of Visa+ APIs must send all paynames with the ‘+’ sign as the first position of the field. If sent to Visa without a ‘+’ in the first position, the payname is rejected **Personal Identifier:** Can be defined by the Consumer or suggested by the Payname Requestor. Can contain numbers, letters, hyphen (-), underscore (_), and special accented characters as outlined in technical notes. Visa will ensure the uniqueness of each Visa+ payname within the domain. **Delimiter:** '.' character. Seperates the personal identifier from the domain. **Domain:** Payname Requestor selects the domain during the enrollment process. Clients may own more than one domain. The domain is limited to letters and numbers; special characters are not permitted. The domain is considered to be the last segment after the final period. Example: +demouser.domain, +test.customdomain **If payname is used for alias please refer to the "How to section" within product documentation for more details.**
*Example:* `"1231231234"` | Yes | | userDetails | { **"userName"**: } | | No | | transactionDetails | { **"currencyCode"**: , **"contactNumberLast4"**: } | | No | #### BankGetPcAccountDetails-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be `BANK` | No | #### AliasConfirmRequest-4 Schema Alias information to confirm the identity of the Alias owner | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | filters | | List of the filter to apply in the request | No | | aliasType |
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME", "NATIVE_ALIAS", "NATIONAL_ID" | The type of Alias provided in aliasValue. ISO20022 element name: Proxy -> Type
*Enum:* `"PHONE"`, `"EMAIL"`, `"DIRECTORY_ALIASID"`, `"PAYNAME"`, `"NATIVE_ALIAS"`, `"NATIONAL_ID"`
*Example:* `"PHONE"` | Yes | | aliasValue | | The value of the Alias, e.g., phone number, email address or payname. ISO20022 element name: Proxy -> Identification **Phone Number** If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Please note that in the E.164 format, the "+" sign is not included. Below are some examples of phone numbers with different country codes:
Country Country Code Examples
United States 1 1650xxxxxxx
Ukraine 380 38067xxxxxxx
Belarus 375 37529xxxxxxx
Kazakhstan 7 7701xxxxxxx
United Kingdom 44 4478xxxxxxxx
Singapore 65 659xxxxxxx
Hong Kong 852 8529xxxxxxx
Kenya 254 254701xxxxxx
**Payname** Format: “+personalidentifier.domain” **Prefix:** ‘+’ character. Uniquely identifies Visa+ from other existing social media or payment identifiers. Consumers of Visa+ APIs must send all paynames with the ‘+’ sign as the first position of the field. If sent to Visa without a ‘+’ in the first position, the payname is rejected **Personal Identifier:** Can be defined by the Consumer or suggested by the Payname Requestor. Can contain numbers, letters, hyphen (-), underscore (_), and special accented characters as outlined in technical notes. Visa will ensure the uniqueness of each Visa+ payname within the domain. **Delimiter:** '.' character. Seperates the personal identifier from the domain. **Domain:** Payname Requestor selects the domain during the enrollment process. Clients may own more than one domain. The domain is limited to letters and numbers; special characters are not permitted. The domain is considered to be the last segment after the final period. Example: +demouser.domain, +test.customdomain **If payname is used for alias please refer to the "How to section" within product documentation for more details.**
*Example:* `"1231231234"` | Yes | | userDetails | { **"userName"**: } | | No | | transactionDetails | { **"currencyCode"**: , **"contactNumberLast4"**: } | | No | #### PaymentCredentialCommon-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type |
**Available values:** "BANK", "CARD" | Payment credential type
*Enum:* `"BANK"`, `"CARD"`
*Example:* `"CARD"` | Yes | | externalId | | 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"` | No | | preferredFor | | 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. | No | #### AliasConfirmBasicResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | profile | { **"lastName"**: string, **"firstName"**: string, **"middleName"**: string, **"lastNameLocal"**: string, **"firstNameLocal"**: string, **"middleNameLocal"**: string } | Profile details for the customer that owns the Alias. | No | | directoryName | string | Name of the external directory where was found the payment
*Example:* `"DIRECTORY_A"` | No | | paymentCredentials | [ { **"type"**: string, **"issuerName"**: string } or { **"type"**: string, **"bankName"**: string } ] | List of payment credentials linked to an Alias | No | #### AliasInquiryEntityItem Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | id | string | Id of the entity used to identify the entity
*Example:* `"entity1"` | No | | preferredFor | [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] | Preferred for information for each entity | No | #### AliasConfirmRequest-1 Schema Alias information to confirm the identity of the Alias owner | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | filters | | List of the filter to apply in the request | No | | aliasType |
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME", "NATIVE_ALIAS", "NATIONAL_ID" | The type of Alias provided in aliasValue. ISO20022 element name: Proxy -> Type
*Enum:* `"PHONE"`, `"EMAIL"`, `"DIRECTORY_ALIASID"`, `"PAYNAME"`, `"NATIVE_ALIAS"`, `"NATIONAL_ID"`
*Example:* `"PHONE"` | Yes | | aliasValue | | The value of the Alias, e.g., phone number, email address or payname. ISO20022 element name: Proxy -> Identification **Phone Number** If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Please note that in the E.164 format, the "+" sign is not included. Below are some examples of phone numbers with different country codes:
Country Country Code Examples
United States 1 1650xxxxxxx
Ukraine 380 38067xxxxxxx
Belarus 375 37529xxxxxxx
Kazakhstan 7 7701xxxxxxx
United Kingdom 44 4478xxxxxxxx
Singapore 65 659xxxxxxx
Hong Kong 852 8529xxxxxxx
Kenya 254 254701xxxxxx
**Payname** Format: “+personalidentifier.domain” **Prefix:** ‘+’ character. Uniquely identifies Visa+ from other existing social media or payment identifiers. Consumers of Visa+ APIs must send all paynames with the ‘+’ sign as the first position of the field. If sent to Visa without a ‘+’ in the first position, the payname is rejected **Personal Identifier:** Can be defined by the Consumer or suggested by the Payname Requestor. Can contain numbers, letters, hyphen (-), underscore (_), and special accented characters as outlined in technical notes. Visa will ensure the uniqueness of each Visa+ payname within the domain. **Delimiter:** '.' character. Seperates the personal identifier from the domain. **Domain:** Payname Requestor selects the domain during the enrollment process. Clients may own more than one domain. The domain is limited to letters and numbers; special characters are not permitted. The domain is considered to be the last segment after the final period. Example: +demouser.domain, +test.customdomain **If payname is used for alias please refer to the "How to section" within product documentation for more details.**
*Example:* `"1231231234"` | Yes | | userDetails | { **"userName"**: } | | No | | transactionDetails | { **"currencyCode"**: , **"contactNumberLast4"**: } | | No | #### PaymentCredentialCommonResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type |
**Available values:** "BANK", "CARD" | Payment credential type
*Enum:* `"BANK"`, `"CARD"`
*Example:* `"CARD"` | Yes | | externalId | | 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"` | No | | preferredFor | | 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. | No | #### Error422ResolveResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error.
*Example:* `"DCC-30003"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### GetAliasMetadataObjectPreferredFor Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | aliasValue | string | The value of the Alias, e.g., phone number or email address.
*Example:* `"19002387857"` | Yes | | preferredPaymentCredentials | [ [ { **"type"**: string,
**Available values:** "BANK", "CARD", **"preferredFor"**: [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } ] ] | | Yes | #### AliasId Schema The UUID generated by Alias Directory which identifies the create report request. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AliasId | string | The UUID generated by Alias Directory which identifies the create report request. | | **Example** 
e336c8c8-2945-4be3-af3e-951ec2d01219
#### AccountName-1 Schema When present, this field contains recipient’s account name at the bank. | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AccountName-1 | | When present, this field contains recipient’s account name at the bank. | | **Example** 
John Doe
#### BatchProcessRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | data | string | Encrypted data containing the requests to be executed in the batch process. Please refer to the product documentation on batch processing for more information on how to generate the encrypted data.
*Example:* `"wpoqObsnVdsomACBb2lmBxhu8vbzVzWGHE6b8O2roVPgeeY4/L0+CdDLNUQ330auPASv38e+8g9M1OkPleF8iTBuEd4UNxMvSMyoRIw5ni9bAN4hG/Xp21FMU+6gB1MUi5guayYpxeVoEW6Zm1IdHBF7NHHiUHQqYvh1710o5/SgQIqF41+lH1Kc/zNGoPiCc23KrmiXHcXVbCemISxKOAYatAn/tz4c1ma9HgE/UuG0+mciRU7eCd3GRJIzCOZR7oimGyfI8oZTq6bjJvEqXv4MUkVc4PbvqpY762+E625gpT5xi768BqwtPMO6eJ/oRNQaS7nkeZzykypN+DxUw1sZ+sn3cYMmPO8ma8L0mPLPp/PWuFY0EP5ef6hHpCcIyVfbaQQJfqHxrPyzpGiOam9vjiT4zNPQAnT80LqWnwK572zp8TXvEDMvBT0tSLjq6XVeZ/mH2f6Yas6x/73zU44ZayMkSytdS/aQnh3OnhDzdczNCyiZ95gobuEui2o1M6/O4mtQWVprxlhcM2QqxSVxqdqIRnnRztCm5ffy6pASNAwanuOJQXzedUdUPVqRN6zwqjibnfnmDrMR4C03R725Pz0xPQexc04Tyepb5gWkDc3jhU7w+ErYBN7NbMFrwrvwVWGC/uOOWwg/qOUu0Qf5iUYza0tSaTHj4e4m4h2FngPV5gKGF9vfiGwz26VvlHsCbPDWsIp5wnh3UgbpCoAOjrUYe7rslFVGLDBa6gLqOCOrquK9EXthonYBsywL63WjdM6kw1QaAJ2478Ic+SGJTQmztccN08irCIVQ02c0vcBQCjlbYoQTXB948PxKP6fxBW5O5GzUrtOemGTMWhQ/V8dOUDNJlo4KdKaQMsoMxgGb6Kk/WAbhtIkXOdDOTgwTZ7mVyoDH6tysTKGNu4uJPOJZd26u2rSXC+umcIwV528qO+Vu1QyF3Aklx+l4rIPOaOzcX35nHEBDO2Eznzn94MMVIW6JinCSt5wbRK9To5wGSFbJ3TUmbJSjbddmQPSzR06sZGX1R8kmDaLr2bGodxPL37JHrpg2uNUW5icEY0m0bKUxx9IupqbQeGJeB/rglh6+QU5nFZ8RzScLnENDxuCxM8D+IY0d8zDOGvKQUmLdgEEQhzOyNcj5lHTrNvH5VvYAtSL5xM+dj5a8v89nTIh+lhwqcKvS1YNlL3ZPcqMTXNzN3yF+XdkSsczzG2y08xXQYV6x89o84Lu5GUlTJUtH1CGuNzR6LGaztqCdMEfyuMdA2raSW3zr01bPFu+zJEtPD2fC1G3R6N3vzXUXBYYghyp7RLDQEaMT6Smv5Lg6CIYw3oLeylKbw9wS6SrEwBas3X8MDHP6KpUKeEe2ihDiyVImeashk9CpO9qQC/lRt5zQg+tkLtLyycBvDU6D59AC8Q/3Xe06EJ/55byERDfzp0gu74SXabiPJeje7z4CHjAy2pL3m8MXFGymZ7ipPAMIjv9ClW2mCzgTqo/eT9b2dcSu1fIKcCH+DjYgmb7UeyY7XK5fqYOxF5cr2UrCTm4zE+ycUVlAZN1C5oDbXJShB9GYl4OkTdrb9P2kIJz3434kbkKjNtFoquv1b5z5EPWWY+H4TkyBd5bg7WBOcjJJ0sUQg53X/Tua4wOcNT+20YhiWR/Wx1dfrA1jDcxLcXgzk0Bo5aWPUU4RzptRIahFZd8b+ZbEknrFlpY1XHRdhD6vXBibDTHNy3lRwFgXF5Tet1RozW8cj0grfLP1+l6x/NhJ/mijjtOgs0pX1YIwuicPPYRjzqssXawqCghjH8G5+ZwTn4MybYtY9BAgnDYaP5Sz9b1N8cnvlqnfulKUqgDfLEkpQCg1qlXLjZnauZ5sRaNlyfoMPB76z5wSUlpvTVVm+2+xI7E8iYSKxTIpSzzoHoaLbI8BnK4GoRzp28j3ol2eXO60EhwuxDHR4i3frTs4/jFUaoRQiDu2KLm9wvsL4+TFlC+mmRyre0H+fpXQfJQ5EKexWWe8Ier+2x0ZyPioULCMxbbvWv96BX+yWrAWhaI6RXWi1tcWtkdoKkeHTyT34yVEYyWWp51/NZM+WTi8pU5NW2BNa6VBEdM8X2XM75ShlNwcNY6TjxzmebfQLp+Z9IA9sOXQyJme1iJ0cbGvhg9d7vnAfXH+wBJWyFgi2sDgrK2VnExEE07ZqBsWMBf75TESnbBnSSh+X0R0VxXHy2PBT9678eoo3MPBLOjOEIJCd0K/nrG753bqo7h3by/fW4/lB2wsfFEsB4i7UCTRzAA64pBmkGM0K8+QIH6osd5qnbO9P+yOOoNkvrqwy6aL21RWNFX0W87+GzDpWEYSPJ0wpP9qfGmfKRuPc0J3GgDDIr1URNn3UgTZSqUJCmIPpyI0Kojc8lRUO8kfyJ42tioYh+WM5BDprltnHRPyNTq7uTwZAHFdY0CVHymlVPe5yB14Gz+8qFRbAtzXkC5wwXK8S0KU4Espp8b3rC+Uy2DeZeIFBBtDJOHH3JNavZBdKafv/TvfBSyfbLb8Uvus8ypgJaQp5lJTwukJJjiTVry8DDu6kxZUfXs9uUhbMwenhjgpWKHBSgeXlGJW7Ms2hkGiuNZlVf34qYvjUdNfxsS6zQrvP+tuk5l9duYqLUgYXBSau+EA6kAiSSwFucns2BhOMEJxCBDGRf0AyYriOKS5OzIgi0lH2SmxqDErMJs5+0/lhxNs6hZU0/mfa40co51AV1Jt/lK/k6uexRALqf9rOQ3wO/oni0u7NehnsHxXi7YJyei/8njF8UAxQ0DSWl2eimMk1H+Zodp33JzGVvedqzcabVtUQaOpt9DoCGjXJ7Ny8a9SIbGnVzRQYY4EGlgJXXr4fJ+jwDKx71Sg1RcMWoDxuyJCkc1YhCb/O7JNISrBV4WX0ilpNSDRUgRUzbF5VpB9v2pPWMWTO9ETyTE65fe3L36fYjF92qf6fphmqpUY35FwlOT9/S31pb4NsYbxcLPIUqgZZcQR/ArQAWxIVfQbl+ZurZ565Ojy7YnoFsL3eakLtJDIGKY8HqAvLPkEeJBl25IPjgtu3trJPKbVX3ZjMvWMezVoZA272jz5NElMAHgvOOlMDALgMGXgQWFf3WezXklJLaq5nD7lAte7NQzfjOKbaDBLXrgNnZ+PxQJWLnLKY0y8G8k482YadksJxXBuYpd/MpFN34f/lTl8na6TzsnaiBkYr2kr8tt5C2rfWOBiPOV2CQJNtcXRY8c0Il54hAk7LIWJGTvpFZdkZBg9GqBy2G1yerJnvhI2zlj6pPZh4BdY/dpxbA85WC5BdnyLRrsdXj0TXrYGuDWkDJbBwWcqTUjwuo82mHMECi5XckuVXP3SXQsDjRuFYeIqhmKtSh/yLj4wWBKtvNP/TC6iOlVZWC6meUIyti99DP2svO6xKH6p2Ek543YiC0u4HoV4VMe3dVj+l0xuLq3yOdP+kHYATSeERLWq1Ph0DfYL/3I5Gxo6b4KkkRAXTyhvARoM/eSladJQ9mUjgyAYM12gQsZZmmWUa9u0PCYtm/Dzz0H8Xne4OfUU82QLLv0PMWrdfGSSfyvWBR9/kBPdwkU/GpAATxcGmzz8uO5p93edRZXyn9Qo68cYQm+QQb4opanfmlhV27EKW3XXXt8OyGQk4p2n+6+SJ2UGWIJ2WwlMjyCVu7CDDtSkN160rGF+BMquxlqFudLRGRga4LumYJ2kuVPgU8inwvJrTKN80WY8PH8B1vtPcGSKzRmT84CsJAThalUUnnSFozXP+nWv3fnFbjBtfSAm9RjX/jg1sy/DILx7LX9bGrT9G8dYK0B4XchPy7UjbXF6qp7Bp0CZjLqbQh1DAW8numBjrrZkKJr1hNyGLACduYZktoFNefGseTj9FJErOyxxXHXSE5vovGZDToDMqrHE/8C1y60AC+CTePjcdYxQdfJADfBsqhm4oXr+z4VD39u3DJIDSaBl2KRjpWFyaHWVOaSss4jDB3lFndfa4C1Kq5KtPBgdXVTIN1tiyytigLLioJBrl8xdYdFVneeZ51lottKu2ktn0M8zaFHQW4KluziPgVMnJYmxlD9eHRASxuaXWMV+qdldk5PfZfowzcOkcIMgUFHRh5o3WOyTSb7ECSJJWS9yaPdAzHXYeTmMWMYf3USv82y0KxgaTfmLrb1zLJiawqby62zNVznJLddfU8kDoscyK0RcgtJiAXRdl84DUZnuQot9JfgmptnAqUujt6FeLhrDCYeXJ7Dx8cKBJhhmIxYR4GsTTUlcTG0HUhllcBOa2raK1fofaOZeYFaHR1PZicwjtUwwrKFyLM/MzzeHLbinRRzZlIoXFBz7949km6k/oLEz+TL/AqfyoFCIxAHTcL69uVzSSBoqpdSFKWJQw1Q3WXipEEwJyVrUGTqLKzEZHG4pVHgfIZBu5qrvaNo/RhV3cFHpnRAEozcWJ+slOzPAUJaoTJ/bNveDGlBns07kFYFqeIIG8y8IqmVlPhzVHf9JvqUVh/ItoUYxM6ehWIB8SPlVfAWQ3U7D1zIJQIawrK9QsFdMM/5Kp65BfxMEPS8KyZh6NvbBm6Bv8Kr50Sf++TjfU5DeUk3MUHYcd9CmT+GOk0hjdm154MV1mk2+VBqp4s9RVvKggD0PnBxbSq6+Nt5enlarjslprVv8PCV8UaTV0z1GBUJd6HQtR+wLEQ05xr8btAxi2s9PT5ggqfCNDEI0BitRp66be1vG/ifcudx++FYIIvhzsYtN6OhTnALpnfAN+zpWY6tAmoJtENnSb5OF8SJx3auIPJL/pxgdMke3UTWBpwFM2H0W9QDXKbdnBTEhL1fl+szA6jIv"` | Yes | | keyId | string | This identifies a specific batch operation job. Please use the “id” value retrieved from the /batchKeys endpoint.
*Example:* `"e336c8c8-2945-4be3-af3e-951ec2d01219"` | Yes | | operation | string,
**Available values:** "CREATE_ALIAS", "DELETE_ALIAS", "UPDATE_BANK_PAYMENT_CREDENTIAL" | The operation to be performed in the batch process, e.g., Create Alias. Only one operation can be used for each batch process request.
*Enum:* `"CREATE_ALIAS"`, `"DELETE_ALIAS"`, `"UPDATE_BANK_PAYMENT_CREDENTIAL"` | Yes | #### BankUpdate-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | BIC | | Bank account Business Identifier Code (BIC) Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> BICFI | No | | type | | In this case, value must be: `BANK`
*Example:* `"BANK"` | No | | address | { **"city"**: , **"state"**: undefined (We recommend to use the ISO 3166-2), **"country"**: undefined (We recommend to use the Alpha-3), **"postalCode"**: , **"streetName"**: , **"addressLine1"**: , **"addressLine2"**: , **"buildingNumber"**: , **"minorSubdivisionCode"**: } | | Yes | | bankCode | | Bank account bank code Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification
*Example:* `"173"` | No | | bankName | | Bank name of the payment credential ISO20022 element name: Creditor Agent -> Financial Institution -> Name
*Example:* `"Bank A"` | Yes | | branchCode | | Bank account branch code Conditional for select markets. ISO20022 field name: Creditor Agent Branch Identification
*Example:* `"123456"` | No | | accountName | | Bank account name, i.e., account holder name as recorded on the bank account. 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, the alias record for customer John Smith should be created or modified by the Issuer with first and last name fields as 'John S.' ISO20022 element name: Creditor Account -> Name
*Example:* `"Alex Miller"` | Yes | | accountType |
**Available values:** "CHECKING", "SAVING" | Bank account type ISO20022 element name: Creditor Account -> Type
*Enum:* `"CHECKING"`, `"SAVING"` | No | | countryCode | undefined (We recommend to use the Alpha-3) | Bank account country code.

Format: 3-character ISO-3166 (Alpha-3) country code ISO20022 element name: Creditor Agent -> Financial Institution -> Country
*Example:* `"USA"` | Yes | | bankCodeType |
**Available values:** "ABA", "SORT_CODE", "DEFAULT" | Bank account bank code type Conditional for select markets. ISO20022 element name: Creditor Agent -> Financial Institution -> Clearing System Member Identification -> Clearing System Identification
*Enum:* `"ABA"`, `"SORT_CODE"`, `"DEFAULT"` | No | | currencyCode | | Bank account currency code Format: 3-character ISO-4217 (Alpha-3) currency code ISO20022 element name: Creditor Account -> Currency
*Example:* `"USD"` | Yes | #### GenerateReportFiltersRequest-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | endDate | undefined (date-time) | Date when the report period ends. Use ISO UTC format YYYY-MM-DDThh:mm:ss.000Z
*Example:* `"2021-01-01T22:52:46.000Z"` | No | | aliasType |
**Available values:** "PHONE", "EMAIL" | Type of Alias
*Enum:* `"PHONE"`, `"EMAIL"` | No | | startDate | undefined (date-time) | Date when the report period starts. Use ISO UTC format YYYY-MM-DDThh:mm:ss.000Z
*Example:* `"2021-01-01T22:52:46.000Z"` | No | | aliasStatuses | | Status of the Alias | No | | billingEventTypes | | Defines the event types to include in the report. Possible values are: aliasInquiry, createAlias, createBatch, createPaymentCredential, createReport, deleteAlias, deletePaymentCredential, getAlias, getAliasId, getAliasOnlineReport, getBatch, getBatchKeys, getBatchResult, getByExternalId, getPaymentCredential, getPaymentCredentials, getReport, getReportFile, resolveAlias, updateAlias, updateAliasStatus, updateBankPaymentCredential. | No | #### ReportId Schema This is the UUID generated by Alias Directory which identifies the Report | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | ReportId | string | This is the UUID generated by Alias Directory which identifies the Report | | **Example** 
e336c8c8-2945-4be3-af3e-951ec2d01219
#### Error404PcResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error.
*Example:* `"LDS-30011"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### Address-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | city | | City ISO20022 element name: Creditor -> Postal Address -> Town Name
*Example:* `"San Francisco"` | No | | state | undefined (We recommend to use the ISO 3166-2) | State (ISO 3166-2)
*Example:* `"CA"` | No | | country | undefined (We recommend to use the Alpha-3) | Country code using 3-character ISO 3166 (Alpha 3) format ISO20022 element name: Creditor -> Postal Address -> Country
*Example:* `"USA"` | Yes | | postalCode | | Postal code number of the addresses ISO20022 element name: Creditor -> Postal Address -> Postal Code
*Example:* `"94105"` | No | | streetName | | Street Name
*Example:* `"12"` | No | | addressLine1 | | Address line 1 ISO20022 element name: Creditor -> Postal Address -> Address Line
*Example:* `"1000 Market Street"` | No | | addressLine2 | | Address line 2 ISO20022 element name: Creditor -> Postal Address -> Address Line
*Example:* `"Suite 101"` | No | | buildingNumber | | Building number ISO20022 element name: Creditor -> Postal Address -> Building Number
*Example:* `"56"` | No | | minorSubdivisionCode | | Minor Subdivision Code ISO20022 element name: Creditor -> Postal Address -> Country Sub Division
*Example:* `"CA"` | No | #### AlphaCurrencyCode Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AlphaCurrencyCode | string | | | **Example** 
USD
#### TransactionDetails Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | currencyCode | string | ISO 4217 currency code. Allows a client to specify the currency of the payment credential returned in the Alias Resolution response. ISO20022 element name: Creditor Account - > Currency
*Example:* `"USD"` | No | #### PaymentCredentialItemAliasResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PaymentCredentialItemAliasResponse | { **"type"**: string, **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string }, **"expirationDate"**: string (YYYY-MM), **"lastFourDigits"**: string, **"accountNumberType"**: string,
**Available values:** "NIUBIZ", "TOKEN", "PAN" } & { **"modifiedOn"**: dateTime } & { **"preferredFor"**: [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } or { **"BIC"**: string, **"type"**: string, **"address"**: { **"city"**: string, **"state"**: string (We recommend to use the ISO 3166-2), **"country"**: string (We recommend to use the Alpha-3), **"postalCode"**: string, **"streetName"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"buildingNumber"**: string, **"minorSubdivisionCode"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", **"countryCode"**: string (We recommend to use the Alpha-3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", "TOKEN" } & { **"modifiedOn"**: dateTime } & { **"preferredFor"**: [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } | | | #### PaymentCredentialOnePreferredOnAD Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | modifiedOn | undefined (date-time) | Date of the last update of the payment credential | No | #### AlphaCurrencyCode-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | AlphaCurrencyCode-1 | | | | **Example** 
USD
#### Date Schema Date ISO-8601 Format https://www.w3.org/TR/NOTE-datetime | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | Date | string | Date ISO-8601 Format https://www.w3.org/TR/NOTE-datetime | | **Example** 
1980-02-01
#### PreferredTypeResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | date | undefined (date-time) | ISO formatted Timestamp
*Example:* `"2021-01-01T22:52:46Z"` | No | | type |
**Available values:** "RECEIVE", "SEND", "PAY" | 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.
*Enum:* `"RECEIVE"`, `"SEND"`, `"PAY"`
*Example:* `"RECEIVE"` | No | #### Error400ExternalIdResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### GetReportResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | id | | reportId from the Get Report request
*Example:* `"a77ef5c5-c972-467b-9a11-ac550183b495"` | No | | format |
**Available values:** "JSON" | The report file format
*Enum:* `"JSON"`
*Example:* `"JSON"` | No | | status |
**Available values:** "CREATED", "IN_PROGRESS", "COMPLETED" | Report status
*Enum:* `"CREATED"`, `"IN_PROGRESS"`, `"COMPLETED"`
*Example:* `"COMPLETED"` | No | | fileIds | | List of file IDs. Some reports may have multiple files due to the size of the report. | No | | reportType |
**Available values:** "PLATFORM_REQUESTS", "DIRECTORY_STATUS", "PAYMENT_CREDENTIAL_DETAILS" | The report type
*Enum:* `"PLATFORM_REQUESTS"`, `"DIRECTORY_STATUS"`, `"PAYMENT_CREDENTIAL_DETAILS"`
*Example:* `"PLATFORM_REQUESTS"` | No | | creationDateTime | undefined (date-time) | Report creation timestamp. ISO UTC format YYYY-MM-DDThh:mm:ss.000Z
*Example:* `"2021-01-01T22:52:46.000Z"` | No | | dataClassification | | The data classification of the report
*Example:* `"VERY_IMPORTANT"` | No | | expirationDateTime | undefined (date-time) | The report will not be available for download after this date. ISO UTC format YYYY-MM-DDThh:mm:ss.000Z
*Example:* `"2021-01-01T22:52:46.000Z"` | No | #### CardGetPcDetails Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, the value must be `CARD`
*Example:* `"CARD"` | No | #### Error400Response Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes | #### BankConfirm-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | | In this case, value must be: `BANK`
*Example:* `"BANK"` | Yes | | address | { **"country"**: } | | Yes | | bankName | | Bank name of the payment credential ISO20022 element name: Creditor Agent -> Financial Institution -> Name
*Example:* `"Bank of America"` | Yes | | modifiedOn | undefined (date-time) | Date and time when the payment credential was last modified | No | | accountName | | Bank account name
*Example:* `"Alex Miller"` | Yes | | countryCode | | Bank account country code using 3-character ISO 3166 (Alpha 3) format
*Example:* `"USA"` | Yes | | currencyCode | | Bank account currency code using ISO 4217 (Alpha-3) format
*Example:* `"USD"` | Yes | | preferredFor | | | No | | accountNumberType |
**Available values:** "IBAN", "DEFAULT" | Bank account number type
*Enum:* `"IBAN"`, `"DEFAULT"` | Yes | #### PaymentCredentialAuditTrail-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | status |
**Available values:** "ACTIVE", "BLOCKED", "DISABLED", "EXPIRED" | Payment Credential status. DELETED payment credentials won't be returned.
*Enum:* `"ACTIVE"`, `"BLOCKED"`, `"DISABLED"`, `"EXPIRED"`
*Example:* `"ACTIVE"` | No | | createdOn | undefined (date-time) | Date when it was initially created
*Example:* `"2021-06-21T13:00:00.645Z"` | No | | lastUpdatedOn | undefined (date-time) | 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"` | No | #### BankConfirm Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | string | In this case, value must be: `BANK`
*Example:* `"BANK"` | No | | bankName | string | Bank name of the payment credential ISO20022 element name: Creditor Agent -> Financial Institution -> Name
*Example:* `"Bank of America"` | No | #### PreferredPaymentCredentialsPreferredForResponse Schema Array of Card or BankAccount | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | PreferredPaymentCredentialsPreferredForResponse | [ { **"type"**: string,
**Available values:** "BANK", "CARD", **"preferredFor"**: [ { **"date"**: dateTime, **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } ] | Array of Card or BankAccount | | #### Error400ResolveResponse-1 Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | | Code to identify the type of error. Fixed 400 in this case
*Example:* `"400"` | Yes | | errorMessages | | Description of the error reason | Yes | #### CreateAdditionalAliasRequest Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | type | string,
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME" | The type of Alias in aliasValue
*Enum:* `"PHONE"`, `"EMAIL"`, `"DIRECTORY_ALIASID"`, `"PAYNAME"`
*Example:* `"PHONE"` | Yes | | value | string | A customer unique identifier that represents him in the payment ecosystem where the user move funds. The format will change depending the type.
*Example:* `"1231231234"` | Yes | #### Error404AdditionalAliasResponse Schema | Name | Type | Description | Required | | ---- | ---- | ----------- | -------- | | errorCode | string | Code to identify the type of error.
*Example:* `"LDS-30017"` | Yes | | errorMessages | [ string ] | Description of the error reason | Yes |