v1

latestOpenAPI 3.0.02026-07-26168846732.2 KB

Customers

Customers - Create

Creates a customer object and stores the customer details to be reused for future payments. Incase the customer already exists in the system, this API will respond with the customer details.

post/customers

Request body

merchant_reference_idstring nullable

The merchant identifier for the customer object.

namestring required

The customer's name

emailstring required

The customer's email address

phonestring nullable

The customer's phone number

descriptionstring nullable

An arbitrary string that you can attach to a customer object.

phone_country_codestring nullable

The country code for the customer phone number

metadataobject nullable

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.

tax_registration_idstring nullable

The customer's tax registration number.

Example request

{
  "merchant_reference_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
  "name": "Jon Test",
  "email": "JonTest@test.com",
  "phone": "9123456789",
  "description": "First Customer",
  "phone_country_code": "+65",
  "default_billing_address": {
    "city": "New York",
    "line1": "123, King Street",
    "line2": "Powelson Avenue",
    "line3": "Bridgewater",
    "zip": "08807",
    "state": "New York",
    "first_name": "John",
    "last_name": "Doe",
    "origin_zip": "08807"
  },
  "default_shipping_address": {
    "city": "New York",
    "line1": "123, King Street",
    "line2": "Powelson Avenue",
    "line3": "Bridgewater",
    "zip": "08807",
    "state": "New York",
    "first_name": "John",
    "last_name": "Doe",
    "origin_zip": "08807"
  },
  "tax_registration_id": "123456789",
  "document_details": {
    "document_number": "12345678911"
  }
}

Response

Customer Created

idstring required

Unique identifier for the customer

merchant_reference_idstring required

The identifier for the customer object

connector_customer_idsobject nullable

Connector specific customer reference ids

namestring nullable

The customer's name

emailstring nullable

The customer's email address

phonestring nullable

The customer's phone number

phone_country_codestring nullable

The country code for the customer phone number

descriptionstring nullable

An arbitrary string that you can attach to a customer object.

created_atstring date-time required

A timestamp (ISO 8601 code) that determines when the customer was created

metadataobject nullable

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object.

default_payment_method_idstring nullable

The identifier for the default payment method.

tax_registration_idstring nullable

The customer's tax registration number.

Example response

{
  "id": "0a_cus_01926c58bc6e77c09e809964e72af8c8",
  "merchant_reference_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
  "name": "Jon Test",
  "email": "JonTest@test.com",
  "phone": "9123456789",
  "phone_country_code": "+65",
  "description": "First Customer",
  "default_billing_address": {
    "city": "New York",
    "line1": "123, King Street",
    "line2": "Powelson Avenue",
    "line3": "Bridgewater",
    "zip": "08807",
    "state": "New York",
    "first_name": "John",
    "last_name": "Doe",
    "origin_zip": "08807"
  },
  "default_shipping_address": {
    "city": "New York",
    "line1": "123, King Street",
    "line2": "Powelson Avenue",
    "line3": "Bridgewater",
    "zip": "08807",
    "state": "New York",
    "first_name": "John",
    "last_name": "Doe",
    "origin_zip": "08807"
  },
  "created_at": "2023-01-18T11:04:09.922Z",
  "default_payment_method_id": "0a_pm_01926c58bc6e77c09e809964e72af8c8",
  "tax_registration_id": "123456789",
  "document_details": {
    "document_number": "12345678911"
  }
}