Restore Merchant

Description

The admin/restoreMerchant endpoint is used to restore a deleted a merchant in VELA.

Request

Endpoint

/ui/v1/admin/restoreMerchant

Method

POST

Content-Type: application/json
Authorization: $TOKEN

Note

Replace $TOKEN in the request with the base64-encoded username/password combination in the format username:password.

Given a username of username and a password of password, the request header would appear as follows:

Content-Type: application/json
Authorization: dXNlcm5hbWU6cGFzc3dvcmQ=

Request Body

{
    "id": 33,
    "merchantName": "Test Merchant",
    "merchantDescription": "Test Merchant",
    "addressLine1": "123 ABC Road",
    "addressLine2": null,
    "addressLine3": "",
    "city": "ABC City",
    "state": "GA",
    "zipCode": "30097",
    "country": "USA",
    "mailingAddressLine1": "123 ABC Road",
    "mailingAddressLine2": null,
    "mailingAddressLine3": "",
    "mailingCity": "ABC City",
    "mailingState": "GA",
    "mailingZipCode": "30097",
    "mailingCountry": "USA",
    "pointOfContact": "Administrator",
    "pointOfContactJobTitle": "",
    "pointOfContactDepartment": "",
    "pointOfContactEmail": "email@email.com",
    "pointOfContactPhone": "+1 1231231233",
    "pointOfContactMobile": "",
    "pointOfContactFax": "",
    "lastModifiedUserId": "1",
    "addressVerificationCheckInd": false,
    "cardVerificationCheckForCNPTransactionsInd": false,
    "cardVerificationCheckForTokenizedTransactionsInd": false,
    "cardVerificationCheckForCPTransactionsInd": false,
    "loyaltyRewardsEnabledInd": false,
    "initialLoyaltyRewardsNumber": null,
    "passwordNeverExpiresInd": false,
    "passwordExpirationDays": 90,
    "passwordExpirationWarningDays": 5,
    "onetimePasscodeValdtyTimePeriod": 10,
    "phoneCountryCallingCodeId": 1,
    "mobileCountryCallingCodeId": 1,
    "faxCountryCallingCodeId": 1,
    "invoicesModuleEnabledInd": false,
    "displayInvoiceNumberInPaymentsModule": true,
    "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": true,
    "mobilePhoneCarrierType": {
        "emailDomain": "",
        "value": "Select",
        "countryCode": "UNKNOWN",
        "name": "UNKNOWN"
    },
    "cardPresentTransactionsEnabledInd": false,
    "defaultCurrencyCode": "USD",
    "allowPreAuthorizationTransactionInd": false,
    "allowSaleTransactionInd": true,
    "softDescriptorsEnabledInd": false,
    "softDescriptorMerchantName": "",
    "softDescriptorProductDescription": "",
    "merchantStatus": {
        "name": "DELETED"
    },
    "merchantURL": "https://test-merchant.payvela.com",
    "merchantDisplayTitle": "Test Merchant",
    "merchantCode": "test-test",
    "sessionIdleTime": 900,
    "sessionTimeoutTime": 20,
    "keepaliveInterval": 300,
    "customerSupportInformation": "+1-123-PAY-VELA",
    "allowPaymentsWithoutLoggingIn": true,
    "merchantBccEmailAddress": "name@example.com",
    "abuseEmailAddress": "abuse@example.com",
    "merchantProperties": [
        {
            "id": 767,
            "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": 1708365497000,
            "lastUpdatedDateTime": null,
            "message": null
        },
        {
            "id": 766,
            "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": 1708365497000,
            "lastUpdatedDateTime": null,
            "message": null
        }
    ],
    "merchantBillings": [],
    "merchantBillingModel2s": [],
    "locale": "en_US",
    "lateFeesEnabledInd": false,
    "lateFeesType": {
        "name": "PERCENTAGE"
    },
    "lateFeesTier1FromNumOfDays": null,
    "lateFeesTier1ToNumOfDays": null,
    "lateFeesTier2FromNumOfDays": null,
    "lateFeesTier2ToNumOfDays": null,
    "lateFeesTier3FromNumOfDays": null,
    "lateFeesTier3ToNumOfDays": null,
    "tier1LateFees": null,
    "tier2LateFees": null,
    "tier3LateFees": null,
    "waiveTheLateFeesEnabledInd": false,
    "maxNumOfTimesPerYearLateFeeCanBeWaived": {
        "name": "UNKNOWN"
    },
    "paymentApplicationURL": "https://test-merchant.payvela.com",
    "giftCardsEnabledInd": false,
    "minBookingNumberLength": 0,
    "maxBookingNumberLength": 0,
    "allowPartialPaymentsForInvoicesInd": false,
    "convenienceFeesEnabledInd": false,
    "creditCardsConvFeesType": {
        "name": "PERCENTAGE"
    },
    "creditCardsConvFees": null,
    "industryType": {
        "name": "ECOMMERCE"
    },
    "displayHealthcareFieldsOnHSAFSAPaymentMethods": false,
    "displayChartOnDashboard": false,
    "reportsModuleEnabledInd": false,
    "displayLastXDaysOfPaymentTokensForCardOnFile": null,
    "chartsDisplayTransactionRevenue": {
        "name": "NONE"
    },
    "chartsGroupByPaymentMethods": {
        "name": "NONE"
    },
    "chartsGroupByTransactionTypes": {
        "name": "NONE"
    },
    "chartsGroupByProductsAndServices": {
        "name": "NONE"
    },
    "chartsDateRangeType": {
        "name": "TODAY"
    },
    "numOfDaysBetweenCheckinAndCurrentDate": null,
    "smsSubscriptionType": {
        "name": "FREE_VIA_SMTP"
    },
    "cardPresentManualEntryOnlyTransactionsEnabledInd": false,
    "cardNotPresentTransactionsEnabledInd": true,
    "splitPaymentsEnabledInd": true,
    "accountLookupEnabledInd": false,
    "nextGenHpiLocationLookup": "",
    "billingEmailRequiredForPayments": true,
    "cardholderNameRequiredForTransactions": true,
    "textMessageType": {
        "name": "SMS"
    },
    "billingEnabledInd": false,
    "billingRevenueShareByPercentage": null,
    "installmentPaymentsEnabledInd": false,
    "minNumberOfInstallments": null,
    "maxNumberOfInstallments": null,
    "settledTransactionsReportEnabledInd": false,
    "summaryByTypeReportEnabledInd": false,
    "transactionSummaryReportEnabledInd": false,
    "settledTxnsReportEmailRecipients": null,
    "offlinePaymentActionsOnInvoiceModuleEnabledInd": false,
    "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": "1234567891",
    "autoReconciliationEnabledInd": false,
    "customerSummaryEnabledInd": false,
    "surchargesEnabledInd": false,
    "surchargesByPercentage": null,
    "onlineReceiptLinkEnabledInd": false,
    "maxNumOfFailedOneTimePasscodeAttempts": 3,
    "apiAccessEnabledInd": false,
    "message": null,
    "address": "123 ABC Road, ABC City, Georgia 30097, United States of America",
    "fullName": "Administrator",
    "activeUserCount": 0,
    "activeCustomerCount": 0,
    "paymentTokenPurgeEnabledInd": false,
    "paymentTokenPurgeDays": null,
    "language": null,
    "echeckConvFees": null,
    "echeckConvFeesType": {
        "name": "FLAT"
    },
    "emvcompliantTransactionType": {
        "name": "RELAXED"
    }
}

