Create Payment Credential - Field Descriptions

The following tables describe the fields in the request and the response for the Create Payment Credential endpoint.

Request

The following table describes the fields that can be included in the request.

Field	Description	Type	Mandatory
paymentType	The payment credential type. Select from CARD, BANK, CARDANDBANK, THREDDTOKEN	AN	Yes
paymentInfo	Object that details the payment information.		Yes
cardInfo	Object that is present if the payment type is CARD or CARDANDBANK.		Yes
bankInfo	Object that is present if the payment type is BANK or CARDANDBANK.
threddInfo	Object that is present if the payment type is THREDDTOKEN.

cardInfo Fields

The following table describes the fields in the paymentInfo object when cardInfo object is selected.

Field	Description	Type	Min Length	Max Length	Mandatory
nameOnCard	The name that appears on the card.	AN	1	120	Yes
issuerName	The name of the issuer of the card.	AN	1	150	Yes
cardType	The card type description. For example, Visa Platinum.	AN	1	70	Yes
accountNumber	The primary account number of the card	AN	12	19	Yes
expirationDate	The expiration date for the card. Format is YYYY-MM.	AN	7	7	Yes
externalId	The client-provided identifier for the payment credential.	AN	1	100	No
currencyCode	The recipient card currency code. The format is the 3-character ISO-4217 (Alpha-3) currency code.	AN	3	3	No
preferredFor	Indicates if a payment credential is a preferred Receiving, Sending, or Paying account.	Array			No
billingAddress	Object that contains the billing address details.	Object			Yes
country	The country code of the billing address. Uses the 3-character ISO 3166 (Alpha 3) format.	AN	3	3	Yes
streetName	The street name of the billing address	AN	1	60	No
City	The city of the billing address.	AN	1	35	No
postalCode	The post code of the billing address.	AN	1	16	No
AddressLine1	The first line of the billing address.	AN	0	99	No
buildingNumber	The building number of the billing address.	AN	1	60	No
AddressLine2	The second line of the billing address.	AN	0	99	No
State	The state of the billing address.	AN	1	16	No
minorSubdivisionCode	The minor subdivision code of the billing address.	AN	1	50	No
billingAddress

bankInfo Fields

The following table describes the fields in the paymentInfo object when bankInfo object is selected.

Field	Description	Type	Min Length	Max Length	Mandatory
accountName	The bank account name. For example, the account holder name as recorded on the bank account.	AN	1	70	Yes
accountType	The bank account type. For example, Checking or Saving.	AN			No
accountNumberType	The bank account number type. For example, IBAN.	AN			Yes
accountNumber	The primary account number of the card	AN	12	19	Yes
bankName	The bank name of the payment credential.	AN	1	50	Yes
bankCode	The bank account bank code.	AN	1	12	No
branchCode	The bank account branch code.	AN	1	12	No
bankCodeType	The bank account bank code type. This is conditional for select markets.	AN			No
bic	The bank account's Business Identifier Code (BIC).	AN	8	11	No
countryCode	The bank account's country code.	AN	3	3	Yes
externalId	The client-provided identifier for the payment credential.	AN	1	100	No
currencyCode	The recipient card's currency code. The format is a 3-character ISO-4217 (Alpha-3) currency code.	AN	3	3	No
preferredFor	Indicates if a payment credential is a preferred Receiving, Sending, or Paying account.	Array			No
billingAddress	Object that contains the billing address details.	Object			Yes
country	The country code of the billing address. Uses the 3-character ISO 3166 (Alpha 3) format.	AN	3	3	Yes
streetName	The street name of the billing address	AN	1	60	No
City	The city of the billing address.	AN	1	35	No
postalCode	The post code of the billing address.	AN	1	16	No
AddressLine1	The first line of the billing address.	AN	0	99	No
buildingNumber	The building number of the billing address.	AN	1	60	No
AddressLine2	The second line of the billing address.	AN	0	99	No
State	The state of the billing address.	AN	1	16	No
minorSubdivisionCode	The minor subdivision code of the billing address.	AN	1	50	No
billingAddress

ThreddInfo Fields

The following table describes the fields in the paymentInfo object when the ThreddInfo object is selected.

Field	Description	Type	Min Length	Max Length	Mandatory
nameOnCard	The name that appears on the card.	AN	1	120	Yes
issuerName	The name of the issuer of the card.	AN	1	150	Yes
cardType	The card type description. For example, Visa Platinum.	AN	1	70	Yes
accountNumber	The primary account number of the card	AN	12	19	Yes
externalIdForCard	The client-provided identifier for the payment credential.	AN	1	100	No
preferredFor	Indicates if a payment credential is a preferred Receiving, Sending, or Paying account.	Array			No
billingAddress	Object that contains the billing address details.	Object			Yes
country	The country code of the billing address. Uses the 3-character ISO 3166 (Alpha 3) format.	AN	3	3	Yes
streetName	The street name of the billing address	AN	1	60	No
City	The city of the billing address.	AN	1	35	No
postalCode	The post code of the billing address.	AN	1	16	No
AddressLine1	The first line of the billing address.	AN	0	99	No
buildingNumber	The building number of the billing address.	AN	1	60	No
AddressLine2	The second line of the billing address.	AN	0	99	No
State	The state of the billing address.	AN	1	16	No
minorSubdivisionCode	The minor subdivision code of the billing address.	AN	1	50	No
billingAddress

Response

The following table describes the fields that are included in the response.

Field	Description
trackingId	The UUID generated by Thredd which identifies each transaction.
paymentCredentialId	The UUID generated by Alias Directory which identifies the payment credential.
type	The payment credential type.
externalId	The client-provided identifier for the payment credential.