Step 1: Customer Verification¶

Description

The validateCustomerInfo endpoint is used to validate the customer's information with the customer and invoice number in order to Sign-up with the VELA application.

This endpoint is needed only when the Invoices module is enabled for the merchant.

Request

Endpoint
/ui/v1/validateCustomerInfo

Method
POST

Header
Content-Type: application/json

Attributes

ELEMENT	DESCRIPTION	FORMAT
Customer Number	Required must be at least 5 digits long	12345 Only numerics
InvoiceNumber	Required must be at least 8 characters long	123456R

Request Body

{
    "customerNumber": "10010",
    "invoiceNumber": "160100636",
    "uiType": "OneUI",
    "geolocation": "",
    "merchantCode": "VELA",
    "customerType": {
        "name": "PHYSICIAN",
        "value": ""
    }
}  

Response

{
    "id": null,
    "invoiceNumber": "160100636",
    "createdDateTime": null,
    "lastUpdatedDateTime": null,
    "invoiceDate": null,
    "paidDate": null,
    "dueDate": null,
    "terms": 0,
    "aging": 0,
    "invoiceAmount": null,
    "paidAmount": null,
    "amountDue": null,
    "createdUserId": null,
    "lastModifiedUserId": null,
    "invoiceStatus": {
        "value": "Unpaid",
        "name": "UNPAID"
    },
    "customerId": 10,
    "invoiceBatchId": null,
    "paidByUserId": null,
    "merchantId": null,
    "customerType": {
        "value": "Physician",
        "name": "PHYSICIAN"
    },
    "waiveReasonOnLateFees": null,
    "waiveLateFeesByPercentage": null,
    "waivedByUserId": null,
    "waivedDate": null,
    "customerNumber": "10010",
    "customerName": null,
    "merchantName": null,
    "paidByUserName": null,
    "message": {
        "code": "86",
        "type": {
            "value": "Success",
            "name": "SUCCESS"
        },
        "text": null,
        "include_i_icon": false,
        "description": "The Customer information has been verified and the Guest User is able to login successfully into the application."
    },
    "geolocation": "",
    "channelId": null,
    "roleType": null,
    "paymentAction": null,
    "addressLine1": null,
    "addressLine2": null,
    "city": null,
    "state": null,
    "zipCode": null,
    "phone": null,
    "merchantCode": "VELA"
}  

Step 2: Create Profile¶

Description

The addUser endpoint is used to create a user into the VELA application.

Request

Endpoint
/ui/v1/addUser

Method
POST

Header
Content-Type: application/json

Request Body

{
    "id": 0,
    "status": {
        "name": "ACTIVE"
    },
    "country": "USA",
    "state": "FL",
    "userName": "Merchantuser.2020",
    "currentPassword": "",
    "password": "Vela0!",
    "reEnterPassword": "Vela0!",
    "firstName": "Merchant",
    "lastName": "User",
    "middleInitial": "",
    "addressLine1": "1234 Abc road",
    "addressLine2": "Pine Valley Street",
    "addressLine3": "",
    "city": "Port st.Lucie",
    "zipCode": "34952",
    "phone": "",
    "mobile": "7777777777",
    "fax": "",
    "email": "merchantuser.2020@gmail.com",
    "reEnterEmail": "merchantuser.2020@gmail.com",
    "jobTitle": "Manager",
    "department": "Accounting",
    "locale": "en_US",
    "pwdMisMatchError": false,
    "pwdStrengthError": false,
    "reEnterPwdStrengthError": false,
    "pwdLengthError": false,
    "emailMisMatchError": false,
    "minimumPasswordLength": "6",
    "pwdStrengthPercentage": 100,
    "reEnterPwdStrengthPercentage": 100,
    "userChannelMap": [{
        "id": "",
        "channel": {
            "id": 1
        }
    }],
    "maximumAllowedLoginDays": 1,
    "organizationName": "",
    "createdUserId": "503",
    "customerId": null,
    "customerName": "",
    "selectedRoles": ["MERCHANT_USER"],
    "phoneCountryCallingCodeId": 1,
    "mobileCountryCallingCodeId": 1,
    "faxCountryCallingCodeId": 1,
    "paymentAction": {
        "name": "PRE_AUTHORIZATION"
    },
    "mobilePhoneCarrierType": {
        "emailDomain": "NUMBER@txt.att.net",
        "value": "AT&T",
        "countryCode": "USA",
        "name": "ATT"
    },
    "transactionCategory": {
        "name": "CARD_PRESENT"
    },
    "merchantId": 1,
    "sameAsMerchantAddress": true
}

