# Visa ID and Credential
One API integration to manage consumer identities and payment credentials across Visa services. Issuers and their processors enroll, update, retrieve and remove consumer and credential data through a single set of endpoints, and choose which Visa products each operation applies to, including Click to Pay, Address Verification Service, Alias Directory Service and Account Name Inquiry.
## Version: 1
### Servers
| URL | Description |
| --- | ----------- |
| https://sandbox.api.visa.com | Sandbox server |
---
## Enroll Data
Enroll Data API
### [POST] /visaIdCredential/v1/enrollPaymentInstruments
**Enroll Payment Instruments**
This API enrolls a payment credential for the given consumer ID
#### Parameters
| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| eX-Correlation-Id | header | Unique ID for every API request - an optional header. Generated by the API client. Used for end-to-end tracing/debugging. | No | string | No |
#### Request Body
| Required | Schema |
| -------- | ------ |
| No | **application/json**: { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" }, **"paymentInstruments"**: [ { **"type"**: string,
**Available values:** "CARD", "NON-VISA-CARD", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601), **"isAFAuthentication"**: boolean, **"isPaymentInstrumentConsent"**: boolean } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string } ], **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } } or { **"products"**: [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string } } ], **"paymentInstruments"**: [ { **"type"**: string,
**Available values:** "CARD", "NON-VISA-CARD", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601), **"isAFAuthentication"**: boolean, **"isPaymentInstrumentConsent"**: boolean } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string } ], **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } } or { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" }, **"products"**: [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string } } ], **"paymentInstruments"**: [ { **"type"**: string,
**Available values:** "CARD", "NON-VISA-CARD", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601), **"isAFAuthentication"**: boolean, **"isPaymentInstrumentConsent"**: boolean } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string } ], **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | Accepted
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/json**: { **"requestTraceId"**: string (uuid) }
|
| 400 | When any field validation fails or when any required field is missing or when request is inconsistent with the Request definitions.
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string }
|
| 500 | Server Error
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"message"**: string }
|
### [PUT] /visaIdCredential/v1/enrollData/{externalConsumerId}
**Enroll Existing Issuer Data with Payment Instrument**
This API enrolls consumer info and one payment credential. This API can be used when adding a consumer and card that has already been enrolled in Click to Pay / SRC to another service, i.e. Alias Directory. The external ConsumerID cannot be used when the consumer has been enrolled in a product other than Click to Pay.
#### Parameters
| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| eX-Correlation-Id | header | Unique ID for every API request - an optional header. Generated by the API client. Used for end-to-end tracing/debugging. | No | string | No |
| externalConsumerId | path | Issuer of Visa provided consumer ID as uuid | Yes | string (uuid) | No |
#### Request Body
| Required | Schema |
| -------- | ------ |
| No | **application/json**: { **"products"**: [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string } } ], **"paymentInstruments"**: [ { **"type"**: string,
**Available values:** "CARD", "NON-VISA CARD", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601), **"AFAuthentication"**: boolean, **"paymentInstrumentConsent"**: boolean } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string } ], **"externalConsumerIDOwnerBID"**: string }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | Accepted
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/json**: { **"requestTraceId"**: string (uuid) }
|
| 400 | When any field validation fails or when any required field is missing or when request is inconsistent with the Request definitions.
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string }
|
| 500 | Server Error
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"message"**: string }
|
### [POST] /visaIdCredential/v1/enrollData
**Enroll Data**
This API enrolls consumer info and one payment credential
#### Parameters
| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| eX-Correlation-Id | header | Unique ID for every API request - an optional header. Generated by the API client. Used for end-to-end tracing/debugging. | No | string | No |
#### Request Body
| Required | Schema |
| -------- | ------ |
| No | **application/json**: { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" }, **"paymentInstruments"**: [ { **"type"**: string,
**Available values:** "CARD", "NON-VISA-CARD", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601), **"isAFAuthentication"**: boolean, **"isPaymentInstrumentConsent"**: boolean } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string } ], **"consumerInformation"**: { **"emails"**: [ string ], **"locale"**: string (iso-639-1), **"phones"**: [ string ], **"consent"**: { **"version"**: string, **"presenter"**: string, **"timeOfConsent"**: string }, **"fullName"**: string, **"lastName"**: string, **"firstName"**: string, **"middleName"**: string, **"countryCode"**: string (ISO 3166-1-alpha3), **"dateOfBirth"**: date, **"preferredname"**: string, **"externalConsumerID"**: string (uuid), **"nationalIdentifiers"**: [ { **"type"**: string,
**Available values:** "PASSPORT", "DRIVING_LICENSE", "NATIONAL_IDENTITY", **"value"**: string } ], **"externalConsumerIDOwnerBID"**: string } } or { **"products"**: [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string } } ], **"paymentInstruments"**: [ { **"type"**: string,
**Available values:** "CARD", "NON-VISA-CARD", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601), **"isAFAuthentication"**: boolean, **"isPaymentInstrumentConsent"**: boolean } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string } ], **"consumerInformation"**: { **"emails"**: [ string ], **"locale"**: string (iso-639-1), **"phones"**: [ string ], **"consent"**: { **"version"**: string, **"presenter"**: string, **"timeOfConsent"**: string }, **"fullName"**: string, **"lastName"**: string, **"firstName"**: string, **"middleName"**: string, **"countryCode"**: string (ISO 3166-1-alpha3), **"dateOfBirth"**: date, **"preferredname"**: string, **"externalConsumerID"**: string (uuid), **"nationalIdentifiers"**: [ { **"type"**: string,
**Available values:** "PASSPORT", "DRIVING_LICENSE", "NATIONAL_IDENTITY", **"value"**: string } ], **"externalConsumerIDOwnerBID"**: string } } or { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" }, **"products"**: [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string } } ], **"paymentInstruments"**: [ { **"type"**: string,
**Available values:** "CARD", "NON-VISA-CARD", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601), **"isAFAuthentication"**: boolean, **"isPaymentInstrumentConsent"**: boolean } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string } ], **"consumerInformation"**: { **"emails"**: [ string ], **"locale"**: string (iso-639-1), **"phones"**: [ string ], **"consent"**: { **"version"**: string, **"presenter"**: string, **"timeOfConsent"**: string }, **"fullName"**: string, **"lastName"**: string, **"firstName"**: string, **"middleName"**: string, **"countryCode"**: string (ISO 3166-1-alpha3), **"dateOfBirth"**: date, **"preferredname"**: string, **"externalConsumerID"**: string (uuid), **"nationalIdentifiers"**: [ { **"type"**: string,
**Available values:** "PASSPORT", "DRIVING_LICENSE", "NATIONAL_IDENTITY", **"value"**: string } ], **"externalConsumerIDOwnerBID"**: string } }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | Accepted
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/json**: { **"requestTraceId"**: string (uuid) }
|
| 400 | When any field validation fails or when any required field is missing or when request is inconsistent with the Request definitions.
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string }
|
| 500 | Server Error
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"message"**: string }
|
### [PUT] /visaIdCredential/v1/enrollData/{externalConsumerId}/paymentInstruments/{referenceId}
**Enroll Existing Issuer Data with Payment Instrument Reference**
This API enrolls consumer info for a known payment instrument identified by paymentInstrumentRef. This API can be used when adding a consumer and card that has already been enrolled in Click to Pay / SRC to another service, i.e. Alias Directory. The external ConsumerID and paymentInstrumentRef must be known. The required referenceType field in the request body specifies what type of identifier is provided in paymentInstrumentRef — currently PAYMENT_ACCOUNT_REFERENCE is supported.
#### Parameters
| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| eX-Correlation-Id | header | Unique ID for every API request - an optional header. Generated by the API client. Used for end-to-end tracing/debugging. | No | string | No |
| externalConsumerId | path | Issuer of Visa provided consumer ID as uuid | Yes | string (uuid) | No |
| paymentInstrumentRef | path | The identifier for the payment instrument. The type of identifier is controlled by the required referenceType query parameter. PAYMENT_ACCOUNT_REFERENCE values are exactly 29 characters. | Yes | string | No |
#### Request Body
| Required | Schema |
| -------- | ------ |
| No | **application/json**: { **"products"**: [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string } } ], **"referenceType"**: string,
**Available values:** "PAYMENT_ACCOUNT_REFERENCE", **"externalConsumerIDOwnerBID"**: string }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | Accepted
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/json**: { **"requestTraceId"**: string (uuid) }
|
| 400 | When any field validation fails or when any required field is missing or when request is inconsistent with the Request definitions.
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string }
|
| 500 | Server Error
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"message"**: string }
|
---
## Status
Status API
### [GET] /visaIdCredential/v1/requestStatus/{requestTraceId}
**Request Status by Request Trace ID**
This API helps Issuers/Client to find out status of data changes submitted to Visa
#### Parameters
| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| requestTraceId | path | | Yes | string (uuid) | No |
| eX-Correlation-Id | header | Unique ID for every API request - an optional header. Generated by the API client. Used for end-to-end tracing/debugging. | No | string | No |
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Status of submitted request to be fetched using request Trace ID
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/json**: { **"status"**: string,
**Available values:** "IN_PROGRESS", "COMPLETED", **"details"**: [ { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" }, **"status"**: string,
**Available values:** "SUCCESS", "FAILED", **"errorDetails"**: [ { **"field"**: string, **"reason"**: string, **"message"**: string } ] } ], **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } } or { **"status"**: string,
**Available values:** "IN_PROGRESS", "COMPLETED", **"details"**: [ { **"status"**: string,
**Available values:** "SUCCESS", "IN_PROGRESS", "FAILED", **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"errorDetails"**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string } } ], **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } } or { **"status"**: string,
**Available values:** "IN_PROGRESS", "COMPLETED", **"details"**: [ { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" }, **"status"**: string,
**Available values:** "SUCCESS", "IN_PROGRESS", "FAILED", **"errorDetails"**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string } } or { **"status"**: string,
**Available values:** "SUCCESS", "IN_PROGRESS", "FAILED", **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"errorDetails"**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string } } ], **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } }
|
| 400 | When any field validation fails or when any required field is missing or when request is inconsistent with the Request definitions.
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string }
|
| 500 | Server Error
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"message"**: string }
|
---
## Lifecycle Management
Lifecycle Management API
### [PUT] /visaIdCredential/v1/managePaymentInstruments
**Manage Payment Instruments Data**
This API to update Payment Information
#### Parameters
| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| eX-Correlation-Id | header | Unique ID for every API request - an optional header. Generated by the API client. Used for end-to-end tracing/debugging. | No | string | No |
#### Request Body
| Required | Schema |
| -------- | ------ |
| No | **application/json**: { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" }, **"paymentInstruments"**: [ { **"type"**: string,
**Available values:** "CARD", "NON-VISA-CARD", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601), **"isAFAuthentication"**: boolean, **"isPaymentInstrumentConsent"**: boolean } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string } ], **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } } or { **"products"**: [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string } } ], **"paymentInstruments"**: [ { **"type"**: string,
**Available values:** "CARD", "NON-VISA-CARD", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601), **"isAFAuthentication"**: boolean, **"isPaymentInstrumentConsent"**: boolean } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string } ], **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } } or { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" }, **"products"**: [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string } } ], **"paymentInstruments"**: [ { **"type"**: string,
**Available values:** "CARD", "NON-VISA-CARD", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601), **"isAFAuthentication"**: boolean, **"isPaymentInstrumentConsent"**: boolean } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string } ], **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | Accepted
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/json**: { **"requestTraceId"**: string (uuid) }
|
| 400 | When any field validation fails or when any required field is missing or when request is inconsistent with the Request definitions.
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string }
|
| 500 | Server Error
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"message"**: string }
|
### [PUT] /visaIdCredential/v1/manageConsumerInformation
**Manage Consumer Information Data**
This API to update consumer information
#### Parameters
| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| eX-Correlation-Id | header | Unique ID for every API request - an optional header. Generated by the API client. Used for end-to-end tracing/debugging. | No | string | No |
#### Request Body
| Required | Schema |
| -------- | ------ |
| No | **application/json**: { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" }, **"consumerInformation"**: { **"emails"**: [ string ], **"locale"**: string (iso-639-1), **"phones"**: [ string ], **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"consent"**: { **"version"**: string, **"presenter"**: string, **"timeOfConsent"**: string }, **"fullName"**: string, **"lastName"**: string, **"firstName"**: string, **"middleName"**: string, **"countryCode"**: string (ISO 3166-1-alpha3), **"dateOfBirth"**: date, **"preferredname"**: string, **"externalConsumerID"**: string (uuid), **"nationalIdentifiers"**: [ { **"type"**: string,
**Available values:** "PASSPORT", "DRIVING_LICENSE", "NATIONAL_IDENTITY", **"value"**: string } ], **"externalConsumerIDOwnerBID"**: string } } or { **"products"**: [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string } } ], **"consumerInformation"**: { **"emails"**: [ string ], **"locale"**: string (iso-639-1), **"phones"**: [ string ], **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"consent"**: { **"version"**: string, **"presenter"**: string, **"timeOfConsent"**: string }, **"fullName"**: string, **"lastName"**: string, **"firstName"**: string, **"middleName"**: string, **"countryCode"**: string (ISO 3166-1-alpha3), **"dateOfBirth"**: date, **"preferredname"**: string, **"externalConsumerID"**: string (uuid), **"nationalIdentifiers"**: [ { **"type"**: string,
**Available values:** "PASSPORT", "DRIVING_LICENSE", "NATIONAL_IDENTITY", **"value"**: string } ], **"externalConsumerIDOwnerBID"**: string } } or { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" }, **"products"**: [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string } } ], **"consumerInformation"**: { **"emails"**: [ string ], **"locale"**: string (iso-639-1), **"phones"**: [ string ], **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"consent"**: { **"version"**: string, **"presenter"**: string, **"timeOfConsent"**: string }, **"fullName"**: string, **"lastName"**: string, **"firstName"**: string, **"middleName"**: string, **"countryCode"**: string (ISO 3166-1-alpha3), **"dateOfBirth"**: date, **"preferredname"**: string, **"externalConsumerID"**: string (uuid), **"nationalIdentifiers"**: [ { **"type"**: string,
**Available values:** "PASSPORT", "DRIVING_LICENSE", "NATIONAL_IDENTITY", **"value"**: string } ], **"externalConsumerIDOwnerBID"**: string } }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | Accepted
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/json**: { **"requestTraceId"**: string (uuid) }
|
| 400 | When any field validation fails or when any required field is missing or when request is inconsistent with the Request definitions.
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string }
|
| 422 | The requested operation is not supported for the specified product (for example, ANI or AVS).
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string }
|
| 500 | Server Error
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"message"**: string }
|
### [POST] /visaIdCredential/v1/deleteConsumerInformation
**Delete Consumer Information Data**
This API to delete consumer info
#### Parameters
| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| eX-Correlation-Id | header | Unique ID for every API request - an optional header. Generated by the API client. Used for end-to-end tracing/debugging. | No | string | No |
#### Request Body
| Required | Schema |
| -------- | ------ |
| No | **application/json**: { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" }, **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } } or { **"products"**: [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string } } ], **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } } or { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" }, **"products"**: [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string } } ], **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | Accepted
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/json**: { **"requestTraceId"**: string (uuid) }
|
| 400 | When any field validation fails or when any required field is missing or when request is inconsistent with the Request definitions.
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string }
|
| 422 | The requested operation is not supported for the specified product (for example, ANI or AVS).
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string }
|
| 500 | Server Error
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"message"**: string }
|
### [POST] /visaIdCredential/v1/deletePaymentInstruments
**Delete Payment Instruments Data**
This API to delete payment credential
#### Parameters
| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| eX-Correlation-Id | header | Unique ID for every API request - an optional header. Generated by the API client. Used for end-to-end tracing/debugging. | No | string | No |
#### Request Body
| Required | Schema |
| -------- | ------ |
| No | **application/json**: { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" }, **"paymentInstruments"**: { **"type"**: string,
**Available values:** "CARD", "NON-VISA-CARD", **"accountNumber"**: string } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"accountName"**: string, **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT" }, **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } } or { **"products"**: [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string } } ], **"paymentInstruments"**: { **"type"**: string,
**Available values:** "CARD", "NON-VISA-CARD", **"accountNumber"**: string } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"accountName"**: string, **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT" }, **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } } or { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" }, **"products"**: [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string } } ], **"paymentInstruments"**: { **"type"**: string,
**Available values:** "CARD", "NON-VISA-CARD", **"accountNumber"**: string } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"accountName"**: string, **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT" }, **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 202 | Accepted
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/json**: { **"requestTraceId"**: string (uuid) }
|
| 400 | When any field validation fails or when any required field is missing or when request is inconsistent with the Request definitions.
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string }
|
| 500 | Server Error
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"message"**: string }
|
### [POST] /visaIdCredential/v1/getData
**Get Data**
This API gets Consumer Information and Payment Credential info for a given product
#### Parameters
| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| eX-Correlation-Id | header | Unique ID for every API request - an optional header. Generated by the API client. Used for end-to-end tracing/debugging. | No | string | No |
#### Request Body
| Required | Schema |
| -------- | ------ |
| No | **application/json**: { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" }, **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } } or { **"products"**: [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string } } ], **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } } or { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" }, **"products"**: [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string } } ], **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Get Data | **application/json**: { **"data"**: [ { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" }, **"paymentInstruments"**: [ { **"type"**: string,
**Available values:** "CARD", "NON-VISA-CARD", **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"tokenDetails"**: { **"tokenReferenceID"**: string, **"tokenRequestorID"**: string }, **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601), **"preferredTimestamp"**: dateTime, **"paymentAccountReference"**: string, **"paymentInstrumentReferenceId"**: string } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string, **"preferredTimestamp"**: dateTime } ], **"consumerInformation"**: { **"emails"**: [ string ], **"locale"**: string (iso-639-1), **"phones"**: [ string ], **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"consent"**: { **"version"**: string, **"presenter"**: string, **"timeOfConsent"**: string }, **"fullName"**: string, **"lastName"**: string, **"firstName"**: string, **"middleName"**: string, **"countryCode"**: string (ISO 3166-1-alpha3), **"dateOfBirth"**: date, **"preferredname"**: string, **"externalConsumerID"**: string (uuid), **"nationalIdentifiers"**: [ { **"type"**: string,
**Available values:** "PASSPORT", "DRIVING_LICENSE", "NATIONAL_IDENTITY", **"value"**: string } ], **"externalConsumerIDOwnerBID"**: string } } ] } or { **"data"**: [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string }, **"errorDetails"**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string }, **"paymentInstruments"**: [ { **"type"**: string,
**Available values:** "CARD", "NON-VISA-CARD", **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"tokenDetails"**: { **"tokenReferenceID"**: string, **"tokenRequestorID"**: string }, **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601), **"preferredTimestamp"**: dateTime, **"paymentAccountReference"**: string, **"paymentInstrumentReferenceId"**: string } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string, **"preferredTimestamp"**: dateTime } ], **"consumerInformation"**: { **"emails"**: [ string ], **"locale"**: string (iso-639-1), **"phones"**: [ string ], **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"consent"**: { **"version"**: string, **"presenter"**: string, **"timeOfConsent"**: string }, **"fullName"**: string, **"lastName"**: string, **"firstName"**: string, **"middleName"**: string, **"countryCode"**: string (ISO 3166-1-alpha3), **"dateOfBirth"**: date, **"preferredname"**: string, **"externalConsumerID"**: string (uuid), **"nationalIdentifiers"**: [ { **"type"**: string,
**Available values:** "PASSPORT", "DRIVING_LICENSE", "NATIONAL_IDENTITY", **"value"**: string } ], **"externalConsumerIDOwnerBID"**: string } } ] } or { **"data"**: [ { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" }, **"errorDetails"**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string }, **"paymentInstruments"**: [ { **"type"**: string,
**Available values:** "CARD", "NON-VISA-CARD", **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"tokenDetails"**: { **"tokenReferenceID"**: string, **"tokenRequestorID"**: string }, **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601), **"preferredTimestamp"**: dateTime, **"paymentAccountReference"**: string, **"paymentInstrumentReferenceId"**: string } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string, **"preferredTimestamp"**: dateTime } ], **"consumerInformation"**: { **"emails"**: [ string ], **"locale"**: string (iso-639-1), **"phones"**: [ string ], **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"consent"**: { **"version"**: string, **"presenter"**: string, **"timeOfConsent"**: string }, **"fullName"**: string, **"lastName"**: string, **"firstName"**: string, **"middleName"**: string, **"countryCode"**: string (ISO 3166-1-alpha3), **"dateOfBirth"**: date, **"preferredname"**: string, **"externalConsumerID"**: string (uuid), **"nationalIdentifiers"**: [ { **"type"**: string,
**Available values:** "PASSPORT", "DRIVING_LICENSE", "NATIONAL_IDENTITY", **"value"**: string } ], **"externalConsumerIDOwnerBID"**: string } } or { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string }, **"errorDetails"**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string }, **"paymentInstruments"**: [ { **"type"**: string,
**Available values:** "CARD", "NON-VISA-CARD", **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"tokenDetails"**: { **"tokenReferenceID"**: string, **"tokenRequestorID"**: string }, **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601), **"preferredTimestamp"**: dateTime, **"paymentAccountReference"**: string, **"paymentInstrumentReferenceId"**: string } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string, **"preferredTimestamp"**: dateTime } ], **"consumerInformation"**: { **"emails"**: [ string ], **"locale"**: string (iso-639-1), **"phones"**: [ string ], **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"consent"**: { **"version"**: string, **"presenter"**: string, **"timeOfConsent"**: string }, **"fullName"**: string, **"lastName"**: string, **"firstName"**: string, **"middleName"**: string, **"countryCode"**: string (ISO 3166-1-alpha3), **"dateOfBirth"**: date, **"preferredname"**: string, **"externalConsumerID"**: string (uuid), **"nationalIdentifiers"**: [ { **"type"**: string,
**Available values:** "PASSPORT", "DRIVING_LICENSE", "NATIONAL_IDENTITY", **"value"**: string } ], **"externalConsumerIDOwnerBID"**: string } } ] }
|
| 400 | When any field validation fails or when any required field is missing or when request is inconsistent with the Request definitions.
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string }
|
| 409 | Conflict - Enrollment is currently in progress for the specified externalConsumerId. Data retrieval cannot be performed until enrollment completes.
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string }
|
| 422 | The requested operation is not supported for the specified product (for example, ANI or AVS).
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string }
|
| 500 | Server Error
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/problem+json**: { **"reason"**: string, **"message"**: string }
|
---
## Alias Directory - Resolution
Alias Directory Service Resolution
### [POST] /visaIdCredential/v1/aliases/confirm
**aliasConfirm**
Retrieve information about an Alias. This will help confirm the identity of the person associated with the alias, ensuring secure and accurate transactions.
#### Parameters
| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| eX-Correlation-Id | header | Unique ID for every API request - an optional header. Generated by the API client. Used for end-to-end tracing/debugging. | No | string | No |
#### Request Body
| Required | Schema |
| -------- | ------ |
| No | **application/json**: { **"filters"**: [ { **"field"**: string,
**Available values:** "DIRECTORY_NAME", "EXCLUDED_DIRECTORY_NAME", "ENTITY_ID", **"value"**: [ ] } ], **"aliasType"**: string,
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME", "NATIVE_ALIAS", "NATIONAL_ID", **"aliasValue"**: , **"userDetails"**: { **"userName"**: }, **"transactionDetails"**: { **"currencyCode"**: , **"contactNumberLast4"**: } }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK - Alias Confirm response
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/json**: { **"profile"**: { **"lastName"**: , **"firstName"**: , **"middleName"**: , **"lastNameLocal"**: , **"firstNameLocal"**: , **"middleNameLocal"**: }, **"aliasType"**: , **"aliasValue"**: , **"directoryName"**: , **"additionalInfo"**: { **"validationResult"**: { **"status"**: string,
**Available values:** "MATCH", "NO_MATCH", "NOT_PROVIDED" } }, **"paymentCredentials"**: [ { **"type"**: , **"issuerName"**: } or { **"type"**: , **"bankName"**: } ] }
|
| 400 | Bad Request. Returned when any field validations fails or when any required fields is missing or when request is inconsistent with the Request definitions.
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/json**: { **"errorCode"**: , **"errorMessages"**: [ ] }
|
| 422 | Unprocessable Entity The server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. | **application/json**: { **"errorCode"**: , **"errorMessages"**: [ ] }
|
| 500 | Internal Server Error
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/json**: { **"errorCode"**: , **"errorMessages"**: [ ] }
|
### [POST] /visaIdCredential/v1/aliases/inquiry
**aliasInquiry**
This enables clients to check if an Alias or list of Aliases is available for Alias resolution. The response will indicate the Aliases that are available for Alias resolution. Up to 1000 Aliases can be sent in a single request.
#### Parameters
| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| eX-Correlation-Id | header | Unique ID for every API request - an optional header. Generated by the API client. Used for end-to-end tracing/debugging. | No | string | No |
#### Request Body
| Required | Schema |
| -------- | ------ |
| No | **application/json**: { **"aliases"**: [ ], **"filters"**: [ { **"field"**: string,
**Available values:** "DIRECTORY_NAME", "EXCLUDED_DIRECTORY_NAME", "ENTITY_ID", **"value"**: [ ] } ], **"userDetails"**: { **"userName"**: }, **"transactionDetails"**: { **"currencyCode"**: } }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | Alias Inquiry response
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/json**: { **"details"**: [ { **"aliasType"**: string,
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME", "NATIVE_ALIAS", "NATIONAL_ID", **"aliasValue"**: , **"directories"**: [ { **"entities"**: [ { **"id"**: , **"preferredFor"**: [ { **"date"**: undefined (date-time), **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } ], **"directoryName"**: } ], **"directoriesName"**: [ ] } ], **"summary"**: { **"aliasesFound"**: undefined (int32), **"aliasesTotal"**: undefined (int32), **"aliasesNotFound"**: undefined (int32), **"aliasesRepeated"**: undefined (int32) } }
|
| 400 | Bad Request. Returned when any field validations fails or when any required fields is missing or when request is inconsistent with the Request definitions.
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/json**: { **"errorCode"**: , **"errorMessages"**: [ ] }
|
| 500 | Internal Server Error
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/json**: { **"errorCode"**: , **"errorMessages"**: [ ] }
|
### [POST] /visaIdCredential/v1/aliases/resolve
**Alias Resolve**
Retrieve information about an Alias and the payment credential(s) associated with the Alias. This information can then be used to initiate a funds movement transaction. The parameters in the response may vary depending on the program configuration.
#### Parameters
| Name | Located in | Description | Required | Schema | Explode |
| ---- | ---------- | ----------- | -------- | ------ | ------- |
| eX-Correlation-Id | header | Unique ID for every API request - an optional header. Generated by the API client. Used for end-to-end tracing/debugging. | No | string | No |
#### Request Body
| Required | Schema |
| -------- | ------ |
| No | **application/json**: { **"filters"**: [ { **"field"**: string,
**Available values:** "DIRECTORY_NAME", "EXCLUDED_DIRECTORY_NAME", "ENTITY_ID", **"value"**: [ ] } ], **"aliasType"**: string,
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME", "NATIVE_ALIAS", "NATIONAL_ID", **"aliasValue"**: , **"userDetails"**: { **"userName"**: }, **"transactionDetails"**: { **"currencyCode"**: } }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 200 | OK - Alias Resolution response
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/json**: { **"profile"**: { **"lastName"**: , **"firstName"**: , **"middleName"**: , **"contactInfo"**: [ { **"type"**: string,
**Available values:** "EMAIL", "PHONE", "DIRECTORY_ALIASID", **"value"**: } ], **"dateOfBirth"**: , **"lastNameLocal"**: , **"preferredName"**: , **"firstNameLocal"**: , **"middleNameLocal"**: }, **"directoryName"**: , **"identification"**: { **"type"**: , **"value"**: , **"verificationDetails"**: { **"authDateTime"**: undefined (date-time), **"verifiedEmail"**: , **"verifiedPhone"**: , **"creationDateTime"**: undefined (date-time), **"authMethodReference"**: } }, **"paymentCredentials"**: [ { **"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"**: string,
**Available values:** "NIUBIZ", "TOKEN", "PAN" } & { **"modifiedOn"**: undefined (date-time) } & { **"preferredFor"**: [ { **"date"**: undefined (date-time), **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } 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"**: string,
**Available values:** "CHECKING", "SAVING", **"countryCode"**: undefined (We recommend to use the Alpha-3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: , **"accountNumber"**: , **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", "TOKEN", "CCI" } & { **"modifiedOn"**: undefined (date-time) } & { **"preferredFor"**: [ { **"date"**: undefined (date-time), **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } ] }
|
| 400 | Bad Request. Returned when any field validations fails or when any required fields is missing or when request is inconsistent with the Request definitions.
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/json**: { **"errorCode"**: , **"errorMessages"**: [ ] }
|
| 422 | Unprocessable Entity The server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions. | **application/json**: { **"errorCode"**: , **"errorMessages"**: [ ] }
|
| 500 | Internal Server Error
**Headers:**
**eX-Correlation-Id**: Unique external Correlation ID echoed back from the request. Used to track/debug requests across client and Visa systems.
| **application/json**: { **"errorCode"**: , **"errorMessages"**: [ ] }
|
---
### Webhooks
### [POST] /cpua/v1/asyncRequests/{requestTraceId}/notification
**Request Status Notification**
Visa invokes this endpoint to notify the client of the completion of an asynchronously processed request. The endpoint is registered and configured by the client in Visa Developer Platform (VDP).
#### Request Body
| Required | Schema |
| -------- | ------ |
| Yes | **application/json**: { **"requestTraceId"**: string (uuid) } & { **"status"**: string,
**Available values:** "IN_PROGRESS", "COMPLETED", **"details"**: [ { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "VISA_PROTECT_A2A" }, **"status"**: string,
**Available values:** "SUCCESS", "FAILED", **"errorDetails"**: [ { **"field"**: string, **"reason"**: string, **"message"**: string } ] } ], **"consumerInformation"**: { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } }
|
#### Responses
| Code | Description | Schema |
| ---- | ----------- | ------ |
| 204 | No Content | |
| 400 | When any field validation fails or when any required field is missing or when request is inconsistent with the Request definitions. | **application/problem+json**: { **"reason"**: string, **"details"**: [ { **"reason"**: string, **"location"**: string } ], **"message"**: string }
|
| 500 | Server Error | **application/problem+json**: { **"errorResponse"**: { **"reason"**: string, **"message"**: string } }
|
---
### Schemas
#### BankName Schema
Bank name of the payment credential
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| BankName | string | Bank name of the payment credential | |
**Example**
Bank A
#### DateTime-1 Schema
ISO formatted Timestamp
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| DateTime-1 | undefined (date-time) | ISO formatted Timestamp | |
**Example**
2021-01-01T22:52:46Z
#### DeleteCardPaymentInstrument-1 Schema
Payment credentials to be deleted
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string,
**Available values:** "CARD" | Type of payment instrument
*Enum:* `"CARD"`
*Example:* `"CARD"` | Yes |
| accountNumber | string | Primary account number of the card
*Example:* `"4111111145551140"` | Yes |
#### Address Schema
Billing Address details
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| city | string | City
*Example:* `"San Francisco"` | No |
| state | string (ISO 3166-2) | State (ISO 3166-2)
*Example:* `"CA"` | No |
| country | string (ISO 3166-1-alpha3) | Country code using 3-character ISO 3166 (Alpha 3) format
*Example:* `"USA"` | Yes |
| postalCode | string | Postal code of the address
*Example:* `"94105"` | No |
| addressLine1 | string | Address Line 1
*Example:* `"1000 Market Street"` | No |
| addressLine2 | string | Address line 2
*Example:* `"Building 56"` | No |
| addressLine3 | string | Address line 3
*Example:* `"Suite 101"` | No |
#### Product Schema
Product identifier used to route the request to the correct Visa product
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| productCode | string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE" | Product Identifier
*Enum:* `"CLICK_TO_PAY"`, `"ADDRESS_VERIFICATION_SERVICE"`, `"ACCOUNT_NAME_INQUIRY"`, `"ALIAS_DIRECTORY_SERVICE"`
*Example:* `"CLICK_TO_PAY"` | Yes |
| productData | { **"name"**: string, **"value"**: string } | Product specific payload parameters defined by product team. | No |
#### AlphaCountryCode Schema
Country code using 3-character ISO 3166 (Alpha 3) format
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AlphaCountryCode | string (ISO 3166-1-alpha3) | Country code using 3-character ISO 3166 (Alpha 3) format | |
**Example**
USA
#### CurrencyCode Schema
Bank account currency code. Format: 3-character ISO-4217 (Alpha-3) currency code
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CurrencyCode | string | Bank account currency code. Format: 3-character ISO-4217 (Alpha-3) currency code | |
**Example**
USD
#### Consent Schema
Consent details
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| version | string | Specific version of the terms and conditions that the customer accept for the user solution
*Example:* `"1.0"` | No |
| presenter | string | Identifies the presenter of consent to the consumer
*Example:* `"Bank A"` | No |
| timeOfConsent | string | Date/Time from which the consent is valid, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z. Only accepts present and past dates.
*Example:* `"2020-05-05T12:12:12.000Z"` | Yes |
#### NationalIdentifiersList Schema
National identifier for the consumer
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| NationalIdentifiersList | [ { **"type"**: string,
**Available values:** "PASSPORT", "DRIVING_LICENSE", "NATIONAL_IDENTITY", **"value"**: string } ] | National identifier for the consumer | |
#### AdditionalInfo-1 Schema
Additional information returned in the confirm response.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| validationResult | { **"status"**: string,
**Available values:** "MATCH", "NO_MATCH", "NOT_PROVIDED" } | Validation result for identity verification. | No |
#### NameOnCard Schema
Name that appears on the card
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| NameOnCard | string | Name that appears on the card | |
**Example**
John Doe
#### PaymentInstrumentReferenceType Schema
Type of identifier provided in paymentInstrumentRef. Valid values 'PAYMENT_ACCOUNT_REFERENCE', 'TOKEN_REF_ID'. Future releases will add additional reference types.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PaymentInstrumentReferenceType | string,
**Available values:** "PAYMENT_ACCOUNT_REFERENCE", "TOKEN_REF_ID" | Type of identifier provided in paymentInstrumentRef. Valid values 'PAYMENT_ACCOUNT_REFERENCE', 'TOKEN_REF_ID'. Future releases will add additional reference types. | |
**Example**
PAYMENT_ACCOUNT_REFERENCE
#### DeleteBankAccountPaymentInstrument Schema
Payment credentials to be deleted
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string,
**Available values:** "BANK_ACCOUNT" | Type of payment instrument
*Enum:* `"BANK_ACCOUNT"`
*Example:* `"BANK_ACCOUNT"` | Yes |
| accountName | string | Bank account name, i.e., account holder name as recorded on the bank account
*Example:* `"Alex Miller"` | Yes |
| accountNumber | string | Bank account number
*Example:* `"1001001234"` | Yes |
| accountNumberType | string,
**Available values:** "IBAN", "DEFAULT" | Bank account number type. Valid values 'IBAN', 'DEFAULT'. If the IBAN format is not supported in a country, use DEFAULT.
*Enum:* `"IBAN"`, `"DEFAULT"`
*Example:* `"DEFAULT"` | Yes |
#### 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 |
#### Status Schema
Manage Consumer Status
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Status | string,
**Available values:** "ACTIVE", "DISABLED" | Manage Consumer Status | |
**Example**
ACTIVE
#### DateOfBirth Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| DateOfBirth | date | | |
#### RequestId Schema
Unique identifier of the request
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| RequestId | string (uuid) | Unique identifier of the request | |
**Example**
351562ba-83cf-11ee-b962-0242ac120002
#### ProductCode Schema
Product Identifier
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ProductCode | string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE" | Product Identifier | |
**Example**
CLICK_TO_PAY
#### GetConsumerInformation Schema
Consumer details
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| emails | [ string ] | Consumer's email address | No |
| locale | string (iso-639-1) | Language and country in which the product communicates with the consumer
*Example:* `"en_US"` | No |
| phones | [ string ] | Consumer's phone number according to ITU-T E.164 (2010) number structure. Do not use the "+" symbol. | No |
| status | string,
**Available values:** "ACTIVE", "DISABLED" | Manage Consumer Status
*Enum:* `"ACTIVE"`, `"DISABLED"`
*Example:* `"ACTIVE"` | No |
| consent | { **"version"**: string, **"presenter"**: string, **"timeOfConsent"**: string } | Consent details | No |
| fullName | string | Consumer's full name
*Example:* `"Alex Miller"` | No |
| lastName | string | Consumer's last name
*Example:* `"Miller"` | Yes |
| firstName | string | Consumer's first name
*Example:* `"Alex"` | Yes |
| middleName | string | Consumer's middle name
*Example:* `"Robert"` | No |
| countryCode | string (ISO 3166-1-alpha3) | Country code using 3-character ISO 3166 (Alpha 3) format
*Example:* `"USA"` | Yes |
| dateOfBirth | date | | No |
| preferredname | string | Consumer's preferred name
*Example:* `"Alex"` | No |
| externalConsumerID | string (uuid) | Client-provided unique identifier of a consumer
*Example:* `"63421837-d597-4f0f-89e4-930c1a7b9e85"` | Yes |
| nationalIdentifiers | [ { **"type"**: string,
**Available values:** "PASSPORT", "DRIVING_LICENSE", "NATIONAL_IDENTITY", **"value"**: string } ] | National identifier for the consumer | No |
| externalConsumerIDOwnerBID | string | Visa Business Identifier (BID) of the entity to which an External Consumer ID belongs. This field is optional for clients integrated prior to 3rd April 2025. Required for all other clients. Questions should be directed to your Visa Integration Specialist.
*Example:* `"10098765"` | No |
#### Bank-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 | 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 | string,
**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 | 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 | | 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 | string,
**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 |
#### GetConsumerInformation-1 Schema
Consumer details
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| emails | [ string ] | Consumer's email addresses | No |
| locale | string (iso-639-1) | Language and country in which the product communicates with the consumer
*Example:* `"en_US"` | No |
| phones | [ string ] | Consumer's phone numbers | No |
| status | string,
**Available values:** "ACTIVE", "DISABLED" | Manage Consumer Status
*Enum:* `"ACTIVE"`, `"DISABLED"`
*Example:* `"ACTIVE"` | No |
| consent | { **"version"**: string, **"presenter"**: string, **"timeOfConsent"**: string } | Consent details | No |
| lastName | string | Consumer's last name
*Example:* `"Miller"` | Yes |
| firstName | string | Consumer's first name
*Example:* `"Alex"` | Yes |
| middleName | string | Consumer's middle name
*Example:* `"Robert"` | No |
| countryCode | string (ISO 3166-1-alpha3) | Country code using 3-character ISO 3166 (Alpha 3) format
*Example:* `"USA"` | Yes |
| externalConsumerID | string (uuid) | Client-provided unique identifier of a consumer
*Example:* `"63421837-d597-4f0f-89e4-930c1a7b9e85"` | Yes |
| nationalIdentifiers | [ { **"type"**: string,
**Available values:** "PASSPORT", "DRIVING_LICENSE", "NATIONAL_IDENTITY", **"value"**: string } ] | National identifier for the consumer | No |
| externalConsumerIDOwnerBID | string | Visa Business Identifier (BID) of the entity to which an External Consumer ID belongs. This field is optional for clients integrated prior to 3rd April 2025. Required for all other clients. Questions should be directed to your Visa Integration Specialist.
*Example:* `"10098765"` | No |
#### 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 |
#### AliasInquiryResponseInternal-2 Schema
Alias Inquiry Response Payload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| details | [ { **"aliasType"**: string,
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME", "NATIVE_ALIAS", "NATIONAL_ID", **"aliasValue"**: , **"directories"**: [ { **"entities"**: [ { **"id"**: , **"preferredFor"**: [ { **"date"**: undefined (date-time), **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } ], **"directoryName"**: } ], **"directoriesName"**: [ ] } ] | 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
}
}
#### GetCardPaymentInstrument Schema
Payment credentials details to be linked
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string,
**Available values:** "CARD", "NON-VISA-CARD" | Type of payment instrument
*Enum:* `"CARD"`, `"NON-VISA-CARD"`
*Example:* `"CARD"` | Yes |
| status | string,
**Available values:** "ACTIVE", "DISABLED" | Manage Consumer Status
*Enum:* `"ACTIVE"`, `"DISABLED"`
*Example:* `"ACTIVE"` | No |
| cardType | string | Card type description. Reference to Field 62.23—Product ID of available card products
*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
*Example:* `"John Doe"` | Yes |
| currencyCode | string | Bank account currency code. Format: 3-character ISO-4217 (Alpha-3) currency code
*Example:* `"USD"` | No |
| preferredFor | [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ] | Consumer's preferred use(s) for this payment instrument
*Example:* `[{"type":"SEND"},{"type":"RECEIVE"}]` | No |
| tokenDetails | { **"tokenReferenceID"**: string, **"tokenRequestorID"**: string } | Token details | No |
| accountNumber | string | Primary account number of the card
*Example:* `"4111111145551140"` | Yes |
| billingAddress | { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string } | Billing Address details | Yes |
| expirationDate | string (ISO 8601) | Expiration date of the card
*Example:* `"2030-01"` | Yes |
| preferredTimestamp | dateTime | ISO 8601 timestamp indicating when this payment instrument was last set as preferred. Populated from ADS.
*Example:* `"2024-03-15T10:30:00Z"` | No |
| paymentAccountReference | string | Unique payment account reference for the card | No |
| paymentInstrumentReferenceId | string | Unique identifier for the payment instrument | No |
#### Card-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. 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 | 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 |
#### 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-2 Schema
this field contains ISO3166 country code (Alpha-3).
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AlphaCountryCode-2 | undefined (We recommend to use the Alpha-3) | this field contains ISO3166 country code (Alpha-3). | |
**Example**
USA
#### AliasInquiryEntityItem-2 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | | Id of the entity used to identify the entity
*Example:* `"entity1"` | No |
| preferredFor | [ { **"date"**: undefined (date-time), **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] | Preferred for information for each entity | No |
#### AccountName Schema
Bank account name, i.e., account holder name as recorded on the bank account
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AccountName | string | Bank account name, i.e., account holder name as recorded on the bank account | |
**Example**
Alex Miller
#### CardConfirmPath-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 |
#### 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
#### PaymentInstrumentList-1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PaymentInstrumentList-1 | [ { **"type"**: string,
**Available values:** "CARD", "NON-VISA CARD", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601), **"AFAuthentication"**: boolean, **"paymentInstrumentConsent"**: boolean } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string } ] | | |
#### 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 |
#### AliasResolveRequest-2 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"**: [ ] } ] | List of the filter to apply in the request | No |
| aliasType | string,
**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 |
#### PaymentCredentialItemAliasResponse-2 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PaymentCredentialItemAliasResponse-2 | { **"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"**: string,
**Available values:** "NIUBIZ", "TOKEN", "PAN" } & { **"modifiedOn"**: undefined (date-time) } & { **"preferredFor"**: [ { **"date"**: undefined (date-time), **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } 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"**: string,
**Available values:** "CHECKING", "SAVING", **"countryCode"**: undefined (We recommend to use the Alpha-3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: , **"accountNumber"**: , **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", "TOKEN", "CCI" } & { **"modifiedOn"**: undefined (date-time) } & { **"preferredFor"**: [ { **"date"**: undefined (date-time), **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } | | |
#### products Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| products | [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string } } ] | | |
#### ItemErrorDetails Schema
Error details when an intent or productCode item fails. Shared across data retrieval, request status, and async notification responses.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| reason | string | *Example:* `"VIDC-1001"` | No |
| details | [ { **"reason"**: string, **"location"**: string } ] | | No |
| message | string | *Example:* `"No enrollment found for the given consumer ID under this product"` | No |
#### BankAliasResponse-2 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| BankAliasResponse-2 | { **"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"**: string,
**Available values:** "CHECKING", "SAVING", **"countryCode"**: undefined (We recommend to use the Alpha-3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: , **"accountNumber"**: , **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", "TOKEN", "CCI" } & { **"modifiedOn"**: undefined (date-time) } & { **"preferredFor"**: [ { **"date"**: undefined (date-time), **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } | | |
#### ProductInformationList Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ProductInformationList | [ { **"productCode"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "ACCOUNT_NAME_INQUIRY", "ALIAS_DIRECTORY_SERVICE", **"productData"**: { **"name"**: string, **"value"**: string } } ] | | |
#### Filters-1 Schema
List of the filter to apply in the request
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Filters-1 | [ { **"field"**: string,
**Available values:** "DIRECTORY_NAME", "EXCLUDED_DIRECTORY_NAME", "ENTITY_ID", **"value"**: [ ] } ] | List of the filter to apply in the request | |
#### PaymentInstrumentList-3 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PaymentInstrumentList-3 | [ { **"type"**: string,
**Available values:** "CARD", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601) } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string } ] | | |
#### PaymentInstrumentList Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PaymentInstrumentList | [ { **"type"**: string,
**Available values:** "CARD", "NON-VISA-CARD", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601), **"isAFAuthentication"**: boolean, **"isPaymentInstrumentConsent"**: boolean } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string } ] | | |
#### Emails-1 Schema
Consumer's email addresses
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Emails-1 | [ string ] | Consumer's email addresses | |
#### 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
#### CardAliasResponse-2 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CardAliasResponse-2 | { **"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"**: string,
**Available values:** "NIUBIZ", "TOKEN", "PAN" } & { **"modifiedOn"**: undefined (date-time) } & { **"preferredFor"**: [ { **"date"**: undefined (date-time), **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } | | |
#### FirstName Schema
Consumer's first name
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| FirstName | string | Consumer's first name | |
**Example**
Alex
#### CardPaymentInstrument Schema
Payment credentials details to be linked
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string,
**Available values:** "CARD", "NON-VISA-CARD" | Type of payment instrument
*Enum:* `"CARD"`, `"NON-VISA-CARD"`
*Example:* `"CARD"` | Yes |
| cardType | string | Card type description. Reference to Field 62.23—Product ID of available card products
*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
*Example:* `"John Doe"` | Yes |
| currencyCode | string | Bank account currency code. Format: 3-character ISO-4217 (Alpha-3) currency code
*Example:* `"USD"` | No |
| preferredFor | [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ] | Consumer's preferred use(s) for this payment instrument
*Example:* `[{"type":"SEND"},{"type":"RECEIVE"}]` | No |
| accountNumber | string | Primary account number of the card
*Example:* `"4111111145551140"` | Yes |
| billingAddress | { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string } | Billing Address details | Yes |
| expirationDate | string (ISO 8601) | Expiration date of the card
*Example:* `"2030-01"` | Yes |
| isAFAuthentication | boolean | Attests that the issuer has completed an Additional Factor of Authentication (AFA) with the consumer prior to enrollment, as required by RBI for India-market issuers. - `true` — AFA was successfully completed before this enrollment - `false` — AFA was not completed - absent — silently accepted (default for non-India issuers) Only boolean values are accepted. Null and non-boolean values are rejected with HTTP 400. | No |
| isPaymentInstrumentConsent | boolean | Attests that the issuer has obtained explicit consumer consent for card tokenization, as required by the Reserve Bank of India (RBI) for India-market issuers enrolling payment credentials. - `true` — consent was explicitly received before this enrollment - `false` — consent was explicitly not received - absent — silently accepted (default for non-India issuers) Only boolean values are accepted. Null and non-boolean values (e.g. strings, numbers) are rejected with HTTP 400. VICA is not the system of record; value is forwarded to CTP in the encrypted Kafka payload. | No |
#### BankIdentifierCode-1 Schema
Bank account Business Identifier Code (BIC), conditional for select markets
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| BankIdentifierCode-1 | string | Bank account Business Identifier Code (BIC), conditional for select markets | |
**Example**
AAAABBCC123
#### Consent-1 Schema
Consent details
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| version | string | Specific version of the terms and conditions that the customer accept for the user solution
*Example:* `"1.0"` | No |
| presenter | string | Identifies the presenter of consent to the consumer
*Example:* `"Bank A"` | No |
| timeOfConsent | string | Date/Time from which the consent is valid, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z. Only accepts present and past dates.
*Example:* `"2020-05-05T12:12:12.000Z"` | Yes |
#### ConsumerInformation-1 Schema
Consumer details
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| emails | [ string ] | Consumer's email addresses | No |
| locale | string (iso-639-1) | Language and country in which the product communicates with the consumer
*Example:* `"en_US"` | No |
| phones | [ string ] | Consumer's phone numbers | No |
| consent | { **"version"**: string, **"presenter"**: string, **"timeOfConsent"**: string } | Consent details | No |
| lastName | string | Consumer's last name
*Example:* `"Miller"` | Yes |
| firstName | string | Consumer's first name
*Example:* `"Alex"` | Yes |
| middleName | string | Consumer's middle name
*Example:* `"Robert"` | No |
| countryCode | string (ISO 3166-1-alpha3) | Country code using 3-character ISO 3166 (Alpha 3) format
*Example:* `"USA"` | Yes |
| externalConsumerID | string (uuid) | Client-provided unique identifier of a consumer
*Example:* `"63421837-d597-4f0f-89e4-930c1a7b9e85"` | Yes |
| nationalIdentifiers | [ { **"type"**: string,
**Available values:** "PASSPORT", "DRIVING_LICENSE", "NATIONAL_IDENTITY", **"value"**: string } ] | National identifier for the consumer | No |
| externalConsumerIDOwnerBID | string | Visa Business Identifier (BID) of the entity to which an External Consumer ID belongs. This field is optional for clients integrated prior to 3rd April 2025. Required for all other clients. Questions should be directed to your Visa Integration Specialist.
*Example:* `"10098765"` | No |
#### Intent Schema
Indicates the target product
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string,
**Available values:** "PRODUCT_CODE" | Indicates the type of the intent
*Enum:* `"PRODUCT_CODE"` | Yes |
| value | string,
**Available values:** "CLICK_TO_PAY" | Product name for which the request is intended
*Enum:* `"CLICK_TO_PAY"` | Yes |
**Example**
{
"type": "PRODUCT_CODE",
"value": "CLICK_TO_PAY"
}
#### BankCode Schema
Bank account bank code, conditional for select markets
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| BankCode | string | Bank account bank code, conditional for select markets | |
**Example**
173
#### BankAccountPaymentInstrument Schema
Payment credentials details to be linked
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string,
**Available values:** "BANK_ACCOUNT" | Type of payment instrument
*Enum:* `"BANK_ACCOUNT"`
*Example:* `"BANK_ACCOUNT"` | Yes |
| address | { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string } | Billing Address details | No |
| bankCode | string | Bank account bank code, conditional for select markets
*Example:* `"173"` | No |
| bankName | string | Bank name of the payment credential
*Example:* `"Bank A"` | No |
| branchCode | string | Bank account branch code, conditional for select markets
*Example:* `"123456"` | No |
| accountName | string | Bank account name, i.e., account holder name as recorded on the bank account
*Example:* `"Alex Miller"` | Yes |
| accountType | string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN" | Bank account type
*Enum:* `"CHECKING"`, `"SAVING"`, `"MAESTRA"`, `"VISTA"`, `"LOAN"`
*Example:* `"CHECKING"` | No |
| countryCode | string (ISO 3166-1-alpha3) | Country code using 3-character ISO 3166 (Alpha 3) format
*Example:* `"USA"` | Yes |
| bankCodeType | string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT" | Bank account bank code type, conditional for select markets
*Enum:* `"ABA"`, `"SORT_CODE"`, `"DEFAULT"`
*Example:* `"DEFAULT"` | No |
| currencyCode | string | Bank account currency code. Format: 3-character ISO-4217 (Alpha-3) currency code
*Example:* `"USD"` | Yes |
| preferredFor | [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ] | Consumer's preferred use(s) for this payment instrument
*Example:* `[{"type":"SEND"},{"type":"RECEIVE"}]` | No |
| accountNumber | string | Bank account number
*Example:* `"1001001234"` | Yes |
| accountNumberType | string,
**Available values:** "IBAN", "DEFAULT" | Bank account number type. Valid values 'IBAN', 'DEFAULT'. If the IBAN format is not supported in a country, use DEFAULT.
*Enum:* `"IBAN"`, `"DEFAULT"`
*Example:* `"DEFAULT"` | Yes |
| bankIdentifierCode | string | Bank account Business Identifier Code (BIC), conditional for select markets
*Example:* `"AAAABBCC123"` | No |
#### PaymentCredentialOnePreferredOn-2 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| modifiedOn | undefined (date-time) | Date of the last update | No |
#### GetDataPaymentInstrumentList Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| GetDataPaymentInstrumentList | [ { **"type"**: string,
**Available values:** "CARD", "NON-VISA-CARD", **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"tokenDetails"**: { **"tokenReferenceID"**: string, **"tokenRequestorID"**: string }, **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601), **"preferredTimestamp"**: dateTime, **"paymentAccountReference"**: string, **"paymentInstrumentReferenceId"**: string } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"preferredFor"**: [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ], **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string, **"preferredTimestamp"**: dateTime } ] | | |
#### Type Schema
Indicates the type of the intent
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Type | string,
**Available values:** "PRODUCT_CODE" | Indicates the type of the intent | |
#### ExpirationDate Schema
Expiration date of the card
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ExpirationDate | string (ISO 8601) | Expiration date of the card | |
**Example**
2030-01
#### 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
#### PreferredTimestamp Schema
ISO 8601 timestamp indicating when this payment instrument was last set as preferred. Populated from ADS.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PreferredTimestamp | dateTime | ISO 8601 timestamp indicating when this payment instrument was last set as preferred. Populated from ADS. | |
**Example**
2024-03-15T10:30:00Z
#### ExternalConsumerIDOwnerBID Schema
Visa Business Identifier (BID) of the entity to which an External Consumer ID belongs.
This field is optional for clients integrated prior to 3rd April 2025. Required for all other clients.
Questions should be directed to your Visa Integration Specialist.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ExternalConsumerIDOwnerBID | string | Visa Business Identifier (BID) of the entity to which an External Consumer ID belongs. This field is optional for clients integrated prior to 3rd April 2025. Required for all other clients. Questions should be directed to your Visa Integration Specialist. | |
**Example**
10098765
#### PaymentInstrumentCard-1 Schema
Type of payment instrument
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PaymentInstrumentCard-1 | string,
**Available values:** "CARD", "NON-VISA CARD" | Type of payment instrument | |
**Example**
CARD
#### PaymentInstrumentCard-2 Schema
Type of payment instrument
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PaymentInstrumentCard-2 | string,
**Available values:** "CARD" | Type of payment instrument | |
**Example**
CARD
#### Locale Schema
Language and country in which the product communicates with the consumer
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Locale | string (iso-639-1) | Language and country in which the product communicates with the consumer | |
**Example**
en_US
#### AliasInquiryItem-2 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| aliasType | string,
**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 | [ { **"entities"**: [ { **"id"**: , **"preferredFor"**: [ { **"date"**: undefined (date-time), **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } ], **"directoryName"**: } ] | List of directories and entities where the Alias is found | No |
| directoriesName | [ ] | The name of the directory
*Example:* `["Directory A","Directory B"]` | No |
#### Email Schema
Consumer's email address
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Email | string | Consumer's email address | |
**Example**
alex123@hotmail.com
#### PaymentCredentialPreferredForWithDateList-1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| preferredFor | [ { **"date"**: undefined (date-time), **"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 |
#### 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
#### DeleteCardPaymentInstrument Schema
Payment credentials to be deleted
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string,
**Available values:** "CARD", "NON-VISA-CARD" | Type of payment instrument
*Enum:* `"CARD"`, `"NON-VISA-CARD"`
*Example:* `"CARD"` | Yes |
| accountNumber | string | Primary account number of the card
*Example:* `"4111111145551140"` | Yes |
#### GetBankAccountPaymentInstrument Schema
Payment credentials details to be linked
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string,
**Available values:** "BANK_ACCOUNT" | Type of payment instrument
*Enum:* `"BANK_ACCOUNT"`
*Example:* `"BANK_ACCOUNT"` | Yes |
| status | string,
**Available values:** "ACTIVE", "DISABLED" | Manage Consumer Status
*Enum:* `"ACTIVE"`, `"DISABLED"`
*Example:* `"ACTIVE"` | No |
| address | { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string } | Billing Address details | No |
| bankCode | string | Bank account bank code, conditional for select markets
*Example:* `"173"` | No |
| bankName | string | Bank name of the payment credential
*Example:* `"Bank A"` | No |
| branchCode | string | Bank account branch code, conditional for select markets
*Example:* `"123456"` | No |
| accountName | string | Bank account name, i.e., account holder name as recorded on the bank account
*Example:* `"Alex Miller"` | Yes |
| accountType | string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN" | Bank account type
*Enum:* `"CHECKING"`, `"SAVING"`, `"MAESTRA"`, `"VISTA"`, `"LOAN"`
*Example:* `"CHECKING"` | No |
| countryCode | string (ISO 3166-1-alpha3) | Country code using 3-character ISO 3166 (Alpha 3) format
*Example:* `"USA"` | Yes |
| bankCodeType | string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT" | Bank account bank code type, conditional for select markets
*Enum:* `"ABA"`, `"SORT_CODE"`, `"DEFAULT"`
*Example:* `"DEFAULT"` | No |
| currencyCode | string | Bank account currency code. Format: 3-character ISO-4217 (Alpha-3) currency code
*Example:* `"USD"` | Yes |
| preferredFor | [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ] | Consumer's preferred use(s) for this payment instrument
*Example:* `[{"type":"SEND"},{"type":"RECEIVE"}]` | No |
| accountNumber | string | Bank account number
*Example:* `"1001001234"` | Yes |
| accountNumberType | string,
**Available values:** "IBAN", "DEFAULT" | Bank account number type. Valid values 'IBAN', 'DEFAULT'. If the IBAN format is not supported in a country, use DEFAULT.
*Enum:* `"IBAN"`, `"DEFAULT"`
*Example:* `"DEFAULT"` | Yes |
| bankIdentifierCode | string | Bank account Business Identifier Code (BIC), conditional for select markets
*Example:* `"AAAABBCC123"` | No |
| preferredTimestamp | dateTime | ISO 8601 timestamp indicating when this payment instrument was last set as preferred. Populated from ADS.
*Example:* `"2024-03-15T10:30:00Z"` | No |
#### 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 |
#### Phones Schema
Consumer's phone number according to ITU-T E.164 (2010) number structure. Do not use the "+" symbol.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Phones | [ string ] | Consumer's phone number according to ITU-T E.164 (2010) number structure. Do not use the "+" symbol. | |
#### PreferredFor Schema
Consumer's preferred use(s) for this payment instrument
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PreferredFor | [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ] | Consumer's preferred use(s) for this payment instrument | |
**Example**
[
{
"type": "SEND"
},
{
"type": "RECEIVE"
}
]
#### BankName-1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| BankName-1 | | | |
**Example**
Bank A
#### ConsumerInformation Schema
Consumer details
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| emails | [ string ] | Consumer's email address | No |
| locale | string (iso-639-1) | Language and country in which the product communicates with the consumer
*Example:* `"en_US"` | No |
| phones | [ string ] | Consumer's phone number according to ITU-T E.164 (2010) number structure. Do not use the "+" symbol. | No |
| consent | { **"version"**: string, **"presenter"**: string, **"timeOfConsent"**: string } | Consent details | No |
| fullName | string | Consumer's full name
*Example:* `"Alex Miller"` | No |
| lastName | string | Consumer's last name
*Example:* `"Miller"` | Yes |
| firstName | string | Consumer's first name
*Example:* `"Alex"` | Yes |
| middleName | string | Consumer's middle name
*Example:* `"Robert"` | No |
| countryCode | string (ISO 3166-1-alpha3) | Country code using 3-character ISO 3166 (Alpha 3) format
*Example:* `"USA"` | Yes |
| dateOfBirth | date | | No |
| preferredname | string | Consumer's preferred name
*Example:* `"Alex"` | No |
| externalConsumerID | string (uuid) | Client-provided unique identifier of a consumer
*Example:* `"63421837-d597-4f0f-89e4-930c1a7b9e85"` | Yes |
| nationalIdentifiers | [ { **"type"**: string,
**Available values:** "PASSPORT", "DRIVING_LICENSE", "NATIONAL_IDENTITY", **"value"**: string } ] | National identifier for the consumer | No |
| externalConsumerIDOwnerBID | string | Visa Business Identifier (BID) of the entity to which an External Consumer ID belongs. This field is optional for clients integrated prior to 3rd April 2025. Required for all other clients. Questions should be directed to your Visa Integration Specialist.
*Example:* `"10098765"` | No |
#### ClientId Schema
UUID String describing a particular client that this request is in relation to
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ClientId | string (uuid) | UUID String describing a particular client that this request is in relation to | |
#### PaymentCredentialItemAliasConfirmResponsePath-1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PaymentCredentialItemAliasConfirmResponsePath-1 | { **"type"**: , **"issuerName"**: } or { **"type"**: , **"bankName"**: } | | |
#### Emails Schema
Consumer's email address
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Emails | [ string ] | Consumer's email address | |
#### AliasInquiryEntityDetail-2 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| entities | [ { **"id"**: , **"preferredFor"**: [ { **"date"**: undefined (date-time), **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } ] | A list of entities | No |
| directoryName | | The name of the directory
*Example:* `"Directory A"` | No |
#### ConsumerInformationIdRef Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| externalConsumerID | string (uuid) | Client-provided unique identifier of a consumer
*Example:* `"63421837-d597-4f0f-89e4-930c1a7b9e85"` | Yes |
| externalConsumerIDOwnerBID | string | Visa Business Identifier (BID) of the entity to which an External Consumer ID belongs. This field is optional for clients integrated prior to 3rd April 2025. Required for all other clients. Questions should be directed to your Visa Integration Specialist.
*Example:* `"10098765"` | No |
#### ValidationResult-1 Schema
Validation result for identity verification.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string,
**Available values:** "MATCH", "NO_MATCH", "NOT_PROVIDED" | Result of the identity validation.
*Enum:* `"MATCH"`, `"NO_MATCH"`, `"NOT_PROVIDED"` | 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 |
#### 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 |
#### PaymentInstrumentBankAccount Schema
Type of payment instrument
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PaymentInstrumentBankAccount | string,
**Available values:** "BANK_ACCOUNT" | Type of payment instrument | |
**Example**
BANK_ACCOUNT
#### 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 |
#### Value-1 Schema
Product name for which the request is intended
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Value-1 | string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "VISA_PROTECT_A2A" | Product name for which the request is intended | |
#### Value Schema
Product name for which the request is intended
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Value | string,
**Available values:** "CLICK_TO_PAY" | Product name for which the request is intended | |
#### Intent-1 Schema
Indicates the target product
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string,
**Available values:** "PRODUCT_CODE" | Indicates the type of the intent
*Enum:* `"PRODUCT_CODE"` | Yes |
| value | string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "VISA_PROTECT_A2A" | Product name for which the request is intended
*Enum:* `"CLICK_TO_PAY"`, `"ADDRESS_VERIFICATION_SERVICE"`, `"VISA_PROTECT_A2A"` | Yes |
**Example**
{
"type": "PRODUCT_CODE",
"value": "CLICK_TO_PAY"
}
#### LastName Schema
Consumer's last name
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| LastName | string | Consumer's last name | |
**Example**
Miller
#### ExternalConsumerID Schema
Client-provided unique identifier of a consumer
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| ExternalConsumerID | string (uuid) | Client-provided unique identifier of a consumer | |
**Example**
63421837-d597-4f0f-89e4-930c1a7b9e85
#### BranchCode Schema
Bank account branch code, conditional for select markets
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| BranchCode | string | Bank account branch code, conditional for select markets | |
**Example**
123456
#### BankAccountNumber Schema
Bank account number
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| BankAccountNumber | string | Bank account number | |
**Example**
1001001234
#### 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 | string,
**Available values:** "RECEIVE", "SEND", "PAY" | Type of preference
*Enum:* `"RECEIVE"`, `"SEND"`, `"PAY"` | Yes |
#### Phones-1 Schema
Consumer's phone numbers
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Phones-1 | [ string ] | Consumer's phone numbers | |
#### AliasConfirmBasicResponse-2 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"**: string,
**Available values:** "MATCH", "NO_MATCH", "NOT_PROVIDED" } } | Additional information returned in the confirm response. | No |
| paymentCredentials | [ { **"type"**: , **"issuerName"**: } or { **"type"**: , **"bankName"**: } ] | List of payment credentials linked to an Alias | Yes |
#### AccountNumberType Schema
Bank account number type. Valid values 'IBAN', 'DEFAULT'. If the IBAN format is not supported in a country, use DEFAULT.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AccountNumberType | string,
**Available values:** "IBAN", "DEFAULT" | Bank account number type. Valid values 'IBAN', 'DEFAULT'. If the IBAN format is not supported in a country, use DEFAULT. | |
**Example**
DEFAULT
#### AliasInquiryRequest-2 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| aliases | [ ] | 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"**: [ ] } ] | List of the filter to apply in the request | No |
| userDetails | { **"userName"**: } | | No |
| transactionDetails | { **"currencyCode"**: } | | No |
#### AliasConfirmRequest-5 Schema
Alias information to confirm the identity of the Alias owner
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| filters | [ { **"field"**: string,
**Available values:** "DIRECTORY_NAME", "EXCLUDED_DIRECTORY_NAME", "ENTITY_ID", **"value"**: [ ] } ] | List of the filter to apply in the request | No |
| aliasType | string,
**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 |
#### AliasResolveBasicResponse-2 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| profile | { **"lastName"**: , **"firstName"**: , **"middleName"**: , **"contactInfo"**: [ { **"type"**: string,
**Available values:** "EMAIL", "PHONE", "DIRECTORY_ALIASID", **"value"**: } ], **"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 | [ { **"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"**: string,
**Available values:** "NIUBIZ", "TOKEN", "PAN" } & { **"modifiedOn"**: undefined (date-time) } & { **"preferredFor"**: [ { **"date"**: undefined (date-time), **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } 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"**: string,
**Available values:** "CHECKING", "SAVING", **"countryCode"**: undefined (We recommend to use the Alpha-3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: , **"accountNumber"**: , **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", "TOKEN", "CCI" } & { **"modifiedOn"**: undefined (date-time) } & { **"preferredFor"**: [ { **"date"**: undefined (date-time), **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } ] | List of payment credentials linked to an Alias | Yes |
#### GetDataPaymentInstrumentList-1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| GetDataPaymentInstrumentList-1 | [ { **"type"**: string,
**Available values:** "CARD", **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"cardType"**: string, **"issuerName"**: string, **"nameOnCard"**: string, **"tokenDetails"**: { **"tokenReferenceID"**: string, **"tokenRequestorID"**: string }, **"accountNumber"**: string, **"billingAddress"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"expirationDate"**: string (ISO 8601), **"panReferenceID"**: string, **"paymentAccountReference"**: string } or { **"type"**: string,
**Available values:** "BANK_ACCOUNT", **"status"**: string,
**Available values:** "ACTIVE", "DISABLED", **"address"**: { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string }, **"bankCode"**: string, **"bankName"**: string, **"branchCode"**: string, **"accountName"**: string, **"accountType"**: string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN", **"countryCode"**: string (ISO 3166-1-alpha3), **"bankCodeType"**: string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT", **"currencyCode"**: string, **"accountNumber"**: string, **"accountNumberType"**: string,
**Available values:** "IBAN", "DEFAULT", **"bankIdentifierCode"**: string } ] | | |
#### AliasInquiryDetails-2 Schema
Alias information associated with found records
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AliasInquiryDetails-2 | [ { **"aliasType"**: string,
**Available values:** "PHONE", "EMAIL", "DIRECTORY_ALIASID", "PAYNAME", "NATIVE_ALIAS", "NATIONAL_ID", **"aliasValue"**: , **"directories"**: [ { **"entities"**: [ { **"id"**: , **"preferredFor"**: [ { **"date"**: undefined (date-time), **"type"**: string,
**Available values:** "RECEIVE", "SEND", "PAY" } ] } ], **"directoryName"**: } ], **"directoriesName"**: [ ] } ] | Alias information associated with found records | |
#### IssuerName Schema
Name of the issuer of the card
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| IssuerName | string | Name of the issuer of the card | |
**Example**
Bank A
#### BankIdentifierCode Schema
Bank account Business Identifier Code (BIC), conditional for select markets
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| BankIdentifierCode | string | Bank account Business Identifier Code (BIC), conditional for select markets | |
**Example**
AAAABBCC123
#### Phone Schema
Consumer's phone number according to ITU-T E.164 (2010) number structure. Do not use the "+" symbol.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| Phone | string | Consumer's phone number according to ITU-T E.164 (2010) number structure. Do not use the "+" symbol. | |
**Example**
16504005555
#### CardType Schema
Card type description. Reference to Field 62.23—Product ID of available card products
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CardType | string | Card type description. Reference to Field 62.23—Product ID of available card products | |
**Example**
Visa Platinum
#### PaymentInstrumentCard Schema
Type of payment instrument
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PaymentInstrumentCard | string,
**Available values:** "CARD", "NON-VISA-CARD" | Type of payment instrument | |
**Example**
CARD
#### RequestStatusDetails Schema
Status details of submitted request
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| status | string,
**Available values:** "IN_PROGRESS", "COMPLETED" | Current status of the request
*Enum:* `"IN_PROGRESS"`, `"COMPLETED"` | Yes |
| details | [ { **"intent"**: { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY", "ADDRESS_VERIFICATION_SERVICE", "VISA_PROTECT_A2A" }, **"status"**: string,
**Available values:** "SUCCESS", "FAILED", **"errorDetails"**: [ { **"field"**: string, **"reason"**: string, **"message"**: string } ] } ] | | No |
| consumerInformation | { **"externalConsumerID"**: string (uuid), **"externalConsumerIDOwnerBID"**: string } | | No |
#### PreferredName Schema
Consumer's preferred name
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PreferredName | string | Consumer's preferred name | |
**Example**
Alex
#### CountryCode Schema
Country code using 3-character ISO 3166 (Alpha 3) format
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CountryCode | string (ISO 3166-1-alpha3) | Country code using 3-character ISO 3166 (Alpha 3) format | |
**Example**
USA
#### 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
#### LegacyIntentStatusItem Schema
Backward-compatible intent item used in IntentLegacy variants of request status and async notification. errorDetails uses the legacy StatusErrorDetails array.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| intent | { **"type"**: string,
**Available values:** "PRODUCT_CODE", **"value"**: string,
**Available values:** "CLICK_TO_PAY" } | Indicates the target product
*Example:* `{"type":"PRODUCT_CODE","value":"CLICK_TO_PAY"}` | Yes |
| status | string,
**Available values:** "SUCCESS", "FAILED" | Terminal status of the Click to Pay product
*Enum:* `"SUCCESS"`, `"FAILED"` | Yes |
| errorDetails | [ { **"field"**: string, **"reason"**: string, **"message"**: string } ] | Error details for each field | No |
#### GetBankAccountPaymentInstrument-1 Schema
Payment credentials details to be linked
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string,
**Available values:** "BANK_ACCOUNT" | Type of payment instrument
*Enum:* `"BANK_ACCOUNT"`
*Example:* `"BANK_ACCOUNT"` | Yes |
| status | string,
**Available values:** "ACTIVE", "DISABLED" | Manage Consumer Status
*Enum:* `"ACTIVE"`, `"DISABLED"`
*Example:* `"ACTIVE"` | No |
| address | { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string } | Billing Address details | No |
| bankCode | string | Bank account bank code, conditional for select markets
*Example:* `"173"` | No |
| bankName | string | Bank name of the payment credential
*Example:* `"Bank A"` | No |
| branchCode | string | Bank account branch code, conditional for select markets
*Example:* `"123456"` | No |
| accountName | string | Bank account name, i.e., account holder name as recorded on the bank account
*Example:* `"Alex Miller"` | Yes |
| accountType | string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN" | Bank account type
*Enum:* `"CHECKING"`, `"SAVING"`, `"MAESTRA"`, `"VISTA"`, `"LOAN"`
*Example:* `"CHECKING"` | No |
| countryCode | string (ISO 3166-1-alpha3) | Country code using 3-character ISO 3166 (Alpha 3) format
*Example:* `"USA"` | Yes |
| bankCodeType | string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT" | Bank account bank code type, conditional for select markets
*Enum:* `"ABA"`, `"SORT_CODE"`, `"DEFAULT"`
*Example:* `"DEFAULT"` | No |
| currencyCode | string | Bank account currency code. Format: 3-character ISO-4217 (Alpha-3) currency code
*Example:* `"USD"` | Yes |
| accountNumber | string | Bank account number
*Example:* `"1001001234"` | Yes |
| accountNumberType | string,
**Available values:** "IBAN", "DEFAULT" | Bank account number type. Valid values 'IBAN', 'DEFAULT'. If the IBAN format is not supported in a country, use DEFAULT.
*Enum:* `"IBAN"`, `"DEFAULT"`
*Example:* `"DEFAULT"` | Yes |
| bankIdentifierCode | string | Bank account Business Identifier Code (BIC), conditional for select markets
*Example:* `"AAAABBCC123"` | No |
#### fullName Schema
Consumer's full name
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| fullName | string | Consumer's full name | |
**Example**
Alex Miller
#### Address-2 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 |
#### MiddleName Schema
Consumer's middle name
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| MiddleName | string | Consumer's middle name | |
**Example**
Robert
#### StatusErrorDetails Schema
Error details for each field
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| StatusErrorDetails | [ { **"field"**: string, **"reason"**: string, **"message"**: string } ] | Error details for each field | |
#### PaymentInstrumentReferenceType-1 Schema
Type of identifier provided in paymentInstrumentRef. Valid values 'PAYMENT_ACCOUNT_REFERENCE'. Future releases will add additional reference types.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| PaymentInstrumentReferenceType-1 | string,
**Available values:** "PAYMENT_ACCOUNT_REFERENCE" | Type of identifier provided in paymentInstrumentRef. Valid values 'PAYMENT_ACCOUNT_REFERENCE'. Future releases will add additional reference types. | |
**Example**
PAYMENT_ACCOUNT_REFERENCE
#### intent Schema
Indicates the target product
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string,
**Available values:** "PRODUCT_CODE" | Indicates the type of the intent
*Enum:* `"PRODUCT_CODE"` | Yes |
| value | string,
**Available values:** "CLICK_TO_PAY" | Product name for which the request is intended
*Enum:* `"CLICK_TO_PAY"` | Yes |
**Example**
{
"type": "PRODUCT_CODE",
"value": "CLICK_TO_PAY"
}
#### AccountType Schema
Bank account type
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AccountType | string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN" | Bank account type | |
**Example**
CHECKING
#### CardAccountNumber Schema
Primary account number of the card
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| CardAccountNumber | string | Primary account number of the card | |
**Example**
4111111145551140
#### AlphaCurrencyCode-1 Schema
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| AlphaCurrencyCode-1 | | | |
**Example**
USD
#### GetCardPaymentInstrument-1 Schema
Payment credentials details to be linked
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string,
**Available values:** "CARD" | Type of payment instrument
*Enum:* `"CARD"`
*Example:* `"CARD"` | Yes |
| status | string,
**Available values:** "ACTIVE", "DISABLED" | Manage Consumer Status
*Enum:* `"ACTIVE"`, `"DISABLED"`
*Example:* `"ACTIVE"` | No |
| cardType | string | Card type description. Reference to Field 62.23—Product ID of available card products
*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
*Example:* `"John Doe"` | Yes |
| tokenDetails | { **"tokenReferenceID"**: string, **"tokenRequestorID"**: string } | Token details | No |
| accountNumber | string | Primary account number of the card
*Example:* `"4111111145551140"` | Yes |
| billingAddress | { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string } | Billing Address details | Yes |
| expirationDate | string (ISO 8601) | Expiration date of the card
*Example:* `"2030-01"` | Yes |
| panReferenceID | string | Unique identifier for the card | No |
| paymentAccountReference | string | Unique payment account reference for the card | No |
#### CardPaymentInstrument-2 Schema
Payment credentials details to be linked
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string,
**Available values:** "CARD" | Type of payment instrument
*Enum:* `"CARD"`
*Example:* `"CARD"` | Yes |
| cardType | string | Card type description. Reference to Field 62.23—Product ID of available card products
*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
*Example:* `"John Doe"` | Yes |
| accountNumber | string | Primary account number of the card
*Example:* `"4111111145551140"` | Yes |
| billingAddress | { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string } | Billing Address details | Yes |
| expirationDate | string (ISO 8601) | Expiration date of the card
*Example:* `"2030-01"` | Yes |
#### CardPaymentInstrument-1 Schema
Payment credentials details to be linked
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string,
**Available values:** "CARD", "NON-VISA CARD" | Type of payment instrument
*Enum:* `"CARD"`, `"NON-VISA CARD"`
*Example:* `"CARD"` | Yes |
| cardType | string | Card type description. Reference to Field 62.23—Product ID of available card products
*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
*Example:* `"John Doe"` | Yes |
| currencyCode | string | Bank account currency code. Format: 3-character ISO-4217 (Alpha-3) currency code
*Example:* `"USD"` | No |
| preferredFor | [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ] | Consumer's preferred use(s) for this payment instrument
*Example:* `[{"type":"SEND"},{"type":"RECEIVE"}]` | No |
| accountNumber | string | Primary account number of the card
*Example:* `"4111111145551140"` | Yes |
| billingAddress | { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string } | Billing Address details | Yes |
| expirationDate | string (ISO 8601) | Expiration date of the card
*Example:* `"2030-01"` | Yes |
| AFAuthentication | boolean | Attests that the issuer has completed an Additional Factor of Authentication (AFA) with the consumer prior to enrollment, as required by RBI for India-market issuers. - `true` — AFA was successfully completed before this enrollment - `false` — AFA was not completed - absent — silently accepted (default for non-India issuers) Only boolean values are accepted. Null and non-boolean values are rejected with HTTP 400. | No |
| paymentInstrumentConsent | boolean | Attests that the issuer has obtained explicit consumer consent for card tokenization, as required by the Reserve Bank of India (RBI) for India-market issuers enrolling payment credentials. - `true` — consent was explicitly received before this enrollment - `false` — consent was explicitly not received - absent — silently accepted (default for non-India issuers) Only boolean values are accepted. Null and non-boolean values (e.g. strings, numbers) are rejected with HTTP 400. VICA is not the system of record; value is forwarded to CTP in the encrypted Kafka payload. | No |
#### BankCodeType Schema
Bank account bank code type, conditional for select markets
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| BankCodeType | string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT" | Bank account bank code type, conditional for select markets | |
**Example**
DEFAULT
#### BankAccountPaymentInstrument-1 Schema
Payment credentials details to be linked
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string,
**Available values:** "BANK_ACCOUNT" | Type of payment instrument
*Enum:* `"BANK_ACCOUNT"`
*Example:* `"BANK_ACCOUNT"` | Yes |
| address | { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string } | Billing Address details | No |
| bankCode | string | Bank account bank code, conditional for select markets
*Example:* `"173"` | No |
| bankName | string | Bank name of the payment credential
*Example:* `"Bank A"` | No |
| branchCode | string | Bank account branch code, conditional for select markets
*Example:* `"123456"` | No |
| accountName | string | Bank account name, i.e., account holder name as recorded on the bank account
*Example:* `"Alex Miller"` | Yes |
| accountType | string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN" | Bank account type
*Enum:* `"CHECKING"`, `"SAVING"`, `"MAESTRA"`, `"VISTA"`, `"LOAN"`
*Example:* `"CHECKING"` | No |
| countryCode | string (ISO 3166-1-alpha3) | Country code using 3-character ISO 3166 (Alpha 3) format
*Example:* `"USA"` | Yes |
| bankCodeType | string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT" | Bank account bank code type, conditional for select markets
*Enum:* `"ABA"`, `"SORT_CODE"`, `"DEFAULT"`
*Example:* `"DEFAULT"` | No |
| currencyCode | string | Bank account currency code. Format: 3-character ISO-4217 (Alpha-3) currency code
*Example:* `"USD"` | Yes |
| preferredFor | [ { **"type"**: string,
**Available values:** "SEND", "RECEIVE", "PAY" } ] | Consumer's preferred use(s) for this payment instrument
*Example:* `[{"type":"SEND"},{"type":"RECEIVE"}]` | No |
| accountNumber | string | Bank account number
*Example:* `"1001001234"` | Yes |
| accountNumberType | string,
**Available values:** "IBAN", "DEFAULT" | Bank account number type. Valid values 'IBAN', 'DEFAULT'. If the IBAN format is not supported in a country, use DEFAULT.
*Enum:* `"IBAN"`, `"DEFAULT"`
*Example:* `"DEFAULT"` | Yes |
| bankIdentifierCode | string | Bank account Business Identifier Code (BIC), conditional for select markets
*Example:* `"AAAABBCC123"` | No |
#### BankAccountPaymentInstrument-2 Schema
Payment credentials details to be linked
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| type | string,
**Available values:** "BANK_ACCOUNT" | Type of payment instrument
*Enum:* `"BANK_ACCOUNT"`
*Example:* `"BANK_ACCOUNT"` | Yes |
| address | { **"city"**: string, **"state"**: string (ISO 3166-2), **"country"**: string (ISO 3166-1-alpha3), **"postalCode"**: string, **"addressLine1"**: string, **"addressLine2"**: string, **"addressLine3"**: string } | Billing Address details | No |
| bankCode | string | Bank account bank code, conditional for select markets
*Example:* `"173"` | No |
| bankName | string | Bank name of the payment credential
*Example:* `"Bank A"` | No |
| branchCode | string | Bank account branch code, conditional for select markets
*Example:* `"123456"` | No |
| accountName | string | Bank account name, i.e., account holder name as recorded on the bank account
*Example:* `"Alex Miller"` | Yes |
| accountType | string,
**Available values:** "CHECKING", "SAVING", "MAESTRA", "VISTA", "LOAN" | Bank account type
*Enum:* `"CHECKING"`, `"SAVING"`, `"MAESTRA"`, `"VISTA"`, `"LOAN"`
*Example:* `"CHECKING"` | No |
| countryCode | string (ISO 3166-1-alpha3) | Country code using 3-character ISO 3166 (Alpha 3) format
*Example:* `"USA"` | Yes |
| bankCodeType | string,
**Available values:** "ABA", "SORT_CODE", "DEFAULT" | Bank account bank code type, conditional for select markets
*Enum:* `"ABA"`, `"SORT_CODE"`, `"DEFAULT"`
*Example:* `"DEFAULT"` | No |
| currencyCode | string | Bank account currency code. Format: 3-character ISO-4217 (Alpha-3) currency code
*Example:* `"USD"` | Yes |
| accountNumber | string | Bank account number
*Example:* `"1001001234"` | Yes |
| accountNumberType | string,
**Available values:** "IBAN", "DEFAULT" | Bank account number type. Valid values 'IBAN', 'DEFAULT'. If the IBAN format is not supported in a country, use DEFAULT.
*Enum:* `"IBAN"`, `"DEFAULT"`
*Example:* `"DEFAULT"` | Yes |
| bankIdentifierCode | string | Bank account Business Identifier Code (BIC), conditional for select markets
*Example:* `"AAAABBCC123"` | No |
#### 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 |