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) if
buyerInformation.workPhone
or
buyerInformation.phoneNumber
is not used, unless market or regional mandate restricts sending this information.
This field is required (when available) if
buyerInformation.phoneNumber
or
buyerInformation.mobilePhone
is not used, unless market or regional mandate restricts sending this information.
This field is required (when available)if
buyerInformation.workPhone
or
buyerInformation.mobilePhone
is 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 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
.
For non-payment authentication, set to a value of
02
.
For Meeza transactions, this value must be set to
EG
when 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 to
EG
when Egypt is not set as the country in the merchant configuration during merchant onboarding.
This field is required when the
orderInformation.lineItems.unitPrice
field is not used.
This field is required for transactions in the US and Canada.
This field is required when the
paymentInformation.card.number
field is included.
This field is required when the
paymentInformation.card.number
field is included.