On This Page
REST API
Required Fields for Checking Enrollment in Payer
Authentication
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.
- This field is required (when available) ifbuyerInformation.workPhoneorbuyerInformation.phoneNumberis not used, unless market or regional mandate restricts sending this information.
- This field is required (when available) ifbuyerInformation.phoneNumberorbuyerInformation.mobilePhoneis not used, unless market or regional mandate restricts sending this information.
- This field is required (when available)ifbuyerInformation.workPhoneorbuyerInformation.mobilePhoneis not used, unless market or regional mandate restricts sending this information.
- This field is required for SDK integration. When you use the SDK integration, this field is dynamically set toSDK. When you use the JavaScript code, this field is dynamically set toBrowser. For merchant-initiated or 3RI transactions, you must set the field to3RI. When you use this field in addition to JavaScript code, you must set the field toBrowser.
- For non-payment authentication, set to a value of02.
- For Meeza transactions, this value must be set toEGwhen Egypt is not set as the country in the merchant configuration during merchant onboarding.
- When the customer’s browser provides this value, you must include that value in your request.
- For Meeza transactions, this value must be set toEGwhen Egypt is not set as the country in the merchant configuration during merchant onboarding.
- This field is required when theorderInformation.lineItems.unitPricefield is not used.
- This field is required for transactions in the US and Canada.
- This field is required when thepaymentInformation.card.numberfield is included.
- This field is required when thepaymentInformation.card.numberfield is included.