Find Customer By Merchant Code
Description
The findCustomerByMerchantCode endpoint is used to find the Customer by using the merchant code within the VELA application.
Request
Endpoint¶
/ui/v1/findCustomerByMerchantCode/123/merchantCodeMethod¶
GET
Note
Replace merchantCode above with the internal merchant Code of the merchant.
Replace 123 with the internal ID of the user.
Response
{
"id": 5057,
"customerNumber": "10000001",
"customerName": "Test .Customer",
"customerStatus": {
"name": "ACTIVE"
},
"pointOfContact": "",
"pointOfContactJobTitle": "",
"pointOfContactDepartment": "",
"pointOfContactEmail": "syemme@datumsoftware.com",
"pointOfContactPhone": "",
"pointOfContactMobile": "4704131411",
"pointOfContactFax": "",
"createdUserId": 65,
"lastModifiedUserId": 52,
"lockedDateTime": null,
"lockedByUserId": null,
"createdDateTime": 1588967844000,
"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": 1608267267000,
"isoNumericCode": "840",
"isoCountryCode": "840"
}
},
"customerProperties": [],
"namePrefix": null,
"nameSuffix": null,
"mobilePhoneCarrierType": {
"emailDomain": "",
"value": "Select",
"countryCode": "UNKNOWN",
"name": "UNKNOWN"
},
"merchant": {
"id": 1,
"merchantName": "Zywie Business",
"merchantDescription": "Zywie Business",
"addressLine1": "Zywie Inc.",
"addressLine2": "Suite 360",
"addressLine3": null,
"city": "Johns Creek",
"state": "GA",
"zipCode": "30097",
"country": "USA",
"mailingAddressLine1": "12000 Findley Rd",
"mailingAddressLine2": "Suite 360",
"mailingAddressLine3": null,
"mailingCity": "Johns Creek",
"mailingState": "GA",
"mailingZipCode": "30097-1412",
"mailingCountry": "USA",
"pointOfContact": "Administrator",
"pointOfContactJobTitle": null,
"pointOfContactDepartment": null,
"pointOfContactEmail": "velaqaautomation@gmail.com",
"pointOfContactPhone": "6787400263",
"pointOfContactMobile": "6785143610",
"pointOfContactFax": "6789921941",
"lastModifiedUserId": 613,
"addressVerificationCheckInd": true,
"cardVerificationCheckForCNPTransactionsInd": true,
"cardVerificationCheckForTokenizedTransactionsInd": false,
"cardVerificationCheckForCPTransactionsInd": false,
"loyaltyRewardsEnabledInd": true,
"initialLoyaltyRewardsNumber": 10000000000001,
"passwordNeverExpiresInd": false,
"passwordExpirationDays": 90,
"passwordExpirationWarningDays": 5,
"onetimePasscodeValdtyTimePeriod": 10,
"phoneCountryCallingCodeId": 1,
"mobileCountryCallingCodeId": 1,
"faxCountryCallingCodeId": 1,
"invoicesModuleEnabledInd": true,
"displayInvoiceNumberInPaymentsModule": true,
"adhocInvoicesEnabledInd": true,
"displayMemoInPaymentsModule": true,
"displayFolioInformationInPaymentsModule": false,
"recurringPaymentsEnabledInd": false,
"productsAndServicesEnabledInd": false,
"namePrefix": {
"value": "Father",
"name": "FATHER"
},
"nameSuffix": {
"value": "MD",
"name": "DOCTOR_OF_MEDICINE"
},
"displayDigitalSignatureForCardPresentTransactions": false,
"displayDigitalSignatureForCardNotPresentTransactions": false,
"paymentTokenizationEnabledInd": true,
"paymentsBatchAuthorizationEnabledInd": false,
"paymentsBatchProcessingEnabledInd": false,
"allowUsersToSelfEnrollInd": true,
"allowMultiCurrencyPricingInd": true,
"mobilePhoneCarrierType": {
"emailDomain": "NUMBER@txt.att.net",
"value": "AT&T",
"countryCode": "USA",
"name": "ATT"
},
"cardPresentTransactionsEnabledInd": false,
"defaultCurrencyCode": "USD",
"allowPreAuthorizationTransactionInd": false,
"allowSaleTransactionInd": true,
"softDescriptorsEnabledInd": false,
"softDescriptorMerchantName": "DATUMSOFTWAR",
"softDescriptorProductDescription": "INCIDENTL",
"merchantStatus": {
"name": "ACTIVE"
},
"merchantURL": "https://zywie-business-test.payvela.com/ui/resources/login",
"merchantDisplayTitle": "Zywie™ Business",
"merchantCode": "zywie-business",
"sessionIdleTime": 900,
"sessionTimeoutTime": 20,
"keepaliveInterval": 300,
"customerSupportInformation": "+1-877-858-7200 (MON - FRI 8:00 AM - 8:00 PM ET)",
"allowPaymentsWithoutLoggingIn": true,
"merchantBccEmailAddress": "velaqaautomation@gmail.com",
"abuseEmailAddress": "abuse@zywie.healthcare",
"merchantProperties": [
{
"id": 3,
"merchantPropertyType": {
"name": "PAYMENT_TOKEN_CONFIG"
},
"propertyName": "PURGE_ENABLED",
"propertyDescription": "Is payment tokens purge enabled",
"groupName": null,
"propertyStringValue": null,
"propertyIntValue": null,
"propertyBooleanValue": false,
"merchantPropertyStatus": {
"name": "ACTIVE"
},
"createdUserId": 1,
"lastModifiedUserId": null,
"lockedDateTime": null,
"lockedByUserId": null,
"createdDateTime": 1568912428000,
"lastUpdatedDateTime": 1592248437000,
"message": null
},
{
"id": 4,
"merchantPropertyType": {
"name": "PAYMENT_TOKEN_CONFIG"
},
"propertyName": "RETENTION_DAYS",
"propertyDescription": "# of days to retain payment tokens",
"groupName": null,
"propertyStringValue": null,
"propertyIntValue": null,
"propertyBooleanValue": null,
"merchantPropertyStatus": {
"name": "ACTIVE"
},
"createdUserId": 1,
"lastModifiedUserId": null,
"lockedDateTime": null,
"lockedByUserId": null,
"createdDateTime": 1568912428000,
"lastUpdatedDateTime": 1592248437000,
"message": null
}
],
"merchantBillings": [],
"merchantBillingModel2s": [],
"locale": "en_US",
"lateFeesEnabledInd": false,
"lateFeesType": {
"name": "PERCENTAGE"
},
"lateFeesTier1FromNumOfDays": 1,
"lateFeesTier1ToNumOfDays": 30,
"lateFeesTier2FromNumOfDays": 31,
"lateFeesTier2ToNumOfDays": 60,
"lateFeesTier3FromNumOfDays": 61,
"lateFeesTier3ToNumOfDays": 90,
"tier1LateFees": 0,
"tier2LateFees": 3,
"tier3LateFees": 6,
"waiveTheLateFeesEnabledInd": true,
"maxNumOfTimesPerYearLateFeeCanBeWaived": {
"name": "ONCE"
},
"paymentApplicationURL": "https://zywie-business-test.payvela.com",
"giftCardsEnabledInd": false,
"minBookingNumberLength": 10,
"maxBookingNumberLength": 10,
"allowPartialPaymentsForInvoicesInd": false,
"convenienceFeesEnabledInd": false,
"creditCardsConvFeesType": {
"name": "PERCENTAGE"
},
"creditCardsConvFees": 3.25,
"industryType": {
"name": "BUSINESS_TO_BUSINESS"
},
"displayHealthcareFieldsOnHSAFSAPaymentMethods": false,
"displayChartOnDashboard": false,
"reportsModuleEnabledInd": true,
"displayLastXDaysOfPaymentTokensForCardOnFile": 45,
"chartsDisplayTransactionRevenue": {
"name": "NONE"
},
"chartsGroupByPaymentMethods": {
"name": "NONE"
},
"chartsGroupByTransactionTypes": {
"name": "NONE"
},
"chartsGroupByProductsAndServices": {
"name": "NONE"
},
"chartsDateRangeType": {
"name": "TODAY"
},
"numOfDaysBetweenCheckinAndCurrentDate": 3,
"smsSubscriptionType": {
"name": "FREE_VIA_SMTP"
},
"cardPresentManualEntryOnlyTransactionsEnabledInd": false,
"cardNotPresentTransactionsEnabledInd": true,
"splitPaymentsEnabledInd": true,
"accountLookupEnabledInd": false,
"nextGenHpiLocationLookup": "Zywie Business",
"billingEmailRequiredForPayments": false,
"cardholderNameRequiredForTransactions": true,
"textMessageType": {
"name": "SMS"
},
"billingEnabledInd": true,
"billingRevenueShareByPercentage": 20,
"installmentPaymentsEnabledInd": false,
"minNumberOfInstallments": 2,
"maxNumberOfInstallments": 36,
"settledTransactionsReportEnabledInd": true,
"summaryByTypeReportEnabledInd": true,
"transactionSummaryReportEnabledInd": true,
"settledTxnsReportEmailRecipients": null,
"offlinePaymentActionsOnInvoiceModuleEnabledInd": true,
"qrCodeEnabledInd": true,
"dateFormat": {
"value": "yyyy-MM-dd",
"name": "YYYY_MM_DD"
},
"dateTimeFormat": {
"value": "yyyy-MM-dd hh:mm a zzz",
"name": "YYYY_MM_DD_HH_MM_A_ZZZ"
},
"logoutSingleSignOnTime": 10,
"reconciliationPlatformName": {
"value": "None",
"industryType": "OTHER",
"name": "NONE"
},
"employerIdentificationNumber": "12-2543645",
"autoReconciliationEnabledInd": false,
"customerSummaryEnabledInd": true,
"surchargesEnabledInd": false,
"surchargesByPercentage": 0,
"onlineReceiptLinkEnabledInd": false,
"maxNumOfFailedOneTimePasscodeAttempts": 3,
"apiAccessEnabledInd": true,
"message": null,
"address": null,
"fullName": null,
"activeUserCount": null,
"activeCustomerCount": null,
"paymentTokenPurgeEnabledInd": false,
"paymentTokenPurgeDays": null,
"language": null,
"echeckConvFees": 1.99,
"echeckConvFeesType": {
"name": "FLAT"
},
"emvcompliantTransactionType": {
"name": "RELAXED"
}
},
"customerType": {
"name": "BUSINESS"
},
"numOfTimesPerYearLateFeesIsWaived": null,
"firstWaivedDateTime": null,
"lastWaivedDateTime": null,
"dateOfBirth": 950331600000,
"textMessageType": {
"name": "SMS"
},
"gender": null,
"country": "USA",
"addressLine1": "111111 ABC Road",
"addressLine2": "",
"addressLine3": "",
"city": "Suwanee",
"state": "DE",
"zipCode": "30089",
"enrollmentStatus": {
"name": "NOT_ENROLLED"
},
"message": null,
"address": null,
"fullName": null,
"activeUserCount": null,
"unpaidInvoiceCount": null,
"dateOfBirthString": "2000-02-12",
"merchantId": null
}
Updated As Of 6.1.1