Response

{
    "country": "USA",
    "addressLine1": "1234 Abc road",
    "addressLine2": "Pine Valley Street",
    "addressLine3": "",
    "city": "Port st.Lucie",
    "state": "FL",
    "zipCode": "34952",
    "id": 0,
    "userName": "Merchantuser.2020",
    "password": "Vela0!",
    "status": {
        "value": "Active",
        "name": "ACTIVE"
    },
    "firstName": "Merchant",
    "lastName": "User",
    "phone": "",
    "mobile": "7777777777",
    "fax": "",
    "jobTitle": "Manager",
    "department": "Accounting",
    "roles": [],
    "userChannelMap": [{
        "id": null,
        "channel": {
            "id": 1,
            "channelName": null,
            "channelStatus": null,
            "channelType": null,
            "createdDateTime": null,
            "merchantId": null,
            "lockedDateTime": null,
            "lockedByUserId": null,
            "createdUserId": null,
            "lastModifiedUserId": null,
            "industryType": null,
            "allowCashAsPaymentMethodInd": false,
            "allowMoneyOrderAsPaymentMethodInd": false,
            "allowPaperCheckAsPaymentMethodInd": false,
            "paymentMethods": [],
            "userCount": null,
            "assignedPaymentMethods": null,
            "message": null,
            "paymentMethodsCount": null,
            "merchantName": null
        }
    }],
    "oldEmail": null,
    "email": "merchantuser.2020@gmail.com",
    "locale": "en_US",
    "lastLoginDateTime": null,
    "securityQuestionsEnrolledInd": false,
    "createdUserId": 503,
    "lastModifiedUserId": null,
    "firstLoginDateTime": null,
    "maximumAllowedLoginDays": 1,
    "organizationName": "",
    "forceChangePasswordInd": false,
    "originalUserId": null,
    "loyaltyStatus": {
        "value": "Not Enrolled",
        "name": "NOT_ENROLLED"
    },
    "loyaltyRewardsNumber": null,
    "loyaltyEnrolledDateTime": null,
    "loyaltyTierLevel": {
        "value": "None",
        "name": "NONE"
    },
    "totalOutstandingPoints": null,
    "forgotPasswordGeneratedDateTime": null,
    "numberOfFailedLoginAttempts": 0,
    "numberOfFailedForgotPasswordAttempts": 0,
    "changePasswordDateTime": null,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "merchantId": 1,
    "createdDateTime": null,
    "forceChangeSecurityQuestionsInd": false,
    "passwordNeverExpiresInd": false,
    "phoneCountryCallingCodeId": 1,
    "mobileCountryCallingCodeId": 1,
    "faxCountryCallingCodeId": 1,
    "customerId": null,
    "acceptTermsOfUseAgreementInd": false,
    "acceptPrivacyPolicyAgreementInd": false,
    "namePrefix": null,
    "nameSuffix": null,
    "middleInitial": "",
    "paymentAction": {
        "value": "Pre-Authorization",
        "name": "PRE_AUTHORIZATION"
    },
    "mobilePhoneCarrierType": {
        "emailDomain": "NUMBER@txt.att.net",
        "value": "AT&T",
        "countryCode": "USA",
        "name": "ATT"
    },
    "transactionCategory": {
        "value": "Card Present",
        "name": "CARD_PRESENT"
    },
    "message": {
        "code": "73",
        "type": {
            "value": "Error",
            "name": "ERROR"
        },
        "text": null,
        "include_i_icon": false,
        "description": "The Mobile Number in combination with a Country Code must be unique."
    },
    "address": null,
    "fullName": null,
    "minimumPasswordLength": "6",
    "minimumLowercaseAlphabets": null,
    "minimumUppercaseAlphabets": null,
    "minimumNumerics": null,
    "minimumSpecialCharacters": null,
    "sessionId": null,
    "uiType": null,
    "customerName": "",
    "customerNumber": null,
    "geoLocation": null,
    "currentPassword": "",
    "reEnterPassword": "Vela0!",
    "reEnterEmail": "merchantuser.2020@gmail.com",
    "merchantName": null,
    "language": null,
    "merchantCode": null,
    "passwordAlreadyExists": false,
    "currentPasswordValid": false,
    "principal": null,
    "userSession": null,
    "selectedRoles": [
        "MERCHANT_USER"
    ]
}

Step 3: Set Up Security Q&A¶

Description

The user's security questions & answers can be set up by using createUserSecurityQuestionAnswers endpoint.

Updated As Of 2.4.0.0