Skip to main content
Beta version

Product Configuration API is in the Beta phase.

Product Configuration

Create a merchant account

This page explains how to create a merchant account for your client.

Endpoints overview

Review the requests you need to use to create a merchant account for your client:

  • Initiate a merchant onboarding request by sending a POST request to the /merchant-boarding-requests endpoint. If you have all necessary data, submit the request in a single submission. Submit the request with onboardRequestStatus set to DRAFT until all necessary data is available.
  • Append additional client data by sending a PATCH request to the /merchant-boarding-requests/{onboardRequestId} endpoint when your merchant account status is DRAFT. Continue collecting and adding data until you are ready to create the merchant account.
  • Retrieve the full set of data collected for a merchant onboarding request by sending a GET request to the /merchant-boarding-requests/{onboardRequestId} endpoint.

Before you begin

You must onboard the client through Digital Onboarding before proceeding. After completing Digital Onboarding, create a merchant account by onboarding the client to the Product Configuration API.

Create a merchant account

To create a merchant account, submit a POST request to the /merchant-boarding-requests endpoint with:

  • Your unique platform ID
  • Unique client ID from Digital Onboarding
  • Name for the merchant account
  • Contact information for the merchant

Use onboardRequestStatus to control the flow of the merchant onboarding process. While collecting and finalizing client data, set onboardRequestStatus to DRAFT. After you submit the client data and are ready to create the merchant account, set onboardRequestStatus to SUBMITTED.

The following table describes important fields included in a request.

Important request fields
Field name                                   Description
enterprisePlatformIdentifier

A unique identifier representing the profile for an external client that determines how it interacts with the our services, including onboarding, transaction processing, and embedded banking.
onboardRequestStatus

Defines the onboarding status for the enterprise platform or transaction processing entity.

  • DRAFT - To submit the client data in multiple requests, set the onboardRequestStatus to DRAFT.
  • SUBMITTED - After you submit the client data, or to create a merchant account with a single request, set onboardRequestStatus to SUBMITTED.
payoutTemplate The label for the Funds Transfer Instructions appears on reports provided to the merchant. You obtain this information from your relationship manager during platform setup.
pricingTemplate This label refers to an alternate, pre-defined format used for pricing configuration. You obtain this information from your relationship manager during platform setup.
processingTemplate This label refers to an alternate, pre-defined format used for processing entity configuration. You obtain this information from your relationship manager during platform setup.
clientId We provide this unique identifier to refer to the client's account.
accountName An alias for a merchant account, known as doing business as, is used when the business name is different from the legal name.

Onboarding with DRAFT status

HTTP method: POST
Endpoint: /merchant-boarding-requests

Request

Json
{
  "enterprisePlatformIdentifier": "6019573573",
  "onboardRequestStatus": "DRAFT",
  "clientId": "3002035472",
  "accountName": "Dannys Donuts Downtown Location",
  "locationAddress": {
    "city": "Plano",
    "countryCode": "USA",
    "line1": "123 ABI Street",
    "postalCode": "71301-7610",
    "state": "TX"
  },
  "pricingTemplate": "STANDARD_PRICING",
  "processingTemplate": "ACH_PROCESSING_SETUP",
  "businessProfile": {
    "digitalSales": {
      "usage": false
    },
    "terminalSales": {
      "usage": true,
      "merchantManualKeyedTransactionsPercentage": 10
    },
    "businessDescription": "Donut shop with exotic pastries"
  },
  "projectedSalesInfo": {
    "averageTicketSize": 7,
    "annualSalesTotal": 500000,
    "annualCreditSales": 400000,
    "currency": "CAD"
  },
  "payoutAccount": {
    "financialInstitutionName": "JP Morgan Chase",
    "accountOwnerName": "Central Park Catering, LLC",
    "routingNumber": "00212345",
    "accountNumber": "1234567",
    "countryCode": "USA"
  },
  "contactInfo": {
    "email": "customersupport@dannysdonuts.com",
    "phone": {
      "phoneNumber": "7894561551",
      "countryCode": "+1"
    }
  },
  "payoutTemplate": "GROSS_PURCHASE_FUNDING"
}

Response