Response

{
    "id": 33,
    "merchantName": "Test Merchant",
    "merchantDescription": "Test Merchant",
    "addressLine1": "123 ABC Road",
    "addressLine2": null,
    "addressLine3": "",
    "city": "ABC City",
    "state": "GA",
    "zipCode": "30097",
    "country": "USA",
    "mailingAddressLine1": "123 ABC Road",
    "mailingAddressLine2": null,
    "mailingAddressLine3": "",
    "mailingCity": "ABC City",
    "mailingState": "GA",
    "mailingZipCode": "30097",
    "mailingCountry": "USA",
    "pointOfContact": "Administrator",
    "pointOfContactJobTitle": "",
    "pointOfContactDepartment": "",
    "pointOfContactEmail": "email@email.com",
    "pointOfContactPhone": "+1 1231231233",
    "pointOfContactMobile": "",
    "pointOfContactFax": "",
    "lastModifiedUserId": 1,
    "addressVerificationCheckInd": false,
    "cardVerificationCheckForCNPTransactionsInd": false,
    "cardVerificationCheckForTokenizedTransactionsInd": false,
    "cardVerificationCheckForCPTransactionsInd": false,
    "loyaltyRewardsEnabledInd": false,
    "initialLoyaltyRewardsNumber": null,
    "passwordNeverExpiresInd": false,
    "passwordExpirationDays": 90,
    "passwordExpirationWarningDays": 5,
    "onetimePasscodeValdtyTimePeriod": 10,
    "phoneCountryCallingCodeId": 1,
    "mobileCountryCallingCodeId": 1,
    "faxCountryCallingCodeId": 1,
    "invoicesModuleEnabledInd": false,
    "displayInvoiceNumberInPaymentsModule": true,
    "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": true,
    "mobilePhoneCarrierType": {
        "emailDomain": "",
        "value": "Select",
        "countryCode": "UNKNOWN",
        "name": "UNKNOWN"
    },
    "cardPresentTransactionsEnabledInd": false,
    "defaultCurrencyCode": "USD",
    "allowPreAuthorizationTransactionInd": false,
    "allowSaleTransactionInd": true,
    "softDescriptorsEnabledInd": false,
    "softDescriptorMerchantName": "",
    "softDescriptorProductDescription": "",
    "merchantStatus": {
        "name": "DELETED"
    },
    "merchantURL": "https://test-merchant.payvela.com",
    "merchantDisplayTitle": "Test Merchant",
    "merchantCode": "test-test",
    "sessionIdleTime": 900,
    "sessionTimeoutTime": 20,
    "keepaliveInterval": 300,
    "customerSupportInformation": "+1-123-PAY-VELA",
    "allowPaymentsWithoutLoggingIn": true,
    "merchantBccEmailAddress": "name@example.com",
    "abuseEmailAddress": "abuse@example.com",
    "merchantProperties": [
        {
            "id": 767,
            "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": 1708365497000,
            "lastUpdatedDateTime": null,
            "message": null
        },
        {
            "id": 766,
            "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": 1708365497000,
            "lastUpdatedDateTime": null,
            "message": null
        }
    ],
    "merchantBillings": [],
    "merchantBillingModel2s": [],
    "locale": "en_US",
    "lateFeesEnabledInd": false,
    "lateFeesType": {
        "name": "PERCENTAGE"
    },
    "lateFeesTier1FromNumOfDays": null,
    "lateFeesTier1ToNumOfDays": null,
    "lateFeesTier2FromNumOfDays": null,
    "lateFeesTier2ToNumOfDays": null,
    "lateFeesTier3FromNumOfDays": null,
    "lateFeesTier3ToNumOfDays": null,
    "tier1LateFees": null,
    "tier2LateFees": null,
    "tier3LateFees": null,
    "waiveTheLateFeesEnabledInd": false,
    "maxNumOfTimesPerYearLateFeeCanBeWaived": {
        "name": "UNKNOWN"
    },
    "paymentApplicationURL": "https://test-merchant.payvela.com",
    "giftCardsEnabledInd": false,
    "minBookingNumberLength": 0,
    "maxBookingNumberLength": 0,
    "allowPartialPaymentsForInvoicesInd": false,
    "convenienceFeesEnabledInd": false,
    "creditCardsConvFeesType": {
        "name": "PERCENTAGE"
    },
    "creditCardsConvFees": null,
    "industryType": {
        "name": "ECOMMERCE"
    },
    "displayHealthcareFieldsOnHSAFSAPaymentMethods": false,
    "displayChartOnDashboard": false,
    "reportsModuleEnabledInd": false,
    "displayLastXDaysOfPaymentTokensForCardOnFile": null,
    "chartsDisplayTransactionRevenue": {
        "name": "NONE"
    },
    "chartsGroupByPaymentMethods": {
        "name": "NONE"
    },
    "chartsGroupByTransactionTypes": {
        "name": "NONE"
    },
    "chartsGroupByProductsAndServices": {
        "name": "NONE"
    },
    "chartsDateRangeType": {
        "name": "TODAY"
    },
    "numOfDaysBetweenCheckinAndCurrentDate": null,
    "smsSubscriptionType": {
        "name": "FREE_VIA_SMTP"
    },
    "cardPresentManualEntryOnlyTransactionsEnabledInd": false,
    "cardNotPresentTransactionsEnabledInd": true,
    "splitPaymentsEnabledInd": true,
    "accountLookupEnabledInd": false,
    "nextGenHpiLocationLookup": "",
    "billingEmailRequiredForPayments": true,
    "cardholderNameRequiredForTransactions": true,
    "textMessageType": {
        "name": "SMS"
    },
    "billingEnabledInd": false,
    "billingRevenueShareByPercentage": null,
    "installmentPaymentsEnabledInd": false,
    "minNumberOfInstallments": null,
    "maxNumberOfInstallments": null,
    "settledTransactionsReportEnabledInd": false,
    "summaryByTypeReportEnabledInd": false,
    "transactionSummaryReportEnabledInd": false,
    "settledTxnsReportEmailRecipients": null,
    "offlinePaymentActionsOnInvoiceModuleEnabledInd": false,
    "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": "1234567891",
    "autoReconciliationEnabledInd": false,
    "customerSummaryEnabledInd": false,
    "surchargesEnabledInd": false,
    "surchargesByPercentage": null,
    "onlineReceiptLinkEnabledInd": false,
    "maxNumOfFailedOneTimePasscodeAttempts": 3,
    "apiAccessEnabledInd": false,
    "message": {
        "code": "120",
        "type": {
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "MERCHANT_STATUS_RESTORATION_SUCCESS",
        "parameters": [
            {
                "name": "MERCHANT_NAME",
                "value": "Test Merchant"
            }
        ]
    },
    "address": "123 ABC Road, ABC City, Georgia 30097, United States of America",
    "fullName": "Administrator",
    "activeUserCount": 0,
    "activeCustomerCount": 0,
    "paymentTokenPurgeEnabledInd": false,
    "paymentTokenPurgeDays": null,
    "language": null,
    "echeckConvFees": null,
    "echeckConvFeesType": {
        "name": "FLAT"
    },
    "emvcompliantTransactionType": {
        "name": "RELAXED"
    }
}

Updated As Of Version 6.1.1