Create a merchant

Create merchant

POST https://<Platform-host>/merchant

This endpoint allows you to create a new onboarding application. Please note that you can have all data passed here, but we require at least a legal name to be provided.

Request Body

Name

Type

Description

name*

string

Merchant name

string

Merchant email

external_id

string

An optional identifier from your system to associate with this merchant

{
    "message": "merchant created",
    "data": {
        "name": "Platform",
        "email": "[email protected]",
        "external_id": "f8ba2eaa43e4",
        "data": {},
        "gateway_feeschedule_id": null,
        "country": "US",
        "feeschedule_id": "bc1bf1ed-cdac-4ade-b4ea-d82f557ebb9f",
        "id": "2f90cbb3-72f7-4574-95fa-66d738c9dbbe",
        "created_at": "2025-04-01T22:34:40.400Z",
        "updated_at": "2025-04-01T22:34:40.462Z",
        "account_id": "fdd24695-1298-496f-b997-89733fc17413",
        "status": "editing",
        "processing_status": null,
        "is_signed": false
    }
}

{
  "name": "Platform",
  "email": "[email protected]",
  "external_id": "",
  "business_type": {
        "type": "PR",
        "mcc_sic": "5734"
    },
    "business_details": {
        "legal": {
            "name": "Platform",
            "address_street": "Address",
            "address_unit": "suite",
            "address_city": "HCM",
            "address_state": "AZ",
            "address_zip": 15454
        },
        "dba": {
            "name": "Platform",
            "address_street": "Address",
            "address_unit": "suite",
            "address_city": "HCM",
            "address_state": "AZ",
            "address_zip": 15454
        },
        "dba_same_as_legal": true,
        "business_phone_no": "7526463989",
        "email": "[email protected]",
        "business_age_years": 1,
        "business_age_months": 2,
        "business_description": "Description of products or services sold",
        "how_products_delivered": "Directly to consumer's home",
        "return_policy": "Return before 30 days",
        "tax_exempt": false,
        "type_of_tax_id": "SSN",
        "tax_identification_number": "353535355",
        "accepted_transaction_types": [
            "CC_DC",
            "ACH"
        ],
        "number_of_locations": "1",
        "company_annual_revenue": 1000000,
        "place_of_issuance": "CA",
        "aoi_day": 20,
        "aoi_month": 2,
        "aoi_year": 2020,
        "how_many_days": "2-3 business days",
        "b2b_percentage": 70
    },
    "credit_card_processing": {
        "card_swiped": 25,
        "manually_keyed_cp": 25,
        "manually_keyed_cnp": 25,
        "ecommerce": 25,
        "accept_cc_before": true,
        "previous_processor_name": "CC Processor",        
        "avg_transaction_amount": 25,
        "total_monthly_sales": 10000,
        "highest_transaction_amount": 25,
        "frequency_ticket_per_year": "25",
        "qualified_processing_method": "EDCRetail"
    },
    "ach_processing": {
        "max_check_amount": "1000",
        "avg_check_amount": "30",
        "max_monthly_transaction_amount": 25,
        "min_monthly_transaction_amount": 25,
        "max_daily_transactions_count": 25,
        "max_monthly_transactions_count": 25,
        "total_annual_amount": 25,
        "avg_number_checks_monthly": "3000",
        "est_monthly_check_volume": "30000",
        "web": 25,
        "tel": 25,
        "ppd": 25,
        "ccd": 25        
    },
    "owner_officers": {
        "current_index": -1,
        "officers": [
            {
                "first_name": "John",
                "middle_name": "",
                "last_name": "Doe",
                "ownership": 75,
                "address_same_as_legal": false,
                "address_street": "Main Street",
                "address_unit": "",
                "address_city": "Los Angeles",
                "address_state": "CA",
                "address_zip": "90245",
                "email": "[email protected]",
                "phone_no": "3494262452",
                "birth_month": 2,
                "birth_day": 28,
                "birth_year": 1990,
                "ssn": "353535355",
                "title": "CEO",
                "signing_app": true,
                "personal_guarantor": true,
                "country_of_citizenship": "USA"
            }
        ]
    },
    "bank_details": {
        "accounts": [
            {
                "account_name": "My Bank Account",
                "account_type": "N",
                "routing_number": "083908420",
                "account_number": "12345678"
            }
        ]
    },
    "fee_schedule_id": "e88c756f-5667-4a3c-a9f9-346446da71b1"
}

