Paymish Loading Docs Preparing guides, collections, and live API references...
Paymish Docs

Create customer

Topics

Endpoint Overview

Customer

Create customer

Create a new customer record

POST /api/customer-service/external/v1/create Requires authentication

Purpose

Use this endpoint to create customer. It belongs to the Customer collection and is designed for backend integrations.

Request shape

0 parameters and 6 documented body fields using application/json.

Implementation Guide

Recommended workflow

1

Authenticate first and inject a valid bearer token or secret key before calling the endpoint.

2

Validate the input data, identifiers, and account state in your application before making the request.

3

Send the POST request from your backend using the required headers and the expected content type (application/json).

4

Persist the important identifiers returned in the response so later lookups, webhooks, or support actions can be linked correctly.

Implementation notes

  • Validate the request payload on your backend before sending it, especially the 6 documented body fields.
  • Protect state-changing operations with strong validation, logging, and retry rules to avoid duplicate mutations.

Request Body

Content type: application/json

email required
string
Customer's email address Example: customer@example.com
firstName
string
Customer's first name Example: John
lastName
string
Customer's last name Example: Doe
phoneNumber
string
Customer's phone number Example: +1234567890
countryId
number
ID of the customer's country Example: 1
dialingCodeId
number
ID of the dialing code Example: 91

Responses

200 Customer created successfully
400 Bad request

Expected Outcomes

200

Success example

Customer created successfully

Representative Response 
{
  "message": "Create customer successfully."
}
400

Failure example

Bad request

Representative Error 
{
  "error": "Bad request"
}
After the response:
  • Log the Paymish reference or request context returned by the API so support teams can trace the call later.
  • Retry only when the failure is safe to repeat; otherwise correct the payload or auth state first.
  • Store enough internal metadata to match the API response back to your order, payout, case, or checkout record.

Language Notes

Python

Use `requests` from a backend worker, service, or Django/Flask app and centralize headers in a reusable helper.

Node.js

Use `axios` or `fetch` from Node.js services only; do not place secret credentials in frontend bundles.

PHP

Wrap cURL usage in a small client class so auth headers, error handling, and logging stay consistent.

cURL

Use cURL for smoke testing and debugging, then move the final logic into your backend service code.

Code Examples

Python 
import requests

headers = {
    "Authorization": "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
}
payload = {
  "email": "customer@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+1234567890",
  "countryId": 1
}

response = requests.post(
    "https://api.paymish.com/api/customer-service/external/v1/create",
    headers=headers,
    json=payload,
)

data = response.json()
print(data)
Node.js 
const axios = require("axios");

const response = await axios({
  method: "post",
  url: "https://api.paymish.com/api/customer-service/external/v1/create",
  headers: {
    Authorization: "Bearer YOUR_SECRET_KEY",
    "Content-Type": "application/json",
  },
  data: {
  "email": "customer@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+1234567890",
  "countryId": 1
}
});

console.log(response.data);
cURL 
curl https://api.paymish.com/api/customer-service/external/v1/create \
  -X POST \
  -H "Authorization: Bearer YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{   "email": "customer@example.com",   "firstName": "John",   "lastName": "Doe",   "phoneNumber": "+1234567890",   "countryId": 1 }'
PHP 
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.paymish.com/api/customer-service/external/v1/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer YOUR_SECRET_KEY",
    "Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    "email" => "customer@example.com",
    "firstName" => "John",
    "lastName" => "Doe",
    "phoneNumber" => "+1234567890",
    "countryId" => 1,
]));

$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
Previous endpoint get discount codes . Next endpoint Update customer