Add Customer

Description¶

The addCustomer endpoint is used to add a Customer in VELA.

Request¶

Endpoint¶

/ui/v1/addCustomer

Method¶

POST

Header¶

Content-Type: application/json

Request Body¶

{
    "id": 0,
    "customerStatus": {
        "name": "ACTIVE"
    },
    "customerType": {
        "name": "OTHER"
    },
    "country": "USA",
    "state": "GA",
    "customerNumber": "90004",
    "customerName": "MEUS Travels",
    "pointOfContact": "",
    "addressLine1": "1234 ABC Road",
    "addressLine2": "",
    "addressLine3": "",
    "city": "Johns Creek",
    "zipCode": "30097",
    "pointOfContactPhone": "",
    "pointOfContactMobile": "",
    "pointOfContactFax": "",
    "pointOfContactEmail": "",
    "pointOfContactJobTitle": "",
    "pointOfContactDepartment": "",
    "createdUserId": "619",
    "phoneCountryCallingCodeId": 1,
    "mobileCountryCallingCodeId": 1,
    "faxCountryCallingCodeId": 1,
    "outstandingBalance": {
        "amount": "",
        "currency": {
            "currencyCode": "USD"
        }
    },
    "mobilePhoneCarrierType": {
        "name": "UNKNOWN",
        "emailDomain": "",
        "value": "Select"
    },
    "textMessageType": {
        "name": "SMS"
    },
    "merchantId": null,
    "customerProperties": [],
    "merchant": {
        "id": 7
    }
}

Response¶