Json
{
  "onboardRequestId": "10011033",
  "onboardRequestStatus": "DRAFT",
  "enterprisePlatformIdentifier": "6019573573",
  "clientId": "3002035472",
  "accountName": "Dannys Donuts Downtown Location",
  "locationAddress": {
    "city": "Plano",
    "countryCode": "USA",
    "line1": "123 ABI Street",
    "postalCode": "71301-7610",
    "state": "TX"
  },
  "pricingTemplate": "STANDARD_PRICING",
  "processingTemplate": "ACH_PROCESSING_SETUP",
  "businessProfile": {
    "digitalSales": {
      "usage": false
    },
    "terminalSales": {
      "usage": true,
      "merchantManualKeyedTransactionsPercentage": 10
    },
    "businessDescription": "Donut shop with exotic pastries"
  },
  "projectedSalesInfo": {
    "averageTicketSize": 7,
    "annualSalesTotal": 500000,
    "annualCreditSales": 400000,
    "currency": "CAD"
  },
  "payoutAccount": {
    "financialInstitutionName": "JP Morgan Chase",
    "accountOwnerName": "Central Park Catering, LLC",
    "routingNumber": "00212345",
    "accountNumber": "1234567",
    "countryCode": "USA"
  },
  "contactInfo": {
    "email": "customersupport@dannysdonuts.com",
    "phone": {
      "phoneNumber": "7894561551",
      "countryCode": "+1"
    }
  },
  "payoutTemplate": "GROSS_PURCHASE_FUNDING"
}

Onboarding with SUBMITTED status

HTTP method: POST
Endpoint: /merchant-boarding-requests

Request

Json
{
  "enterprisePlatformIdentifier": "6019573573",
  "onboardRequestStatus": "SUBMITTED",
  "clientId": "3002035472",
  "accountName": "Dannys Donuts Downtown Location",
  "locationAddress": {
    "city": "Plano",
    "countryCode": "USA",
    "line1": "123 ABI Street",
    "postalCode": "71301-7610",
    "state": "TX"
  },
  "pricingTemplate": "STANDARD_PRICING",
  "processingTemplate": "ACH_PROCESSING_SETUP",
  "businessProfile": {
    "digitalSales": {
      "usage": false,
      "website":"www.test.com"
    },
    "terminalSales": {
      "usage": true,
      "merchantManualKeyedTransactionsPercentage": 10
    },
    "businessDescription": "Donut shop with exotic pastries"
  },
  "projectedSalesInfo": {
    "averageTicketSize": 7,
    "annualSalesTotal": 500000,
    "annualCreditSales": 400000,
    "currency": "CAD"
  },
  "payoutAccount": {
    "financialInstitutionName": "JP Morgan Chase",
    "accountOwnerName": "Central Park Catering, LLC",
    "routingNumber": "00212345",
    "accountNumber": "1234567",
    "countryCode": "USA"
  },
  "contactInfo": {
    "email": "customersupport@dannysdonuts.com",
    "phone": {
      "phoneNumber": "7894561551",
      "countryCode": "+1"
    }
  },
  "payoutTemplate": "GROSS_PURCHASE_FUNDING"
}

Response

Json
{
  "onboardRequestId": "10011762",
  "onboardRequestStatus": "SUBMITTED",
  "enterprisePlatformIdentifier": "6019573573",
  "clientId": "3002035472",
  "accountName": "Dannys Donuts Downtown Location",
  "locationAddress": {
    "city": "Plano",
    "countryCode": "USA",
    "line1": "123 ABI Street",
    "postalCode": "71301-7610",
    "state": "TX"
  },
  "pricingTemplate": "STANDARD_PRICING",
  "processingTemplate": "ACH_PROCESSING_SETUP",
  "businessProfile": {
    "digitalSales": {
      "usage": false,
      "website": "www.test.com"
    },
    "terminalSales": {
      "usage": true,
      "merchantManualKeyedTransactionsPercentage": 10
    },
    "businessDescription": "Donut shop with exotic pastries"
  },
  "projectedSalesInfo": {
    "averageTicketSize": 7,
    "annualSalesTotal": 500000,
    "annualCreditSales": 400000,
    "currency": "CAD"
  },
  "payoutAccount": {
    "financialInstitutionName": "JP Morgan Chase",
    "accountOwnerName": "Central Park Catering, LLC",
    "routingNumber": "00212345",
    "accountNumber": "1234567",
    "countryCode": "USA"
  },
  "contactInfo": {
    "email": "customersupport@dannysdonuts.com",
    "phone": {
      "phoneNumber": "7894561551",
      "countryCode": "+1"
    }
  },
  "payoutTemplate": "GROSS_PURCHASE_FUNDING"
}

Update merchant account

Request to update merchant account with additional data:

HTTP method: PATCH
Endpoint: /merchant-boarding-requests/{onboardRequestId}

Request

