Get Payment Credential - Field Descriptions

The following table describes the fields in the response for the Get Payment Credential endpoint.

Response for cardType

Field	Description
status
response
trackingId	The UUID generated by Thredd which identifies each transaction.
response
paymentCredentialsAll
id	The UUID generated by Alias Directory which identifies the payment credential.
nameOnCard	The name that appears on the card.
issuerName	The name of the issuer of the card.
cardType	The card type description. For example, Visa Platinum.
accountNumber	The primary account number of the card.
expirationDate	The expiration date for the card. Format is YYYY-MM.
currencyCode	The recipient card currency code. The format is the 3-character ISO-4217 (Alpha-3) currency code.
billingAddress
country	The country code of the billing address. Uses the 3-character ISO 3166 (Alpha 3) format.
streetName	The street name of the billing address.
city	The city of the billing address.
postalCode	The post code of the billing address.
addressLine1	The first line of the billing address.
buildingNumber	The building number of the billing address.
addressLine2	The second line of the billing address.
state	The state of the billing address.
minorSubdivisionCode	The minor subdivision code of the billing address.
billingAddress
preferredFor
type	Indicates if a payment credential is a preferred Receiving, Sending, or Paying account.
date
preferredFor
cardInfoAll
accountNumberType	The bank account number type. For example, IBAN.
lastFourDigits
status
createdOn	When the payment credential was created.
lastUpdatedOn	When the payment credential was last updated.
type	The payment credential type.
externalId
paymentCredentialsAll
bankInfoAll
id
accountName	The bank account name. For example, the account holder name as recorded on the bank account.
accountNumber	The primary account number of the card.
accountNumberType	The bank account number type. For example, IBAN.
accountType	The bank account type. For example, Checking or Saving.
bankName	The bank name of the payment credential.
bankCode	The bank account bank code.
bankCodeType	The bank account bank code type. This is conditional for select markets.
bic	The bank account's Business Identifier Code (BIC).
countryCode	The bank account's country code.
currencyCode	The recipient card's currency code. The format is a 3-character ISO-4217 (Alpha-3) currency code.
referenceId
branchCode	The bank account branch code.
address
country	The country code of the address. Uses the 3-character ISO 3166 (Alpha 3) format.
streetName	The street name of the address.
city	The city of the address.
postalCode	The post code of the address.
addressLine1	The first line of the address.
addressLine2	The second line of the address.
buildingNumber	The building number of the address.
state	The state of the address.
minorSubdivisionCode	The minor subdivision code of the address.
address
type	The payment credential type.
status
createdOn	The date the credential was created.
lastUpdatedOn	When the credential was last updated.
preferredFor
type	Indicates if a payment credential is a preferred Receiving, Sending, or Paying account.
date
preferredFor
bankInfoAll

Response for bankType

Field	Description
status
response
trackingId	The UUID generated by Thredd which identifies each transaction.
paymentCredentials
id	The UUID generated by Alias Directory which identifies the payment credential.
accountName	The bank account name. For example, the account holder name as recorded on the bank account.
type	The payment credential type.
accountNumberType	The bank account number type. For example, IBAN.
accountNumber	The primary account number of the card.
address
country	The country code of the address. Uses the 3-character ISO 3166 (Alpha 3) format.
streetName	The street name of the address.
city	The city of the address.
postalCode	The post code of the address.
addressLine1	The first line of the address.
addressLine2	The second line of the address.
buildingNumber	The building number of the address.
state	The state of the address.
minorSubdivisionCode	The minor subdivision code of the address.
address
expirationDate
lastFourDigits
externalId
preferredFor
type	Indicates if a payment credential is a preferred Receiving, Sending, or Paying account.
date
preferredFor
bankName	The bank name of the payment credential.
countryCode	The bank account's country code.
currencyCode	The recipient card's currency code. The format is a 3-character ISO-4217 (Alpha-3) currency code.
status
createdOn	The date the credential was created.
lastUpdatedOn	When the credential was last updated.
paymentCredentials