Create a new customer account
curl --request POST \
--url https://api-production.fossapay.com/api/v1/customers \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"emailAddress": "jsmith@example.com",
"mobileNumber": "<string>",
"dateOfBirth": "2023-12-25",
"address": "<string>",
"city": "<string>",
"country": "<string>",
"type": "individual",
"middleName": "<string>",
"metadata": {}
}
'import requests
url = "https://api-production.fossapay.com/api/v1/customers"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"emailAddress": "jsmith@example.com",
"mobileNumber": "<string>",
"dateOfBirth": "2023-12-25",
"address": "<string>",
"city": "<string>",
"country": "<string>",
"type": "individual",
"middleName": "<string>",
"metadata": {}
}
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: '<string>',
lastName: '<string>',
emailAddress: 'jsmith@example.com',
mobileNumber: '<string>',
dateOfBirth: '2023-12-25',
address: '<string>',
city: '<string>',
country: '<string>',
type: 'individual',
middleName: '<string>',
metadata: {}
})
};
fetch('https://api-production.fossapay.com/api/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-production.fossapay.com/api/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' => '<string>',
'lastName' => '<string>',
'emailAddress' => 'jsmith@example.com',
'mobileNumber' => '<string>',
'dateOfBirth' => '2023-12-25',
'address' => '<string>',
'city' => '<string>',
'country' => '<string>',
'type' => 'individual',
'middleName' => '<string>',
'metadata' => [
]
]),
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-production.fossapay.com/api/v1/customers"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"mobileNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"type\": \"individual\",\n \"middleName\": \"<string>\",\n \"metadata\": {}\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-production.fossapay.com/api/v1/customers")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"mobileNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"type\": \"individual\",\n \"middleName\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-production.fossapay.com/api/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\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"mobileNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"type\": \"individual\",\n \"middleName\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"statusCode": 123,
"message": "<string>",
"data": {
"id": "<string>",
"businessId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"middleName": "<string>",
"emailAddress": "jsmith@example.com",
"mobileNumber": "<string>",
"dateOfBirth": "2023-12-25",
"address": "<string>",
"city": "<string>",
"country": "<string>",
"customerType": "individual",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"status": "<string>",
"statusCode": 123,
"message": "<string>",
"error": "<string>",
"code": "<string>",
"errors": {}
}{
"status": "<string>",
"statusCode": 123,
"message": "<string>",
"error": "<string>",
"code": "<string>",
"errors": {}
}Third Party Customers
Create a new customer account
POST
/
api
/
v1
/
customers
Create a new customer account
curl --request POST \
--url https://api-production.fossapay.com/api/v1/customers \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"emailAddress": "jsmith@example.com",
"mobileNumber": "<string>",
"dateOfBirth": "2023-12-25",
"address": "<string>",
"city": "<string>",
"country": "<string>",
"type": "individual",
"middleName": "<string>",
"metadata": {}
}
'import requests
url = "https://api-production.fossapay.com/api/v1/customers"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"emailAddress": "jsmith@example.com",
"mobileNumber": "<string>",
"dateOfBirth": "2023-12-25",
"address": "<string>",
"city": "<string>",
"country": "<string>",
"type": "individual",
"middleName": "<string>",
"metadata": {}
}
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: '<string>',
lastName: '<string>',
emailAddress: 'jsmith@example.com',
mobileNumber: '<string>',
dateOfBirth: '2023-12-25',
address: '<string>',
city: '<string>',
country: '<string>',
type: 'individual',
middleName: '<string>',
metadata: {}
})
};
fetch('https://api-production.fossapay.com/api/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-production.fossapay.com/api/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' => '<string>',
'lastName' => '<string>',
'emailAddress' => 'jsmith@example.com',
'mobileNumber' => '<string>',
'dateOfBirth' => '2023-12-25',
'address' => '<string>',
'city' => '<string>',
'country' => '<string>',
'type' => 'individual',
'middleName' => '<string>',
'metadata' => [
]
]),
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-production.fossapay.com/api/v1/customers"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"mobileNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"type\": \"individual\",\n \"middleName\": \"<string>\",\n \"metadata\": {}\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-production.fossapay.com/api/v1/customers")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"mobileNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"type\": \"individual\",\n \"middleName\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-production.fossapay.com/api/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\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"mobileNumber\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"type\": \"individual\",\n \"middleName\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"statusCode": 123,
"message": "<string>",
"data": {
"id": "<string>",
"businessId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"middleName": "<string>",
"emailAddress": "jsmith@example.com",
"mobileNumber": "<string>",
"dateOfBirth": "2023-12-25",
"address": "<string>",
"city": "<string>",
"country": "<string>",
"customerType": "individual",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"status": "<string>",
"statusCode": 123,
"message": "<string>",
"error": "<string>",
"code": "<string>",
"errors": {}
}{
"status": "<string>",
"statusCode": 123,
"message": "<string>",
"error": "<string>",
"code": "<string>",
"errors": {}
}Authorizations
Body
application/json