Json
{
  "enterprisePlatformIdentifier": "6019573573",
  "onboardRequestStatus": "SUBMITTED",
  "clientId": "3002035472",
  "accountName": "Dannys Donuts Downtown Location",
  "accountAlias": "Dannys Donuts",
  "locationAddress": {
    "city": "Plano",
    "countryCode": "USA",
    "line1": "123 ABI Street",
    "postalCode": "71301-7610",
    "state": "TX"
  },
  "pricingTemplate": "STANDARD_PRICING",
  "processingTemplate": "ACH_PROCESSING_SETUP",
  "businessProfile": {
    "digitalSales": {
      "usage": false,
      "website": "www.google.com"
    },
    "terminalSales": {
      "usage": true,
      "merchantManualKeyedTransactionsPercentage": 10
    },
    "businessDescription": "Donut shop with exotic pastries"
  },
  "projectedSalesInfo": {
    "averageTicketSize": 7,
    "annualSalesTotal": 500000,
    "annualCreditSales": 400000,
    "currency": "CAD"
  },
  "payoutAccount": {
    "financialInstitutionName": "JP Morgan Chase",
    "accountOwnerName": "Central Park Catering, LLC",
    "routingNumber": "00212345",
    "accountNumber": "1234567",
    "countryCode": "USA"
  },
  "contactInfo": {
    "email": "customersupport@dannysdonuts.com",
    "phone": {
      "phoneNumber": "7894561551",
      "countryCode": "+1"
    }
  },
  "payoutTemplate": "GROSS_PURCHASE_FUNDING"
}

Response

Json
{
  "accountAlias": "Dannys Donuts",
  "accountName": "Dannys Donuts Downtown Location",
  "businessProfile": {
    "businessDescription": "Donut shop with exotic pastries",
    "digitalSales": {
      "usage": false,
      "website": "www.google.com"
    },
    "terminalSales": {
      "merchantManualKeyedTransactionsPercentage": 10,
      "usage": true
    }
  },
  "clientId": "3002035472",
  "contactInfo": {
    "phone": {
      "countryCode": "+1",
      "phoneNumber": "7894561551"
    },
    "email": "customersupport@dannysdonuts.com"
  },
  "enterprisePlatformIdentifier": "6019573573",
  "locationAddress": {
    "city": "Plano",
    "countryCode": "USA",
    "line1": "123 ABI Street",
    "postalCode": "71301-7610",
    "state": "TX"
  },
  "merchantId": "101128635403",
  "onboardRequestId": "10011033",
  "onboardRequestStatus": "SUBMITTED",
  "payoutAccount": {
    "financialInstitutionName": "JP Morgan Chase",
    "accountOwnerName": "Central Park Catering, LLC",
    "routingNumber": "00212345",
    "accountNumber": "1234567",
    "countryCode": "USA"
  },
  "payoutTemplate": "GROSS_PURCHASE_FUNDING",
  "pricingTemplate": "STANDARD_PRICING",
  "processingTemplate": "ACH_PROCESSING_SETUP",
  "projectedSalesInfo": {
    "annualCreditSales": 400000,
    "annualSalesTotal": 500000,
    "averageTicketSize": 7,
    "currency": "CAD"
  }
}

Retrieve merchant onboarding details

Request to retrieve merchant onboarding information:

HTTP method: GET
Endpoint: /merchant-boarding-requests/{onboardRequestId}

Response

Json
{
  "accountAlias": "Dannys Donuts",
  "accountName": "Dannys Donuts Downtown Location",
  "businessProfile": {
    "businessDescription": "Donut shop with exotic pastries",
    "digitalSales": {
      "usage": false,
      "website": "www.google.com"
    },
    "terminalSales": {
      "merchantManualKeyedTransactionsPercentage": 10,
      "usage": true
    }
  },
  "clientId": "3002035472",
  "contactInfo": {
    "phone": {
      "countryCode": "+1",
      "phoneNumber": "7894561551"
    },
    "email": "customersupport@dannysdonuts.com"
  },
  "enterprisePlatformIdentifier": "6019573573",
  "locationAddress": {
    "city": "Plano",
    "countryCode": "USA",
    "line1": "123 ABI Street",
    "postalCode": "71301-7610",
    "state": "TX"
  },
  "merchantId": "101128635403",
  "onboardRequestId": "10011033",
  "onboardRequestStatus": "SUBMITTED",
  "payoutAccount": {
    "financialInstitutionName": "JP Morgan Chase",
    "accountOwnerName": "Central Park Catering, LLC",
    "routingNumber": "00212345",
    "accountNumber": "1234567",
    "countryCode": "USA"
  },
  "payoutTemplate": "GROSS_PURCHASE_FUNDING",
  "pricingTemplate": "STANDARD_PRICING",
  "processingTemplate": "ACH_PROCESSING_SETUP",
  "projectedSalesInfo": {
    "annualCreditSales": 400000,
    "annualSalesTotal": 500000,
    "averageTicketSize": 7,
    "currency": "CAD"
  }
}

Next steps

With an active merchant account, your client is eligible to move to production and begin processing transactions.