On This Page

{#jumplink-list}  
[Markdown](/content/cybsdeveloper2021/amer/en/docs/barclays/en-us/payer-authentication/developer/all/rest/payer-auth/pa2-use-cases-intro/pa2-check-enroll-use-intro/pa2-use-check-enroll-reqd-fields.md)

Required Fields for Checking Enrollment in Payer Authentication {#pa-api-enrolling-reqd-fields}
===============================================================================================

These fields are the minimum fields required for verifying that a customer is enrolled in a payer authentation program. Under certain circumstances, a field that normally is optional might be required. The circumstance that makes an optional field required is noted.

Required Fields
---------------

buyerInformation.mobilePhone
:
This field is required (when available) if buyerInformation.workPhone is not used, unless market or regional mandate restricts sending this information.

buyerInformation.workPhone
:
This field is required (when available) if buyerInformation.mobilePhone is not used, unless market or regional mandate restricts sending this information.

consumerAuthenticationInformation. deviceChannel
:
This field is required for SDK integration. When you use the SDK integration, this field is dynamically set to `SDK`. When you use the JavaScript code, this field is dynamically set to `Browser`. For merchant-initiated or 3RI transactions, you must set the field to `3RI`. When you use this field in addition to JavaScript code, you must set the field to `Browser`.

consumerAuthenticationInformation. messageCategory
:
For non-payment authentication, set to a value of `02`.

consumerAuthenticationInformation.referenceId
:

consumerAuthenticationInformation.returnUrl
:

consumerAuthenticationInformation. overrideCountryCode
:
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.

deviceInformation.httpAcceptBrowserValue
:

deviceInformation.httpAcceptContent
:

deviceInformation.httpBrowserColorDepth
:

deviceInformation.httpBrowserJavaEnabled
:

deviceInformation.httpBrowserJavaScriptEnabled
:

deviceInformation.httpBrowserLanguage
:

deviceInformation.httpBrowserScreenHeight
:

deviceInformation.httpBrowserScreenWidth
:

deviceInformation.httpBrowserTimeDifference
:

deviceInformation.ipAddress
:

deviceInformation.userAgentBrowserValue
:
When the customer's browser provides this value, you must include that value in your request.

merchantInformation.merchantDescriptor. country
:
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.

orderInformation.amountDetails.currency
:

orderInformation.amountDetails.totalAmount
:
This field is required when the orderInformation.lineItems.unitPrice field is not used.

orderInformation.billTo.address1
:

orderInformation.billTo.administrativeArea
:
This field is required for transactions in the US and Canada.

paymentInformation.card.expirationYear
:
This field is required when the paymentInformation.card.number field is included.

paymentInformation.card.expirationMonth
:
This field is required when the paymentInformation.card.number field is included.

paymentInformation.card.type
:

paymentInformation.card.number
:  
RELATED TO THIS PAGE

* <>
* <>
* <>

