Skip to content

Create merchant

Request

Security
api-key-secret
Bodyapplication/jsonrequired
phonestring
deviceobject(DeviceDto)
merchantobject(PublicLeadDto)
agentnumber
curl -i -X POST \
  -u '<username>:<password>' \
  https://docs.taluspay.com/_mock/openapi/v1/merchants \
  -H 'Content-Type: application/json' \
  -d '{
    "phone": "string",
    "device": {
      "imei": "357111112222333"
    },
    "merchant": {
      "legal_business_name": "string",
      "legal_phone": "string",
      "business_phone": "string",
      "business_type": "Sole Proprietor",
      "bank_account": {
        "bank_name": "string",
        "routing_number": "string",
        "account_holder_name": "string",
        "account_number": "string",
        "account_number_confirm": "string"
      },
      "tin": "string",
      "tin_type": "EIN",
      "doing_business_as": "string",
      "business_established_date": "string",
      "legal_business_address": {
        "address": "string",
        "city": "string",
        "state": "string",
        "zip": "string"
      },
      "dba_address": {
        "address": "string",
        "city": "string",
        "state": "string",
        "zip": "string"
      },
      "owner_one": {
        "first_name": "string",
        "contact_phone": "string",
        "last_name": "string",
        "middle_name": "string",
        "job_title": "President",
        "ownership_percentage": "25",
        "email": "string",
        "date_of_birth": "string",
        "home_address": {
          "address": "string",
          "city": "string",
          "state": "string",
          "zip": "string"
        },
        "ssn": "string"
      },
      "owner_two": {
        "first_name": "string",
        "contact_phone": "string",
        "last_name": "string",
        "middle_name": "string",
        "job_title": "President",
        "ownership_percentage": "25",
        "email": "string",
        "date_of_birth": "string",
        "home_address": {
          "address": "string",
          "city": "string",
          "state": "string",
          "zip": "string"
        },
        "ssn": "string"
      },
      "owner_three": {
        "first_name": "string",
        "contact_phone": "string",
        "last_name": "string",
        "middle_name": "string",
        "job_title": "President",
        "ownership_percentage": "25",
        "email": "string",
        "date_of_birth": "string",
        "home_address": {
          "address": "string",
          "city": "string",
          "state": "string",
          "zip": "string"
        },
        "ssn": "string"
      },
      "owner_four": {
        "first_name": "string",
        "contact_phone": "string",
        "last_name": "string",
        "middle_name": "string",
        "job_title": "President",
        "ownership_percentage": "25",
        "email": "string",
        "date_of_birth": "string",
        "home_address": {
          "address": "string",
          "city": "string",
          "state": "string",
          "zip": "string"
        },
        "ssn": "string"
      },
      "main_product": {
        "description": "string",
        "category": "Apparel",
        "subcategory": "Veterinary Services",
        "website": "string"
      },
      "main_contact_person": {
        "name": "string",
        "email": "string"
      },
      "current_sales": {
        "average_monthly_in_credit_card": "string",
        "average_ticket_value": "string",
        "highest_amount_to_date": "string",
        "sales_percentage": {
          "card_swipe_percentage": "string",
          "moto_percentage": "string",
          "online_percentage": "string",
          "keyed_percentage": "string"
        },
        "average_amex_monthly_sales": "string",
        "average_amex_ticket_value": "string"
      },
      "bank_account_results": "string",
      "capabilities": {
        "types": [
          "two_tiered",
          "ach"
        ],
        "options": {
          "two_tiered": {
            "vmd_cp_rate_percent": "2.00",
            "vmd_cp_fee_fixed": "0.10",
            "vmd_cnp_rate_percent": "2.50",
            "vmd_cnp_fee_fixed": "0.15",
            "amex_cp_rate_percent": "3.10",
            "amex_cp_fee_fixed": "0.25",
            "amex_cnp_rate_percent": "3.50",
            "amex_cnp_fee_fixed": "0.30"
          },
          "ach": {
            "txn_fee_percent": "1.50",
            "txn_fee_fixed": "0.25"
          }
        }
      },
      "fees": {
        "monthly": {
          "minimum_processing_fee": 35,
          "merchant_advance_service_charge": 35
        }
      }
    },
    "agent": 0
  }'

Responses

Create merchant. If a merchant with the given device IMEI already exists for this account, it will return the existing merchant. Note: Phone numbers are not used for deduplication.

Bodyapplication/json
idstringrequired
Example:"merchant_2x4y6z8a0b1c2d3e4f5g6h7j8k"
phonestringrequired
Example:"12819374192"
automatic_payoutsbooleanrequired

Merchant payouts status

deactivatedbooleanrequired

Merchant deactivation flag

created_atstring, (date-time)required
lead_idnumberrequired

Onboarding application ID

lead_onboarding_statusstring(OnboardingStatus)required

Merchant onboarding status

Enum:"NOT_STARTED""IN_PROGRESS""COMPLETED""APPROVED""FAILED"
merchantobject(PublicLeadDto)required

Merchant onboarding information

paymentobject(MerchantPayment)required

Merchant payment information

defaultsobject(MerchantDefaults)required

Merchant default settings

default_capabilitiesobject(DefaultCapabilitiesResponseDto)required

Merchant default capabilities

payment_keysobject(AorakiMerchant)required

Merchant payment keys

deviceobject(DeviceResponseDto)

Merchant device information

Response
{
  "id": "merchant_2x4y6z8a0b1c2d3e4f5g6h7j8k",
  "phone": "12819374192",
  "automatic_payouts": true,
  "deactivated": true,
  "created_at": "2019-08-24T14:15:22Z",
  "lead_id": 0,
  "lead_onboarding_status": "NOT_STARTED",
  "merchant": {
    "legal_business_name": "string",
    "legal_phone": "string",
    "business_phone": "string",
    "business_type": "Sole Proprietor",
    "bank_account": { … },
    "tin": "string",
    "tin_type": "EIN",
    "doing_business_as": "string",
    "business_established_date": "string",
    "legal_business_address": { … },
    "dba_address": { … },
    "owner_one": { … },
    "owner_two": { … },
    "owner_three": { … },
    "owner_four": { … },
    "main_product": { … },
    "main_contact_person": { … },
    "current_sales": { … },
    "bank_account_results": "string",
    "capabilities": { … },
    "fees": { … }
  },
  "payment": {
    "tokenizer_publishable_key": "pub_XXXXXXXXXXXXXX",
    "terminal_id": "Cx78a65ada9"
  },
  "defaults": {
    "display_name": "My Store",
    "logo": "https://example.com/logo.png",
    "primary_color": "#FF5733",
    "secondary_color": "#FF5733",
    "redirect_url": "https://merchant-site.com/thank-you",
    "custom_domain": "https://apply.example.com",
    "support": {}
  },
  "default_capabilities": {
    "types": [ … ],
    "options": { … }
  },
  "payment_keys": {},
  "device": {
    "id": "dev_2x4y6z8a0b1c2d3e4f5g6h7j8k",
    "imei": "357111112222333",
    "imei_status": "ACTIVE",
    "created_at": "2024-01-15T10:30:00.000Z",
    "updated_at": "2024-01-15T10:30:00.000Z"
  }
}