{
    "country": "USA",
    "addressLine1": "1234 ABC Road",
    "addressLine2": "",
    "addressLine3": "",
    "city": "Johns Creek",
    "state": "GA",
    "zipCode": "30097",
    "streetNumber": null,
    "streetName": null,
    "id": 107,
    "customerNumber": "90004",
    "customerName": "MEUS Travels",
    "customerStatus": {
        "value": "Active",
        "name": "ACTIVE"
    },
    "pointOfContact": "",
    "pointOfContactJobTitle": "",
    "pointOfContactDepartment": "",
    "pointOfContactEmail": null,
    "pointOfContactPhone": "",
    "pointOfContactMobile": "",
    "pointOfContactFax": "",
    "createdUserId": 619,
    "lastModifiedUserId": null,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "createdDateTime": null,
    "customerBatchId": null,
    "phoneCountryCallingCodeId": 1,
    "mobileCountryCallingCodeId": 1,
    "faxCountryCallingCodeId": 1,
    "outstandingBalance": {
        "amount": null,
        "currency": {
            "id": 1,
            "currencyCode": "USD",
            "currencyText": "United States Dollar",
            "currencySymbol": "$",
            "fractionalUnit": "Cent",
            "numOfDecimalPlaces": "2",
            "supportedByVisaCheckout": true,
            "createdDateTime": 1608260908000,
            "isoNumericCode": "840",
            "isoCountryCode": "840"
        }
    },
    "customerProperties": [],
    "namePrefix": null,
    "nameSuffix": null,
    "mobilePhoneCarrierType": {
        "emailDomain": "",
        "value": "Select",
        "countryCode": "UNKNOWN",
        "name": "UNKNOWN"
    },
    "merchant": {
        "id": 7,
        "merchantName": null,
        "merchantDescription": null,
        "addressLine1": null,
        "addressLine2": null,
        "addressLine3": null,
        "city": null,
        "state": null,
        "zipCode": null,
        "country": null,
        "mailingAddressLine1": null,
        "mailingAddressLine2": null,
        "mailingAddressLine3": null,
        "mailingCity": null,
        "mailingState": null,
        "mailingZipCode": null,
        "mailingCountry": null,
        "pointOfContact": null,
        "pointOfContactJobTitle": null,
        "pointOfContactDepartment": null,
        "pointOfContactEmail": null,
        "pointOfContactPhone": null,
        "pointOfContactMobile": null,
        "pointOfContactFax": null,
        "lastModifiedUserId": null,
        "addressVerificationCheckInd": false,
        "cardVerificationCheckForCNPTransactionsInd": false,
        "cardVerificationCheckForTokenizedTransactionsInd": false,
        "cardVerificationCheckForCPTransactionsInd": false,
        "loyaltyRewardsEnabledInd": false,
        "initialLoyaltyRewardsNumber": null,
        "passwordNeverExpiresInd": false,
        "passwordExpirationDays": null,
        "passwordExpirationWarningDays": null,
        "onetimePasscodeValdtyTimePeriod": null,
        "phoneCountryCallingCodeId": null,
        "mobileCountryCallingCodeId": null,
        "faxCountryCallingCodeId": null,
        "invoicesModuleEnabledInd": false,
        "displayInvoiceNumberInPaymentsModule": false,
        "adhocInvoicesEnabledInd": false,
        "displayMemoInPaymentsModule": false,
        "displayFolioInformationInPaymentsModule": false,
        "recurringPaymentsEnabledInd": false,
        "productsAndServicesEnabledInd": false,
        "namePrefix": null,
        "nameSuffix": null,
        "displayDigitalSignatureForCardPresentTransactions": false,
        "displayDigitalSignatureForCardNotPresentTransactions": false,
        "paymentTokenizationEnabledInd": false,
        "paymentsBatchAuthorizationEnabledInd": false,
        "paymentsBatchProcessingEnabledInd": false,
        "allowUsersToSelfEnrollInd": false,
        "allowMultiCurrencyPricingInd": false,
        "mobilePhoneCarrierType": null,
        "cardPresentTransactionsEnabledInd": false,
        "defaultCurrencyCode": null,
        "allowPreAuthorizationTransactionInd": false,
        "allowSaleTransactionInd": false,
        "softDescriptorsEnabledInd": false,
        "softDescriptorMerchantName": null,
        "softDescriptorProductDescription": null,
        "merchantStatus": null,
        "merchantURL": null,
        "merchantDisplayTitle": null,
        "merchantCode": null,
        "sessionIdleTime": null,
        "sessionTimeoutTime": null,
        "keepaliveInterval": null,
        "customerSupportInformation": null,
        "allowPaymentsWithoutLoggingIn": false,
        "merchantBccEmailAddress": null,
        "abuseEmailAddress": null,
        "merchantProperties": null,
        "merchantBillings": null,
        "merchantBillingModel2s": null,
        "locale": null,
        "lateFeesEnabledInd": false,
        "lateFeesType": null,
        "lateFeesTier1FromNumOfDays": null,
        "lateFeesTier1ToNumOfDays": null,
        "lateFeesTier2FromNumOfDays": null,
        "lateFeesTier2ToNumOfDays": null,
        "lateFeesTier3FromNumOfDays": null,
        "lateFeesTier3ToNumOfDays": null,
        "tier1LateFees": null,
        "tier2LateFees": null,
        "tier3LateFees": null,
        "waiveTheLateFeesEnabledInd": false,
        "maxNumOfTimesPerYearLateFeeCanBeWaived": null,
        "paymentApplicationURL": null,
        "giftCardsEnabledInd": false,
        "minBookingNumberLength": 0,
        "maxBookingNumberLength": 0,
        "allowPartialPaymentsForInvoicesInd": false,
        "convenienceFeesEnabledInd": false,
        "creditCardsConvFeesType": null,
        "creditCardsConvFees": null,
        "industryType": null,
        "displayHealthcareFieldsOnHSAFSAPaymentMethods": false,
        "displayChartOnDashboard": false,
        "reportsModuleEnabledInd": false,
        "displayLastXDaysOfPaymentTokensForCardOnFile": null,
        "chartsDisplayTransactionRevenue": null,
        "chartsGroupByPaymentMethods": null,
        "chartsGroupByTransactionTypes": null,
        "chartsGroupByProductsAndServices": null,
        "chartsDateRangeType": null,
        "numOfDaysBetweenCheckinAndCurrentDate": null,
        "smsSubscriptionType": null,
        "cardPresentManualEntryOnlyTransactionsEnabledInd": false,
        "cardNotPresentTransactionsEnabledInd": false,
        "splitPaymentsEnabledInd": false,
        "accountLookupEnabledInd": false,
        "nextGenHpiLocationLookup": null,
        "billingEmailRequiredForPayments": false,
        "cardholderNameRequiredForTransactions": false,
        "textMessageType": null,
        "billingEnabledInd": false,
        "billingRevenueShareByPercentage": null,
        "installmentPaymentsEnabledInd": false,
        "minNumberOfInstallments": null,
        "maxNumberOfInstallments": null,
        "settledTransactionsReportEnabledInd": false,
        "summaryByTypeReportEnabledInd": false,
        "transactionSummaryReportEnabledInd": false,
        "settledTxnsReportEmailRecipients": null,
        "offlinePaymentActionsOnInvoiceModuleEnabledInd": false,
        "qrCodeEnabledInd": false,
        "dateFormat": null,
        "dateTimeFormat": null,
        "logoutSingleSignOnTime": null,
        "reconciliationPlatformName": null,
        "employerIdentificationNumber": null,
        "autoReconciliationEnabledInd": false,
        "customerSummaryEnabledInd": false,
        "surchargesEnabledInd": false,
        "surchargesByPercentage": null,
        "onlineReceiptLinkEnabledInd": false,
        "maxNumOfFailedOneTimePasscodeAttempts": 0,
        "message": null,
        "address": null,
        "fullName": null,
        "activeUserCount": null,
        "activeCustomerCount": null,
        "paymentTokenPurgeEnabledInd": false,
        "paymentTokenPurgeDays": null,
        "language": null,
        "echeckConvFees": null,
        "echeckConvFeesType": null,
        "emvcompliantTransactionType": null
    },
    "customerType": {
        "value": "Other",
        "name": "OTHER"
    },
    "numOfTimesPerYearLateFeesIsWaived": null,
    "firstWaivedDateTime": null,
    "lastWaivedDateTime": null,
    "dateOfBirth": null,
    "textMessageType": {
        "value": "SMS",
        "name": "SMS"
    },
    "message": {
        "code": "75",
        "type": {
            "value": "Success",
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "The Customer <strong>MEUS Travels</strong> has been created successfully."
    },
    "address": null,
    "fullName": null,
    "activeUserCount": null,
    "unpaidInvoiceCount": null,
    "dateOfBirthString": "",
    "merchantId": null
}

Updated As of Version 5.8.0.3