Merchant Boarding API Specification

Merchant Boarding API

Card Not Present Questionnaire

Get CNP Questionnaire

get /enroll/application/card-not-present-questionnaire/key/{externalKey}

Get the BIN routing card-not-present questionnaire for Merrick bank by an application's external key. For more usage information, see the CNP Questionnaire section of the Merchant Boarding API Integration Guide.

Parameters

externalKey required

Type

string

Pattern

^(?!.*/).*$

Range

1 to 50 characters

Example

2dc4436c-474d-46c3-83e8-50312fc27b01

Example Response

200 Return card-not-present questionnaire for enrollment application.

401 Unauthorized response - Need authorized permission to access the resource.

403 Forbidden response.

404 Application not found error response.

500 Internal Server Error response.

Update CNP Questionnaire

patch /enroll/application/card-not-present-questionnaire/key/{externalKey}

Update the BIN routing card-not-present questionnaire for Merrick bank by an application's external key. For more usage information, see the CNP Questionnaire section of the Merchant Boarding API Integration Guide.

Parameters

externalKey required

Type

string

Pattern

^(?!.*/).*$

Range

1 to 50 characters

Example

2dc4436c-474d-46c3-83e8-50312fc27b01

Request Schema

businessProfile

Type

object

locationAndInventory

Type

object

marketingAndSales

Type

object

fulfillment

Type

object

salesOperations

Type

object

productRegulatoryAndClinicalInfo

Type

object

customerService

Type

object

Example Request

{
  "businessProfile": {
    "businessModelTypes": "product",
    "businessDescription": "Sample description of business.",
    "salesDistributionPercentage": {
      "business": 50,
      "public": 50
    }
  },
  "locationAndInventory": {
    "hasRetailLocation": true,
    "isInventoryStoredAtRetailLocation": true,
    "hasInventoryOwnership": true,
    "inventoryStorageLocations": [
      {
        "name": "Product Location - 1",
        "address": {
          "street": "250 Stephenson Hwy",
          "street2": "Suite 123",
          "city": "Troy",
          "state": "MI",
          "zipCode": "48083"
        }
      }
    ]
  },
  "marketingAndSales": {
    "marketingChannels": [
      "internet",
      "other"
    ],
    "salesChannels": {
      "isCallCenterSalesEnabled": true,
      "isTelephoneOrderSalesEnabled": true
    }
  },
  "fulfillment": {
    "fulfillmentTypes": [
      "in-house",
      "outsourced"
    ],
    "outsourcedProviders": [
      {
        "providerName": "Fulfillment outsourced company name 1.",
        "serviceRole": "Fulfillment outsourced company description 1."
      }
    ],
    "isDropshippingEnabled": true
  },
  "salesOperations": {
    "serviceAvailabilityRegions": [
      "local",
      "national",
      "international"
    ],
    "customerChargeTiming": "at the time of Order",
    "deliveryTimeframes": "1-7 days",
    "recurringBilling": {
      "isEnabled": true,
      "frequency": "daily"
    },
    "freeTrialEnabled": true,
    "refundPolicy": "30 day return policy"
  },
  "productRegulatoryAndClinicalInfo": {
    "sellsSupplements": true,
    "isFdaRegulated": true,
    "isGmpCertifiedManufacturer": true,
    "clinicalResearch": {
      "isClinicalEvidenceAvailable": true,
      "clinicalResearchSource": "this is the source of business clinical research"
    }
  },
  "customerService": {
    "sourcingType": [
      "in-house"
    ],
    "facilityVisited": true,
    "serviceProvider": {
      "name": "sample customer service",
      "phone": "1234567890",
      "address": {
        "street": "250 Stephenson Hwy",
        "street2": "Suite 100",
        "city": "Troy",
        "state": "MI",
        "zipCode": "48083"
      }
    }
  }
}

Example Response

200 Return updated card-not-present questionnaire for enrollment application.

400 Bad request response.

401 Unauthorized response - Need authorized permission to access the resource.

403 Forbidden response.

404 Application not found error response.

415 Unsupported media type response - Invalid content type.

422 Unprocessable entity error response.

500 Internal Server Error response.