Create Clover Customer

curl --request POST \
  --url https://api.example.com/partner/clover/customers \
  --header 'Content-Type: application/json' \
  --header 'X-API-NONCE: <x-api-nonce>' \
  --header 'X-API-SIGNATURE: <x-api-signature>' \
  --header 'X-API-SUBSCRIPTION-KEY: <x-api-subscription-key>' \
  --header 'X-API-TIMESTAMP: <x-api-timestamp>' \
  --data '
{
  "business": {
    "business_name": "<string>",
    "naics_code": 123,
    "ein": "<string>",
    "formation_state": "<string>",
    "formation_date": "<string>",
    "business_address": {
      "street_1": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip_code": "<string>",
      "country": "<string>",
      "street_2": "<string>"
    },
    "mailing_address": {
      "street_1": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip_code": "<string>",
      "country": "<string>",
      "street_2": "<string>"
    },
    "phone": 123,
    "email": "<string>",
    "backup_withholding": true,
    "is_public": true,
    "government_affiliated": true,
    "affiliated_entities": "<string>",
    "operations_abroad": true,
    "international_customers_served": true,
    "dba": "<string>",
    "business_description": "<string>",
    "website": "<string>"
  },
  "persons": [
    {
      "first_name": "<string>",
      "last_name": "<string>",
      "date_of_birth": "2023-12-25",
      "home_address": {
        "street_1": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip_code": "<string>",
        "country": "<string>",
        "street_2": "<string>"
      },
      "tin": "<string>",
      "email": "<string>",
      "phone": 123,
      "ownership_percentage": 123,
      "work_title": "<string>",
      "controller": true,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "middle_name": "<string>",
      "phone_mobile": 123,
      "gender": "<string>",
      "employer_name": "<string>",
      "occupation": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "external_bank_account": {
    "bank_name": "<string>",
    "name_on_account": "<string>",
    "address_on_account": {
      "street_1": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip_code": "<string>",
      "country": "<string>",
      "street_2": "<string>"
    },
    "routing_number": "<string>",
    "account_number": "<string>"
  }
}
'

import requests

url = "https://api.example.com/partner/clover/customers"

payload = {
    "business": {
        "business_name": "<string>",
        "naics_code": 123,
        "ein": "<string>",
        "formation_state": "<string>",
        "formation_date": "<string>",
        "business_address": {
            "street_1": "<string>",
            "city": "<string>",
            "state": "<string>",
            "zip_code": "<string>",
            "country": "<string>",
            "street_2": "<string>"
        },
        "mailing_address": {
            "street_1": "<string>",
            "city": "<string>",
            "state": "<string>",
            "zip_code": "<string>",
            "country": "<string>",
            "street_2": "<string>"
        },
        "phone": 123,
        "email": "<string>",
        "backup_withholding": True,
        "is_public": True,
        "government_affiliated": True,
        "affiliated_entities": "<string>",
        "operations_abroad": True,
        "international_customers_served": True,
        "dba": "<string>",
        "business_description": "<string>",
        "website": "<string>"
    },
    "persons": [
        {
            "first_name": "<string>",
            "last_name": "<string>",
            "date_of_birth": "2023-12-25",
            "home_address": {
                "street_1": "<string>",
                "city": "<string>",
                "state": "<string>",
                "zip_code": "<string>",
                "country": "<string>",
                "street_2": "<string>"
            },
            "tin": "<string>",
            "email": "<string>",
            "phone": 123,
            "ownership_percentage": 123,
            "work_title": "<string>",
            "controller": True,
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "middle_name": "<string>",
            "phone_mobile": 123,
            "gender": "<string>",
            "employer_name": "<string>",
            "occupation": "<string>",
            "created_at": "2023-11-07T05:31:56Z"
        }
    ],
    "external_bank_account": {
        "bank_name": "<string>",
        "name_on_account": "<string>",
        "address_on_account": {
            "street_1": "<string>",
            "city": "<string>",
            "state": "<string>",
            "zip_code": "<string>",
            "country": "<string>",
            "street_2": "<string>"
        },
        "routing_number": "<string>",
        "account_number": "<string>"
    }
}
headers = {
    "X-API-SIGNATURE": "<x-api-signature>",
    "X-API-TIMESTAMP": "<x-api-timestamp>",
    "X-API-NONCE": "<x-api-nonce>",
    "X-API-SUBSCRIPTION-KEY": "<x-api-subscription-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-API-SIGNATURE': '<x-api-signature>',
    'X-API-TIMESTAMP': '<x-api-timestamp>',
    'X-API-NONCE': '<x-api-nonce>',
    'X-API-SUBSCRIPTION-KEY': '<x-api-subscription-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    business: {
      business_name: '<string>',
      naics_code: 123,
      ein: '<string>',
      formation_state: '<string>',
      formation_date: '<string>',
      business_address: {
        street_1: '<string>',
        city: '<string>',
        state: '<string>',
        zip_code: '<string>',
        country: '<string>',
        street_2: '<string>'
      },
      mailing_address: {
        street_1: '<string>',
        city: '<string>',
        state: '<string>',
        zip_code: '<string>',
        country: '<string>',
        street_2: '<string>'
      },
      phone: 123,
      email: '<string>',
      backup_withholding: true,
      is_public: true,
      government_affiliated: true,
      affiliated_entities: '<string>',
      operations_abroad: true,
      international_customers_served: true,
      dba: '<string>',
      business_description: '<string>',
      website: '<string>'
    },
    persons: [
      {
        first_name: '<string>',
        last_name: '<string>',
        date_of_birth: '2023-12-25',
        home_address: {
          street_1: '<string>',
          city: '<string>',
          state: '<string>',
          zip_code: '<string>',
          country: '<string>',
          street_2: '<string>'
        },
        tin: '<string>',
        email: '<string>',
        phone: 123,
        ownership_percentage: 123,
        work_title: '<string>',
        controller: true,
        id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        middle_name: '<string>',
        phone_mobile: 123,
        gender: '<string>',
        employer_name: '<string>',
        occupation: '<string>',
        created_at: '2023-11-07T05:31:56Z'
      }
    ],
    external_bank_account: {
      bank_name: '<string>',
      name_on_account: '<string>',
      address_on_account: {
        street_1: '<string>',
        city: '<string>',
        state: '<string>',
        zip_code: '<string>',
        country: '<string>',
        street_2: '<string>'
      },
      routing_number: '<string>',
      account_number: '<string>'
    }
  })
};