var axios = require('axios');
var data = JSON.stringify({"name": "Platform", "email": "[email protected]"});

var config = {
  method: 'post',
  url: 'https://<Platform-host>/api/merchant',
  headers: { 
    'accept': 'application/json', 
    'Authorization': 'Basic {{YOUR_API_SECRET}}', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Webhook event: MERCHANT_CREATED

Webhook Payload Example

{
  event_uid: '220489c0dfa263d19ee1796973cdc9f6',
  event: 'MERCHANT_CREATED',
  data: {
    id: 'c404d923-226f-4aae-92da-22c1ef370434',
    account_id: 'e90c1de6-4e87-4c9e-bcbc-c535d6e349ec',
    merchant_id: 'c404d923-226f-4aae-92da-22c1ef370434',
    external_id: '123'
  }
}

{ "name": "Platform", "email": "[email protected]", "external_id": "", "business_type": { "type": "PR", "mcc_sic": "5734" }, "business_details": { "legal": { "name": "Platform", "address_street": "Address", "address_unit": "suite", "address_city": "HCM", "address_state": "AZ", "address_zip": 15454 }, "dba": { "name": "Platform", "address_street": "Address", "address_unit": "suite", "address_city": "HCM", "address_state": "AZ", "address_zip": 15454 }, "dba_same_as_legal": true, "business_phone_no": "7526463989", "email": "[email protected]", "business_age_years": 1, "business_age_months": 2, "business_description": "Description of products or services sold", "how_products_delivered": "Directly to consumer's home", "return_policy": "Return before 30 days", "tax_exempt": false, "type_of_tax_id": "SSN", "tax_identification_number": "353535355", "accepted_transaction_types": [ "CC_DC", "ACH" ], "number_of_locations": "1", "company_annual_revenue": 1000000, "place_of_issuance": "CA", "aoi_day": 20, "aoi_month": 2, "aoi_year": 2020, "how_many_days": "2-3 business days", "b2b_percentage": 70 }, "credit_card_processing": { "card_swiped": 25, "manually_keyed_cp": 25, "manually_keyed_cnp": 25, "ecommerce": 25, "accept_cc_before": true, "previous_processor_name": "CC Processor", "avg_transaction_amount": 25, "total_monthly_sales": 10000, "highest_transaction_amount": 25, "frequency_ticket_per_year": "25", "qualified_processing_method": "EDCRetail" }, "ach_processing": { "max_check_amount": "1000", "avg_check_amount": "30", "max_monthly_transaction_amount": 25, "min_monthly_transaction_amount": 25, "max_daily_transactions_count": 25, "max_monthly_transactions_count": 25, "total_annual_amount": 25, "avg_number_checks_monthly": "3000", "est_monthly_check_volume": "30000", "web": 25, "tel": 25, "ppd": 25, "ccd": 25 }, "owner_officers": { "current_index": -1, "officers": [ { "first_name": "John", "middle_name": "", "last_name": "Doe", "ownership": 75, "address_same_as_legal": false, "address_street": "Main Street", "address_unit": "", "address_city": "Los Angeles", "address_state": "CA", "address_zip": "90245", "email": "[email protected]", "phone_no": "3494262452", "birth_month": 2, "birth_day": 28, "birth_year": 1990, "ssn": "353535355", "title": "CEO", "signing_app": true, "personal_guarantor": true, "country_of_citizenship": "USA" } ] }, "bank_details": { "accounts": [ { "account_name": "My Bank Account", "account_type": "N", "routing_number": "083908420", "account_number": "12345678" } ] }, "fee_schedule_id": "e88c756f-5667-4a3c-a9f9-346446da71b1" }