Setting Up Device Data Collection {#pa2-set-up-use-intro} ========================================================= The Setup service identifies the customer's bank and prepares for collecting data about the device that the customer is using to place the order. Card-Specific Requirements {#pa2-set-up-use-intro_card-specific} ---------------------------------------------------------------- Some payment cards require specific information to be collected during a transaction. [card_cardType](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/card-card-type.md "") : This field is required when the card type is JCB, Cartes Bancaires, China UnionPay, or Meeza. {#pa2-set-up-use-intro_dl_d1v_trz_rxb} Country-Specific Requirements {#pa2-set-up-use-intro_country-specific-SO} ------------------------------------------------------------------------- These fields are required for transactions in specific countries. [billTo_state](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/bill-to-state.md "") : This field is required for transactions in the US, Canada, and Mainland China. [billTo_postalCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/bill-to-postal-code.md "") : This field is required when the billTo_country field value is `US` or `CA`. [invoiceHeader_ merchantDescriptorCountry](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/bill-to-state.md "") : For Meeza transactions, this value must be set to `EG` if Egypt was not set as the country in the merchant configuration during merchant boarding. [payerAuthEnrollService_ merchantCountrycode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/payer-auth-enroll-service-merchant-country-code.md "") : For Meeza transactions, this value must be set to `EG` if Egypt was not set as the country in the merchant configuration during merchant boarding. {#pa2-set-up-use-intro_dl_gpf_5rb} Endpoint -------- Set the `payerAuthSetupService_run` field to `true`. Send the request to: **Production:** `https://ics2ws.ic3.com/commerce/1.x/transactionProcessor` **Test:** `https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor` Required Fields for Device Data Collection {#pa2-use-setup-reqd-fields} ======================================================================= These fields are the minimum fields required when you request the Payer Authentication Setup service. Other fields that can be used to collect additional information during a transaction are listed in the optional fields section. Under certain circumstances, a field that is normally optional might be required. The circumstance that makes an optional field required is noted. [billTo_postalCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/bill-to-postal-code.md "") : This field is required when the billTo_country field value is `US` or `CA`. [billTo_state](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/bill-to-state.md "") : This field is required for the US and Canada. [card_accountNumber](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/card-account-number.md "") : [card_cardType](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/card-card-type.md "") : This field is required when the card type is Cartes Bancaires, JCB, China UnionPay, or Meeza. [card_expirationMonth](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/card-expiration-month.md "") : This field is required when card_accountNumber is included. [card_expirationYear](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/card-expiration-year.md "") : This field is required when card_accountNumber is included. [invoiceHeader_ merchantDescriptorCountry](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/bill-to-state.md "") : For Meeza transactions, this value must be set to `EG` when Egypt is not set as the country in the merchant configuration during merchant boarding. [payerAuthEnrollService_ merchantCountrycode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/payer-auth-enroll-service-merchant-country-code.md "") : For Meeza transactions, this value must be set to `EG` when Egypt is not set as the country in the merchant configuration during merchant boarding. payerAuthSetupService_run : Optional Fields for Device Data Collection {#reference_hkg_vtp_mrb} =================================================================== These fields are optional for setting up a Payer Authentication transaction. Under certain circumstances, a field might appear as both an optional field and a required field. [billTo_city](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/bill-to-city.md "") : [billTo_country](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/bill-to-country.md "") : [billTo_email](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/bill-to-email.md "") : [billTo_firstName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/bill-to-first-name.md "") : [billTo_lastName](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/bill-to-last-name.md "") : [billTo_postalCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/bill-to-postal-code.md "") : [billTo_street1](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/bill-to-street1.md "") : [card_cardType](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/card-card-type.md "") : [card_expirationMonth](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/card-expiration-month.md "") : This field is required when card_accountNumber is included. [card_expirationYear](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/card-expiration-year.md "") : This field is required when card_accountNumber is included. [encryptedPayment_data](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/encrypted-payment-data.md "") : [encryptedPayment_descriptor](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/encrypted-payment-descriptor.md "") : [merchantID](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/merchant-id.md "") : [merchantReferenceCode](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/merchant-reference-code.md "") : [tokenSource_transientToken](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/so/api-fields/token-source-transient-token.md "") : Simple Order Example: Setting Up Device Data Collection {#pa2-use-setup-so-ex} ============================================================================== Request ``` card_accountNumber=XXXXXXXXXXXXXXXX card_expirationMonth=12 card_expirationYear=2030 merchantID=patest merchantReferenceCode=0001 payerAuthSetupService_run=true ``` Response to Successful Request ``` decision=ACCEPT merchantReferenceCode=0001 payerAuththSetupReply_deviceDataCollectionURL=https://centinelapistag.cardinalcommerce.com/V1 /Cruise/Collect payerAuthSetupReply_reasonCode=100 payerAuthSetupReply_referenceID=f13fe5e0-9b47-4ea1-a03a-ec360f4d0f9f payerAuthSetupReply_accessToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI1MDc4OTI0Mi0z YmEzLTRhZTItYWQwOS1kZjZkODk2NWQ5MjciLCJpYXQiOjE1OTgyOTk1MjQsImlzcyI6IjVkZDgzYmYwMGU0MjNkMTQ 5OGRjYmFjYSIsImV4cCI6MTU5ODMwMzEyNCwiT3JnVW5pdElkIjoiNTVlZjNmMTBmNzIzYWE0MzFjOTliNWViIiwiUGF 5bG9hZCI6eyJBQ1NVcmwiOiJodHRwczovLzBtZXJjaGFudGFjc3N0YWcuY2FyZGluYWxjb21tZXJjZS5jb20vTWVyY2 hhbnRBQ1NXZWIvY3JlcS5qc3AiLCJQYXlsb2FkIjoiZXlKdFpYTnpZV2RsVkhsd1pTSTZJa05TWlhFaUxDSnRaWE56W VdkbFZtVnljMmx2YmlJNklqSXVNaTR3SWl3aWRHaHlaV1ZFVTFObGNuWmxjbFJ5WVc1elNVUWlPaUkzTkRNeVlUWXdN QzA0TXpNMkxUUm1PRGN0WVdKbE9TMDJObVkzTkRFM01EaGhNV1FpTENKaFkzTlVjbUZ1YzBsRUlqb2lPR0U1TkRkaU9E TXRNRFJpTkMwMFltVmlMV0V5WWpNdFpHTmpNV0UxWmprMFlURXlJaXdpWTJoaGJHeGxibWRsVjJsdVpHOTNVMmw 2WlNJNklqQXlJbjAiLCJUcmFuc2FjdGlvbklkIjoiVEQ1b1MwbzFGQzY1cWF2MHhzeDAifSwiT2JqZWN0aWZ5UGF5bG9h ZCI6dHJ1ZSwiUmV0dXJuVXJsIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9zdGVwLXVwLXJldHVybi11cmwuanNwIn0.8w Z8XhLgOIIRvgEUugvYrRAi-efavZTNM0tWInYLTfE payerAuthSetupReply_reasonCode=100 requestID=5982993692286989203011 requestToken=AxjzbwSTRFa3h+A4wXZDABEBURwlqraRpAy7gDthk0kyro9JLIYA8AAA2wK2 ```