Create Customer - API Documentation

Create customer profile to save the payment methods a customer can use, facilitating recurring transactions and track their payment history. A customer object is beneficial to store a card token for subscriptions or create a customer wallet to manage their funds.

Each POST/PATCH Request requires a Signature in the header, you can follow the following code to create the Signature:

const signature = cryptoJs.HmacSHA256(
    cryptoJs.enc.Utf8.parse(JSON.stringfy(body)),
    cryptoJs.enc.Utf8.parse(signatureKey)
).toString();

Request

Header Params

X-token

string

required

Merchat Identifier Id

signature

string

required

Hash your string payload request using SHA256, and use your SignatureKey as key

Body Params application/json

description

string

required

type

object

required

organization_reference_id

string

optional

metadata

object

optional

company

object

optional

name

string

required

registration_number

string

required

incorporation_country

string

required

company_email

string

optional

address_line1

string

optional

address_line2

string

optional

address_city

string

optional

address_state

string

optional

address_country

string

required

address_zip_code

string

optional

phone_country_code

string

optional

phone_number

string

optional

authorized_user

object

optional

individual

object

optional

first_name

string

required

last_name

string

required

dob

string

optional

string

optional

identification_type

string

optional

identification_value

string

optional

address_line1

string

optional

address_line2

string

optional

address_city

string

optional

address_state

string

optional

address_country

string

required

address_zip_code

string

optional

country_of_residence

string

optional

nationality

string

optional

phone_country_code

string

optional

phone_number

string

optional

Example

{
  "description": "string",
  "type": {},
  "organization_reference_id": "string",
  "metadata": {},
  "company": {
    "name": "string",
    "registration_number": "string",
    "incorporation_country": "string",
    "company_email": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_city": "string",
    "address_state": "string",
    "address_country": "string",
    "address_zip_code": "string",
    "phone_country_code": "string",
    "phone_number": "string",
    "authorized_user": {
      "first_name": "string",
      "email": "string",
      "last_name": "string",
      "dob": "string",
      "identification_type": "string",
      "identification_value": "string",
      "nationality": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_state": "string",
      "address_city": "string",
      "address_country": "string",
      "address_zip_code": "string",
      "country_of_residence": "string",
      "phone_country_code": "string",
      "phone_number": "string"
    }
  },
  "individual": {
    "first_name": "string",
    "last_name": "string",
    "dob": "string",
    "email": "string",
    "identification_type": "string",
    "identification_value": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_city": "string",
    "address_state": "string",
    "address_country": "string",
    "address_zip_code": "string",
    "country_of_residence": "string",
    "nationality": "string",
    "phone_country_code": "string",
    "phone_number": "string"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.paycombat.com/api/v1/customer/create' \
--header 'X-token;' \
--header 'signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "string",
    "type": {},
    "organization_reference_id": "string",
    "metadata": {},
    "company": {
        "name": "string",
        "registration_number": "string",
        "incorporation_country": "string",
        "company_email": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_city": "string",
        "address_state": "string",
        "address_country": "string",
        "address_zip_code": "string",
        "phone_country_code": "string",
        "phone_number": "string",
        "authorized_user": {
            "first_name": "string",
            "email": "string",
            "last_name": "string",
            "dob": "string",
            "identification_type": "string",
            "identification_value": "string",
            "nationality": "string",
            "address_line1": "string",
            "address_line2": "string",
            "address_state": "string",
            "address_city": "string",
            "address_country": "string",
            "address_zip_code": "string",
            "country_of_residence": "string",
            "phone_country_code": "string",
            "phone_number": "string"
        }
    },
    "individual": {
        "first_name": "string",
        "last_name": "string",
        "dob": "string",
        "email": "string",
        "identification_type": "string",
        "identification_value": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_city": "string",
        "address_state": "string",
        "address_country": "string",
        "address_zip_code": "string",
        "country_of_residence": "string",
        "nationality": "string",
        "phone_country_code": "string",
        "phone_number": "string"
    }
}'

Responses

🟢200Success

application/json

Body

status

boolean

required

message

string

required

data

object

required

customer_id

string

required

org_id

string

required

type

string

required

description

string

required

webhook_url

string

required

metadata

object

required

is_active

boolean

required

is_wallet_ready

boolean

required

organization_reference_id

string

required

is_gca_enabled

boolean

required

gca_activation_status

string

required

gca_activated_at

object

required

is_sender_validation_enabled

boolean

required

payin_sender_id_list

object

required

company_domain

object

required

individual

object

required

created_by

string

required

created_at

string

required

updated_at

string

required

Example

{
  "status": true,
  "message": "string",
  "data": {
    "customer_id": "string",
    "org_id": "string",
    "type": "string",
    "description": "string",
    "webhook_url": "string",
    "metadata": {},
    "is_active": true,
    "is_wallet_ready": true,
    "organization_reference_id": "string",
    "is_gca_enabled": true,
    "gca_activation_status": "string",
    "gca_activated_at": {},
    "is_sender_validation_enabled": true,
    "payin_sender_id_list": {},
    "company_domain": {},
    "individual": {
      "first_name": "string",
      "last_name": "string",
      "dob": "string",
      "email": "string",
      "identification_type": "string",
      "identification_value": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_city": "string",
      "address_state": "string",
      "address_country": "string",
      "address_zip_code": "string",
      "country_of_residence": "string",
      "nationality": "string",
      "phone_country_code": "string",
      "phone_number": "string"
    },
    "created_by": "string",
    "created_at": "string",
    "updated_at": "string"
  }
}

🟠400Bad Request