Skip to main content
POST
/
v1
/
customers
Create Customer
curl --request POST \
  --url https://api.ecrypt.com/v1/customers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "firstName": "John",
  "lastName": "Doe",
  "company": "US Oil Supply",
  "merchantIdentifier": "EID-987654-321",
  "phoneNumber": "555-555-555",
  "emailAddress": "email@email.com",
  "shippingAddress": {
    "name": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>"
  },
  "metadata": {},
  "initiatedByUserId": 123
}
'
import requests

url = "https://api.ecrypt.com/v1/customers"

payload = {
    "firstName": "John",
    "lastName": "Doe",
    "company": "US Oil Supply",
    "merchantIdentifier": "EID-987654-321",
    "phoneNumber": "555-555-555",
    "emailAddress": "email@email.com",
    "shippingAddress": {
        "name": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>",
        "country": "<string>"
    },
    "metadata": {},
    "initiatedByUserId": 123
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: 'John',
    lastName: 'Doe',
    company: 'US Oil Supply',
    merchantIdentifier: 'EID-987654-321',
    phoneNumber: '555-555-555',
    emailAddress: 'email@email.com',
    shippingAddress: {
      name: '<string>',
      line1: '<string>',
      line2: '<string>',
      city: '<string>',
      state: '<string>',
      postalCode: '<string>',
      country: '<string>'
    },
    metadata: {},
    initiatedByUserId: 123
  })
};

fetch('https://api.ecrypt.com/v1/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.ecrypt.com/v1/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([
    'firstName' => 'John',
    'lastName' => 'Doe',
    'company' => 'US Oil Supply',
    'merchantIdentifier' => 'EID-987654-321',
    'phoneNumber' => '555-555-555',
    'emailAddress' => 'email@email.com',
    'shippingAddress' => [
        'name' => '<string>',
        'line1' => '<string>',
        'line2' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'postalCode' => '<string>',
        'country' => '<string>'
    ],
    'metadata' => [
        
    ],
    'initiatedByUserId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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.ecrypt.com/v1/customers"

	payload := strings.NewReader("{\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"company\": \"US Oil Supply\",\n  \"merchantIdentifier\": \"EID-987654-321\",\n  \"phoneNumber\": \"555-555-555\",\n  \"emailAddress\": \"email@email.com\",\n  \"shippingAddress\": {\n    \"name\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"metadata\": {},\n  \"initiatedByUserId\": 123\n}")

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

	req.Header.Add("x-api-key", "<api-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.ecrypt.com/v1/customers")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"company\": \"US Oil Supply\",\n  \"merchantIdentifier\": \"EID-987654-321\",\n  \"phoneNumber\": \"555-555-555\",\n  \"emailAddress\": \"email@email.com\",\n  \"shippingAddress\": {\n    \"name\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"metadata\": {},\n  \"initiatedByUserId\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.ecrypt.com/v1/customers")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"company\": \"US Oil Supply\",\n  \"merchantIdentifier\": \"EID-987654-321\",\n  \"phoneNumber\": \"555-555-555\",\n  \"emailAddress\": \"email@email.com\",\n  \"shippingAddress\": {\n    \"name\": \"<string>\",\n    \"line1\": \"<string>\",\n    \"line2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\",\n    \"country\": \"<string>\"\n  },\n  \"metadata\": {},\n  \"initiatedByUserId\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "requestId": "000000000000000000000",
  "customer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "firstName": "John",
    "lastName": "Doe",
    "company": "US Oil Supply",
    "merchantIdentifier": "EID-987654-321",
    "phoneNumber": "555-555-555",
    "emailAddress": "email@email.com",
    "shippingAddress": {
      "name": "<string>",
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postalCode": "<string>",
      "country": "<string>"
    },
    "metadata": {}
  },
  "errors": [
    {
      "type": "<string>",
      "message": "<unknown>"
    }
  ]
}
{
  "requestId": "000000000000000000000",
  "errors": [
    {
      "type": "<string>",
      "message": "<unknown>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Authorization by x-api-key inside request's header

Body

​
firstName
string | null
default:John

Customers first name.

Maximum string length: 100
Pattern: ^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$
​
lastName
string | null
default:Doe

Customers last name.

Maximum string length: 100
Pattern: ^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$
​
company
string | null
default:US Oil Supply

Company associated with the customer.

Maximum string length: 100
Pattern: ^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$
​
merchantIdentifier
string | null
default:EID-987654-321

Merchants customer identifier. This field can be used as a reference back to your internal data system.

Maximum string length: 100
Pattern: ^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$
​
phoneNumber
string | null
default:555-555-555

Customers phone number. This could be a cellular, land line, or a fax number.

Maximum string length: 100
Pattern: ^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$
​
emailAddress
string | null
default:email@email.com

Customers email address.

Maximum string length: 100
Pattern: ^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$
​
shippingAddress
object | null
​
metadata
object | null

Metadata associated with the customer. This is a key value pair.

​
initiatedByUserId
integer<int64> | null

Response

object | null

OK

​
requestId
string
default:000000000000000000000
required
Required string length: 1 - 100
​
customer
object | null
​
errors
(object | null)[] | null