Enroll Payment Instruments - Field Descriptions

The following page details each of the fields sent in the request and received in the response when using the Enroll Payment Instruments endpoint.

Request Fields

The following table describes fields that can be included in the body of the request when using the Enroll Payment Instruments endpoint.

Field	Description	Mandatory?	Type
customerReferenceId	An external customer reference provided in the request.	Yes	String
billingAddress	The object that contains information on the cardholder's billing address. If Thredd holds no address information of Cardholder then this is mandatory.	-	-
city	The city for the cardholder's billing address.	Conditional	String
state	The state for the cardholder's billing address.	Conditional	String
country	The country for the cardholder's billing address, expressed as a 3-letter (alpha-3) country code as defined in ISO 3166-1.	Conditional	String
postalCode	The post code for the cardholder's billing address.	Conditional	String
addressLine1	First line of the cardholder's billing address.	Conditional	String
addressLine2	Second line of the cardholder's billing address.	Conditional	String
addressLine3	Third line of the cardholder's billing address.	Conditional	String
end of billingAddress object	-	-	-
pubTokens	An object of public tokens.	-	-
value	The Thredd 9 digit unique reference for a PAN.	Yes	String
end of pubTokens object	-	-	-

A successful response for the Enroll Payment Instruments endpoint will return a 202 response.

Field	Description
requestTraceId	A unique identifier to trace the request.