module:models/PbtContact(value, type, verified_by)

new module:models/PbtContact(value, type, verified_by)
models/PbtContact.js, line 36

This class subject to change without prior notice, Please dont use this class directly.

Constructs a new PbtContact.
Parameters:
Name Type Description
value String

The customer's phone number to be enrolled for pay-by-text.
type module:models/PbtContact.TypeEnum

The type of contact information.
verified_by module:models/PbtContact.VerifiedByEnum

The entity that verified the contact. The "orbipay" value indicates that the contact has been verified by the EBPP, which is a reliable and trusted method of contact verification. The "other" value indicates that the contact has been verified client or some other trusted third-party. While this method may also be reliable, it is not as widely recognized or trusted as EBPP. For the Manage PBT Enrollment API, it is mandatory to use a contact that has been verified by either EBPP or a trusted third party."

Members

static, readonly TypeEnum :String
models/PbtContact.js, line 99

Allowed values for the type property.

Properties:
Name Type Description
sms String

value: "sms"

static, readonly VerifiedByEnum :String
models/PbtContact.js, line 111

Allowed values for the verified_by property.

Properties:
Name Type Description
orbipay String

value: "orbipay"
other String

value: "other"

inner type :module:models/PbtContact.TypeEnum
models/PbtContact.js, line 77

The type of contact information.

inner value :String
models/PbtContact.js, line 72

The customer's phone number to be enrolled for pay-by-text.

inner verification_code :String
models/PbtContact.js, line 87

The unique verification code generated by EBPP using <a href="#operation/initiateContactVerification"> Initiate Contact Verification API. This field is mandatory if the verified_by type is orbipay, indicating that the contact has been verified by the EBPP. If the verified_by type is other or none, this field may be left empty or null.

inner verified_by :module:models/PbtContact.VerifiedByEnum
models/PbtContact.js, line 82

The entity that verified the contact. The "orbipay" value indicates that the contact has been verified by the EBPP, which is a reliable and trusted method of contact verification. The "other" value indicates that the contact has been verified client or some other trusted third-party. While this method may also be reliable, it is not as widely recognized or trusted as EBPP. For the Manage PBT Enrollment API, it is mandatory to use a contact that has been verified by either EBPP or a trusted third party."

Methods

static constructFromObject(data, obj) → {module:models/PbtContact}
models/PbtContact.js, line 52

Constructs a PbtContact from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.
obj module:models/PbtContact

Optional instance to populate.
Returns:
module:models/PbtContact -

The populated PbtContact instance.