fetch('https://api.example.com/partner/clover/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/partner/clover/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'business' => [
        'business_name' => '<string>',
        'naics_code' => 123,
        'ein' => '<string>',
        'formation_state' => '<string>',
        'formation_date' => '<string>',
        'business_address' => [
                'street_1' => '<string>',
                'city' => '<string>',
                'state' => '<string>',
                'zip_code' => '<string>',
                'country' => '<string>',
                'street_2' => '<string>'
        ],
        'mailing_address' => [
                'street_1' => '<string>',
                'city' => '<string>',
                'state' => '<string>',
                'zip_code' => '<string>',
                'country' => '<string>',
                'street_2' => '<string>'
        ],
        'phone' => 123,
        'email' => '<string>',
        'backup_withholding' => true,
        'is_public' => true,
        'government_affiliated' => true,
        'affiliated_entities' => '<string>',
        'operations_abroad' => true,
        'international_customers_served' => true,
        'dba' => '<string>',
        'business_description' => '<string>',
        'website' => '<string>'
    ],
    'persons' => [
        [
                'first_name' => '<string>',
                'last_name' => '<string>',
                'date_of_birth' => '2023-12-25',
                'home_address' => [
                                'street_1' => '<string>',
                                'city' => '<string>',
                                'state' => '<string>',
                                'zip_code' => '<string>',
                                'country' => '<string>',
                                'street_2' => '<string>'
                ],
                'tin' => '<string>',
                'email' => '<string>',
                'phone' => 123,
                'ownership_percentage' => 123,
                'work_title' => '<string>',
                'controller' => true,
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'middle_name' => '<string>',
                'phone_mobile' => 123,
                'gender' => '<string>',
                'employer_name' => '<string>',
                'occupation' => '<string>',
                'created_at' => '2023-11-07T05:31:56Z'
        ]
    ],
    'external_bank_account' => [
        'bank_name' => '<string>',
        'name_on_account' => '<string>',
        'address_on_account' => [
                'street_1' => '<string>',
                'city' => '<string>',
                'state' => '<string>',
                'zip_code' => '<string>',
                'country' => '<string>',
                'street_2' => '<string>'
        ],
        'routing_number' => '<string>',
        'account_number' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-NONCE: <x-api-nonce>",
    "X-API-SIGNATURE: <x-api-signature>",
    "X-API-SUBSCRIPTION-KEY: <x-api-subscription-key>",
    "X-API-TIMESTAMP: <x-api-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/partner/clover/customers"

	payload := strings.NewReader("{\n  \"business\": {\n    \"business_name\": \"<string>\",\n    \"naics_code\": 123,\n    \"ein\": \"<string>\",\n    \"formation_state\": \"<string>\",\n    \"formation_date\": \"<string>\",\n    \"business_address\": {\n      \"street_1\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"zip_code\": \"<string>\",\n      \"country\": \"<string>\",\n      \"street_2\": \"<string>\"\n    },\n    \"mailing_address\": {\n      \"street_1\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"zip_code\": \"<string>\",\n      \"country\": \"<string>\",\n      \"street_2\": \"<string>\"\n    },\n    \"phone\": 123,\n    \"email\": \"<string>\",\n    \"backup_withholding\": true,\n    \"is_public\": true,\n    \"government_affiliated\": true,\n    \"affiliated_entities\": \"<string>\",\n    \"operations_abroad\": true,\n    \"international_customers_served\": true,\n    \"dba\": \"<string>\",\n    \"business_description\": \"<string>\",\n    \"website\": \"<string>\"\n  },\n  \"persons\": [\n    {\n      \"first_name\": \"<string>\",\n      \"last_name\": \"<string>\",\n      \"date_of_birth\": \"2023-12-25\",\n      \"home_address\": {\n        \"street_1\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"zip_code\": \"<string>\",\n        \"country\": \"<string>\",\n        \"street_2\": \"<string>\"\n      },\n      \"tin\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": 123,\n      \"ownership_percentage\": 123,\n      \"work_title\": \"<string>\",\n      \"controller\": true,\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"middle_name\": \"<string>\",\n      \"phone_mobile\": 123,\n      \"gender\": \"<string>\",\n      \"employer_name\": \"<string>\",\n      \"occupation\": \"<string>\",\n      \"created_at\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"external_bank_account\": {\n    \"bank_name\": \"<string>\",\n    \"name_on_account\": \"<string>\",\n    \"address_on_account\": {\n      \"street_1\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"zip_code\": \"<string>\",\n      \"country\": \"<string>\",\n      \"street_2\": \"<string>\"\n    },\n    \"routing_number\": \"<string>\",\n    \"account_number\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-SIGNATURE", "<x-api-signature>")
	req.Header.Add("X-API-TIMESTAMP", "<x-api-timestamp>")
	req.Header.Add("X-API-NONCE", "<x-api-nonce>")
	req.Header.Add("X-API-SUBSCRIPTION-KEY", "<x-api-subscription-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/partner/clover/customers")
  .header("X-API-SIGNATURE", "<x-api-signature>")
  .header("X-API-TIMESTAMP", "<x-api-timestamp>")
  .header("X-API-NONCE", "<x-api-nonce>")
  .header("X-API-SUBSCRIPTION-KEY", "<x-api-subscription-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"business\": {\n    \"business_name\": \"<string>\",\n    \"naics_code\": 123,\n    \"ein\": \"<string>\",\n    \"formation_state\": \"<string>\",\n    \"formation_date\": \"<string>\",\n    \"business_address\": {\n      \"street_1\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"zip_code\": \"<string>\",\n      \"country\": \"<string>\",\n      \"street_2\": \"<string>\"\n    },\n    \"mailing_address\": {\n      \"street_1\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"zip_code\": \"<string>\",\n      \"country\": \"<string>\",\n      \"street_2\": \"<string>\"\n    },\n    \"phone\": 123,\n    \"email\": \"<string>\",\n    \"backup_withholding\": true,\n    \"is_public\": true,\n    \"government_affiliated\": true,\n    \"affiliated_entities\": \"<string>\",\n    \"operations_abroad\": true,\n    \"international_customers_served\": true,\n    \"dba\": \"<string>\",\n    \"business_description\": \"<string>\",\n    \"website\": \"<string>\"\n  },\n  \"persons\": [\n    {\n      \"first_name\": \"<string>\",\n      \"last_name\": \"<string>\",\n      \"date_of_birth\": \"2023-12-25\",\n      \"home_address\": {\n        \"street_1\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"zip_code\": \"<string>\",\n        \"country\": \"<string>\",\n        \"street_2\": \"<string>\"\n      },\n      \"tin\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": 123,\n      \"ownership_percentage\": 123,\n      \"work_title\": \"<string>\",\n      \"controller\": true,\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"middle_name\": \"<string>\",\n      \"phone_mobile\": 123,\n      \"gender\": \"<string>\",\n      \"employer_name\": \"<string>\",\n      \"occupation\": \"<string>\",\n      \"created_at\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"external_bank_account\": {\n    \"bank_name\": \"<string>\",\n    \"name_on_account\": \"<string>\",\n    \"address_on_account\": {\n      \"street_1\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"zip_code\": \"<string>\",\n      \"country\": \"<string>\",\n      \"street_2\": \"<string>\"\n    },\n    \"routing_number\": \"<string>\",\n    \"account_number\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/partner/clover/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-SIGNATURE"] = '<x-api-signature>'
request["X-API-TIMESTAMP"] = '<x-api-timestamp>'
request["X-API-NONCE"] = '<x-api-nonce>'
request["X-API-SUBSCRIPTION-KEY"] = '<x-api-subscription-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"business\": {\n    \"business_name\": \"<string>\",\n    \"naics_code\": 123,\n    \"ein\": \"<string>\",\n    \"formation_state\": \"<string>\",\n    \"formation_date\": \"<string>\",\n    \"business_address\": {\n      \"street_1\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"zip_code\": \"<string>\",\n      \"country\": \"<string>\",\n      \"street_2\": \"<string>\"\n    },\n    \"mailing_address\": {\n      \"street_1\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"zip_code\": \"<string>\",\n      \"country\": \"<string>\",\n      \"street_2\": \"<string>\"\n    },\n    \"phone\": 123,\n    \"email\": \"<string>\",\n    \"backup_withholding\": true,\n    \"is_public\": true,\n    \"government_affiliated\": true,\n    \"affiliated_entities\": \"<string>\",\n    \"operations_abroad\": true,\n    \"international_customers_served\": true,\n    \"dba\": \"<string>\",\n    \"business_description\": \"<string>\",\n    \"website\": \"<string>\"\n  },\n  \"persons\": [\n    {\n      \"first_name\": \"<string>\",\n      \"last_name\": \"<string>\",\n      \"date_of_birth\": \"2023-12-25\",\n      \"home_address\": {\n        \"street_1\": \"<string>\",\n        \"city\": \"<string>\",\n        \"state\": \"<string>\",\n        \"zip_code\": \"<string>\",\n        \"country\": \"<string>\",\n        \"street_2\": \"<string>\"\n      },\n      \"tin\": \"<string>\",\n      \"email\": \"<string>\",\n      \"phone\": 123,\n      \"ownership_percentage\": 123,\n      \"work_title\": \"<string>\",\n      \"controller\": true,\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"middle_name\": \"<string>\",\n      \"phone_mobile\": 123,\n      \"gender\": \"<string>\",\n      \"employer_name\": \"<string>\",\n      \"occupation\": \"<string>\",\n      \"created_at\": \"2023-11-07T05:31:56Z\"\n    }\n  ],\n  \"external_bank_account\": {\n    \"bank_name\": \"<string>\",\n    \"name_on_account\": \"<string>\",\n    \"address_on_account\": {\n      \"street_1\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"zip_code\": \"<string>\",\n      \"country\": \"<string>\",\n      \"street_2\": \"<string>\"\n    },\n    \"routing_number\": \"<string>\",\n    \"account_number\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

Account Endpoints

Customer Endpoints

Transaction Endpoints

Headers

Body

Response