Create a customer
curl --request POST \
--url https://api.notchpay.co/customers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "john@example.com",
"phone": 237600000000,
"name": "John Doe",
"company_name": "ACME Inc",
"metadata": {},
"address": {
"country": "CM",
"state": "<string>",
"city": "Douala",
"postal_code": "<string>",
"address_line1": "123 Main St",
"address_line2": "<string>"
},
"billing": {
"country": "CM",
"state": "<string>",
"city": "Douala",
"postal_code": "<string>",
"address_line1": "123 Main St",
"address_line2": "<string>"
}
}
'import requests
url = "https://api.notchpay.co/customers"
payload = {
"email": "john@example.com",
"phone": 237600000000,
"name": "John Doe",
"company_name": "ACME Inc",
"metadata": {},
"address": {
"country": "CM",
"state": "<string>",
"city": "Douala",
"postal_code": "<string>",
"address_line1": "123 Main St",
"address_line2": "<string>"
},
"billing": {
"country": "CM",
"state": "<string>",
"city": "Douala",
"postal_code": "<string>",
"address_line1": "123 Main St",
"address_line2": "<string>"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: 'john@example.com',
phone: 237600000000,
name: 'John Doe',
company_name: 'ACME Inc',
metadata: {},
address: {
country: 'CM',
state: '<string>',
city: 'Douala',
postal_code: '<string>',
address_line1: '123 Main St',
address_line2: '<string>'
},
billing: {
country: 'CM',
state: '<string>',
city: 'Douala',
postal_code: '<string>',
address_line1: '123 Main St',
address_line2: '<string>'
}
})
};
fetch('https://api.notchpay.co/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.notchpay.co/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([
'email' => 'john@example.com',
'phone' => 237600000000,
'name' => 'John Doe',
'company_name' => 'ACME Inc',
'metadata' => [
],
'address' => [
'country' => 'CM',
'state' => '<string>',
'city' => 'Douala',
'postal_code' => '<string>',
'address_line1' => '123 Main St',
'address_line2' => '<string>'
],
'billing' => [
'country' => 'CM',
'state' => '<string>',
'city' => 'Douala',
'postal_code' => '<string>',
'address_line1' => '123 Main St',
'address_line2' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.notchpay.co/customers"
payload := strings.NewReader("{\n \"email\": \"john@example.com\",\n \"phone\": 237600000000,\n \"name\": \"John Doe\",\n \"company_name\": \"ACME Inc\",\n \"metadata\": {},\n \"address\": {\n \"country\": \"CM\",\n \"state\": \"<string>\",\n \"city\": \"Douala\",\n \"postal_code\": \"<string>\",\n \"address_line1\": \"123 Main St\",\n \"address_line2\": \"<string>\"\n },\n \"billing\": {\n \"country\": \"CM\",\n \"state\": \"<string>\",\n \"city\": \"Douala\",\n \"postal_code\": \"<string>\",\n \"address_line1\": \"123 Main St\",\n \"address_line2\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.notchpay.co/customers")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"john@example.com\",\n \"phone\": 237600000000,\n \"name\": \"John Doe\",\n \"company_name\": \"ACME Inc\",\n \"metadata\": {},\n \"address\": {\n \"country\": \"CM\",\n \"state\": \"<string>\",\n \"city\": \"Douala\",\n \"postal_code\": \"<string>\",\n \"address_line1\": \"123 Main St\",\n \"address_line2\": \"<string>\"\n },\n \"billing\": {\n \"country\": \"CM\",\n \"state\": \"<string>\",\n \"city\": \"Douala\",\n \"postal_code\": \"<string>\",\n \"address_line1\": \"123 Main St\",\n \"address_line2\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.notchpay.co/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"john@example.com\",\n \"phone\": 237600000000,\n \"name\": \"John Doe\",\n \"company_name\": \"ACME Inc\",\n \"metadata\": {},\n \"address\": {\n \"country\": \"CM\",\n \"state\": \"<string>\",\n \"city\": \"Douala\",\n \"postal_code\": \"<string>\",\n \"address_line1\": \"123 Main St\",\n \"address_line2\": \"<string>\"\n },\n \"billing\": {\n \"country\": \"CM\",\n \"state\": \"<string>\",\n \"city\": \"Douala\",\n \"postal_code\": \"<string>\",\n \"address_line1\": \"123 Main St\",\n \"address_line2\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 201,
"status": "Created",
"message": "Customer created successfully",
"customer": "<unknown>"
}API Reference
Create a customer
POST
/
customers
Create a customer
curl --request POST \
--url https://api.notchpay.co/customers \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "john@example.com",
"phone": 237600000000,
"name": "John Doe",
"company_name": "ACME Inc",
"metadata": {},
"address": {
"country": "CM",
"state": "<string>",
"city": "Douala",
"postal_code": "<string>",
"address_line1": "123 Main St",
"address_line2": "<string>"
},
"billing": {
"country": "CM",
"state": "<string>",
"city": "Douala",
"postal_code": "<string>",
"address_line1": "123 Main St",
"address_line2": "<string>"
}
}
'import requests
url = "https://api.notchpay.co/customers"
payload = {
"email": "john@example.com",
"phone": 237600000000,
"name": "John Doe",
"company_name": "ACME Inc",
"metadata": {},
"address": {
"country": "CM",
"state": "<string>",
"city": "Douala",
"postal_code": "<string>",
"address_line1": "123 Main St",
"address_line2": "<string>"
},
"billing": {
"country": "CM",
"state": "<string>",
"city": "Douala",
"postal_code": "<string>",
"address_line1": "123 Main St",
"address_line2": "<string>"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: 'john@example.com',
phone: 237600000000,
name: 'John Doe',
company_name: 'ACME Inc',
metadata: {},
address: {
country: 'CM',
state: '<string>',
city: 'Douala',
postal_code: '<string>',
address_line1: '123 Main St',
address_line2: '<string>'
},
billing: {
country: 'CM',
state: '<string>',
city: 'Douala',
postal_code: '<string>',
address_line1: '123 Main St',
address_line2: '<string>'
}
})
};
fetch('https://api.notchpay.co/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.notchpay.co/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([
'email' => 'john@example.com',
'phone' => 237600000000,
'name' => 'John Doe',
'company_name' => 'ACME Inc',
'metadata' => [
],
'address' => [
'country' => 'CM',
'state' => '<string>',
'city' => 'Douala',
'postal_code' => '<string>',
'address_line1' => '123 Main St',
'address_line2' => '<string>'
],
'billing' => [
'country' => 'CM',
'state' => '<string>',
'city' => 'Douala',
'postal_code' => '<string>',
'address_line1' => '123 Main St',
'address_line2' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.notchpay.co/customers"
payload := strings.NewReader("{\n \"email\": \"john@example.com\",\n \"phone\": 237600000000,\n \"name\": \"John Doe\",\n \"company_name\": \"ACME Inc\",\n \"metadata\": {},\n \"address\": {\n \"country\": \"CM\",\n \"state\": \"<string>\",\n \"city\": \"Douala\",\n \"postal_code\": \"<string>\",\n \"address_line1\": \"123 Main St\",\n \"address_line2\": \"<string>\"\n },\n \"billing\": {\n \"country\": \"CM\",\n \"state\": \"<string>\",\n \"city\": \"Douala\",\n \"postal_code\": \"<string>\",\n \"address_line1\": \"123 Main St\",\n \"address_line2\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.notchpay.co/customers")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"john@example.com\",\n \"phone\": 237600000000,\n \"name\": \"John Doe\",\n \"company_name\": \"ACME Inc\",\n \"metadata\": {},\n \"address\": {\n \"country\": \"CM\",\n \"state\": \"<string>\",\n \"city\": \"Douala\",\n \"postal_code\": \"<string>\",\n \"address_line1\": \"123 Main St\",\n \"address_line2\": \"<string>\"\n },\n \"billing\": {\n \"country\": \"CM\",\n \"state\": \"<string>\",\n \"city\": \"Douala\",\n \"postal_code\": \"<string>\",\n \"address_line1\": \"123 Main St\",\n \"address_line2\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.notchpay.co/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"john@example.com\",\n \"phone\": 237600000000,\n \"name\": \"John Doe\",\n \"company_name\": \"ACME Inc\",\n \"metadata\": {},\n \"address\": {\n \"country\": \"CM\",\n \"state\": \"<string>\",\n \"city\": \"Douala\",\n \"postal_code\": \"<string>\",\n \"address_line1\": \"123 Main St\",\n \"address_line2\": \"<string>\"\n },\n \"billing\": {\n \"country\": \"CM\",\n \"state\": \"<string>\",\n \"city\": \"Douala\",\n \"postal_code\": \"<string>\",\n \"address_line1\": \"123 Main St\",\n \"address_line2\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 201,
"status": "Created",
"message": "Customer created successfully",
"customer": "<unknown>"
}Authorizations
ApiKeyAuthSyncAuth
Body
application/json
Was this page helpful?
⌘I