Get Payment Credential - Field Descriptions

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

Response for cardType

FieldDescription
status
response

trackingIdThe UUID generated by Thredd which identifies each transaction.
response

paymentCredentialsAll

idThe UUID generated by Alias Directory which identifies the payment credential.
nameOnCardThe name that appears on the card.
issuerNameThe name of the issuer of the card.
cardTypeThe card type description. For example, Visa Platinum.
accountNumberThe primary account number of the card.
expirationDateThe expiration date for the card. Format is YYYY-MM.
currencyCodeThe recipient card currency code. The format is the 3-character ISO-4217 (Alpha-3) currency code.
billingAddress

countryThe country code of the billing address. Uses the 3-character ISO 3166 (Alpha 3) format.
streetNameThe street name of the billing address.
cityThe city of the billing address.
postalCodeThe post code of the billing address.
addressLine1The first line of the billing address.
buildingNumberThe building number of the billing address.
addressLine2The second line of the billing address.
stateThe state of the billing address.
minorSubdivisionCodeThe minor subdivision code of the billing address.
billingAddress

preferredFor

typeIndicates if a payment credential is a preferred Receiving, Sending, or Paying account.
date
preferredFor

cardInfoAll

accountNumberTypeThe bank account number type. For example, IBAN.
lastFourDigits
status
createdOnWhen the payment credential was created.
lastUpdatedOnWhen the payment credential was last updated.
typeThe payment credential type.
externalId
paymentCredentialsAll

bankInfoAll

id
accountNameThe bank account name. For example, the account holder name as recorded on the bank account.
accountNumberThe primary account number of the card.
accountNumberTypeThe bank account number type. For example, IBAN.
accountTypeThe bank account type. For example, Checking or Saving.
bankNameThe bank name of the payment credential.
bankCodeThe bank account bank code.
bankCodeTypeThe bank account bank code type. This is conditional for select markets.
bicThe bank account's Business Identifier Code (BIC).
countryCodeThe bank account's country code.
currencyCodeThe recipient card's currency code. The format is a 3-character ISO-4217 (Alpha-3) currency code.
referenceId
branchCodeThe bank account branch code.
address

countryThe country code of the address. Uses the 3-character ISO 3166 (Alpha 3) format.
streetNameThe street name of the address.
cityThe city of the address.
postalCodeThe post code of the address.
addressLine1The first line of the address.
addressLine2The second line of the address.
buildingNumberThe building number of the address.
stateThe state of the address.
minorSubdivisionCodeThe minor subdivision code of the address.
address

typeThe payment credential type.
status
createdOnThe date the credential was created.
lastUpdatedOnWhen the credential was last updated.
preferredFor

typeIndicates if a payment credential is a preferred Receiving, Sending, or Paying account.
date
preferredFor

bankInfoAll

Response for bankType


FieldDescription
status
response

trackingIdThe UUID generated by Thredd which identifies each transaction.
paymentCredentials

idThe UUID generated by Alias Directory which identifies the payment credential.
accountNameThe bank account name. For example, the account holder name as recorded on the bank account.
typeThe payment credential type.
accountNumberTypeThe bank account number type. For example, IBAN.
accountNumberThe primary account number of the card.
address

countryThe country code of the address. Uses the 3-character ISO 3166 (Alpha 3) format.
streetNameThe street name of the address.
cityThe city of the address.
postalCodeThe post code of the address.
addressLine1The first line of the address.
addressLine2The second line of the address.
buildingNumberThe building number of the address.
stateThe state of the address.
minorSubdivisionCodeThe minor subdivision code of the address.
address

expirationDate
lastFourDigits
externalId
preferredFor

typeIndicates if a payment credential is a preferred Receiving, Sending, or Paying account.
date
preferredFor

bankNameThe bank name of the payment credential.
countryCodeThe bank account's country code.
currencyCodeThe recipient card's currency code. The format is a 3-character ISO-4217 (Alpha-3) currency code.
status
createdOnThe date the credential was created.
lastUpdatedOnWhen the credential was last updated.
paymentCredentials