Customers

Create and manage customers

Customers - Create

POST

https://paysw-wiki.lab.next-on.pro/dev-router

/customers

api-key (header)

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.

Customers - Create › Request Body

The customer details

CustomerRequest

customer_id

string | null · minLength: 1 · maxLength: 64

The identifier for the customer object. If not provided the customer ID will be autogenerated.

Example: cus_y3oqhf46pyzuxjbcn2giaqnb44

name

string | null · maxLength: 255

The customer's name

Example: Jon Test

email

string | null · maxLength: 255

The customer's email address

Example: JonTest@test.com

phone

string | null · maxLength: 255

The customer's phone number

Example: 9123456789

description

string | null · maxLength: 255

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

Example: First Customer

phone_country_code

string | null · maxLength: 255

The country code for the customer phone number

Example: +65

object

Address details

metadata

object | null

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_id

string | null · maxLength: 255

Customer's tax registration ID

Example: 123456789

object

Customers - Create › Responses

Customer Created

CustomerResponse

customer_id

string · minLength: 1 · maxLength: 64 · required

The identifier for the customer object

Example: cus_y3oqhf46pyzuxjbcn2giaqnb44

created_at

string · date-time · required

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

Example: 2023-01-18T11:04:09.922Z

name

string | null · maxLength: 255

The customer's name

Example: Jon Test

email

string | null · maxLength: 255

The customer's email address

Example: JonTest@test.com

phone

string | null · maxLength: 255

The customer's phone number

Example: 9123456789

phone_country_code

string | null · maxLength: 255

The country code for the customer phone number

Example: +65

description

string | null · maxLength: 255

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

Example: First Customer

object

Address details

metadata

object | null

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_id

string | null · maxLength: 64

The identifier for the default payment method.

Example: pm_djh2837dwduh890123

tax_registration_id

string | null · maxLength: 255

The customer's tax registration number.

Example: 123456789

object

POST/customers

curl https://paysw-wiki.lab.next-on.pro/dev-router/customers \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "email": "guest@example.com",
  "name": "John Doe"
}'

Example Request Body

{
  "email": "guest@example.com",
  "name": "John Doe"
}

json

application/json

Example Responses

{
  "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
  "name": "Jon Test",
  "email": "JonTest@test.com",
  "phone": "9123456789",
  "phone_country_code": "+65",
  "description": "First Customer",
  "address": {
    "city": "New York",
    "country": "AF",
    "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",
  "metadata": {},
  "default_payment_method_id": "pm_djh2837dwduh890123",
  "tax_registration_id": "123456789",
  "document_details": {
    "document_type": "cpf",
    "document_number": "12345678911"
  }
}

json

application/json

Customers - Retrieve

GET

https://paysw-wiki.lab.next-on.pro/dev-router

/customers/{customer_id}

api-key (header)

Retrieves a customer's details.

Customers - Retrieve › path Parameters

customer_id

string · required

The unique identifier for the Customer

Customers - Retrieve › Responses

Customer Retrieved

CustomerResponse

customer_id

string · minLength: 1 · maxLength: 64 · required

The identifier for the customer object

Example: cus_y3oqhf46pyzuxjbcn2giaqnb44

created_at

string · date-time · required

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

Example: 2023-01-18T11:04:09.922Z

name

string | null · maxLength: 255

The customer's name

Example: Jon Test

email

string | null · maxLength: 255

The customer's email address

Example: JonTest@test.com

phone

string | null · maxLength: 255

The customer's phone number

Example: 9123456789

phone_country_code

string | null · maxLength: 255

The country code for the customer phone number

Example: +65

description

string | null · maxLength: 255

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

Example: First Customer

object

Address details

metadata

object | null

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_id

string | null · maxLength: 64

The identifier for the default payment method.

Example: pm_djh2837dwduh890123

tax_registration_id

string | null · maxLength: 255

The customer's tax registration number.

Example: 123456789

object

GET/customers/{customer_id}

curl https://paysw-wiki.lab.next-on.pro/dev-router/customers/:customer_id \
  --header 'api-key: <api-key>'

Example Responses

{
  "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
  "name": "Jon Test",
  "email": "JonTest@test.com",
  "phone": "9123456789",
  "phone_country_code": "+65",
  "description": "First Customer",
  "address": {
    "city": "New York",
    "country": "AF",
    "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",
  "metadata": {},
  "default_payment_method_id": "pm_djh2837dwduh890123",
  "tax_registration_id": "123456789",
  "document_details": {
    "document_type": "cpf",
    "document_number": "12345678911"
  }
}

json

application/json

Customers - Update

POST

https://paysw-wiki.lab.next-on.pro/dev-router

/customers/{customer_id}

api-key (header)

Updates the customer's details in a customer object.

Customers - Update › path Parameters

customer_id

string · required

The unique identifier for the Customer

Customers - Update › Request Body

The identifier for the customer object. If not provided the customer ID will be autogenerated.

CustomerUpdateRequest

name

string | null · maxLength: 255

The customer's name

Example: Jon Test

email

string | null · maxLength: 255

The customer's email address

Example: JonTest@test.com

phone

string | null · maxLength: 255

The customer's phone number

Example: 9123456789

description

string | null · maxLength: 255

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

Example: First Customer

phone_country_code

string | null · maxLength: 255

The country code for the customer phone number

Example: +65

object

Address details

metadata

object | null

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_id

string | null · maxLength: 255

Customer's tax registration ID

Example: 123456789

object

Customers - Update › Responses

Customer was Updated

CustomerResponse

customer_id

string · minLength: 1 · maxLength: 64 · required

The identifier for the customer object

Example: cus_y3oqhf46pyzuxjbcn2giaqnb44

created_at

string · date-time · required

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

Example: 2023-01-18T11:04:09.922Z

name

string | null · maxLength: 255

The customer's name

Example: Jon Test

email

string | null · maxLength: 255

The customer's email address

Example: JonTest@test.com

phone

string | null · maxLength: 255

The customer's phone number

Example: 9123456789

phone_country_code

string | null · maxLength: 255

The country code for the customer phone number

Example: +65

description

string | null · maxLength: 255

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

Example: First Customer

object

Address details

metadata

object | null

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_id

string | null · maxLength: 64

The identifier for the default payment method.

Example: pm_djh2837dwduh890123

tax_registration_id

string | null · maxLength: 255

The customer's tax registration number.

Example: 123456789

object

POST/customers/{customer_id}

curl https://paysw-wiki.lab.next-on.pro/dev-router/customers/:customer_id \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "email": "guest@example.com",
  "name": "John Doe"
}'

Example Request Body

{
  "email": "guest@example.com",
  "name": "John Doe"
}

json

application/json

Example Responses

{
  "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
  "name": "Jon Test",
  "email": "JonTest@test.com",
  "phone": "9123456789",
  "phone_country_code": "+65",
  "description": "First Customer",
  "address": {
    "city": "New York",
    "country": "AF",
    "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",
  "metadata": {},
  "default_payment_method_id": "pm_djh2837dwduh890123",
  "tax_registration_id": "123456789",
  "document_details": {
    "document_type": "cpf",
    "document_number": "12345678911"
  }
}

json

application/json

Customers - Delete

DELETE

https://paysw-wiki.lab.next-on.pro/dev-router

/customers/{customer_id}

api-key (header)

Delete a customer record.

Customers - Delete › path Parameters

customer_id

string · required

The unique identifier for the Customer

Customers - Delete › Responses

Customer was Deleted

CustomerDeleteResponse

customer_id

string · maxLength: 255 · required

The identifier for the customer object

Example: cus_y3oqhf46pyzuxjbcn2giaqnb44

customer_deleted

boolean · required

Whether customer was deleted or not

Example: false

address_deleted

boolean · required

Whether address was deleted or not

Example: false

payment_methods_deleted

boolean · required

Whether payment methods deleted or not

Example: false

Customers - List

GET

https://paysw-wiki.lab.next-on.pro/dev-router

/customers/list

api-key (header)

Lists all the customers for a particular merchant id.

Customers - List › query Parameters

offset

integer | null · int32 · min: 0

Offset for pagination

limit

integer | null · int32 · min: 0

Limit for pagination

Customers - List › Responses

Customers retrieved

CustomerResponse[]

CustomerResponse

customer_id

string · minLength: 1 · maxLength: 64 · required

The identifier for the customer object

Example: cus_y3oqhf46pyzuxjbcn2giaqnb44

created_at

string · date-time · required

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

Example: 2023-01-18T11:04:09.922Z

name

string | null · maxLength: 255

The customer's name

Example: Jon Test

email

string | null · maxLength: 255

The customer's email address

Example: JonTest@test.com

phone

string | null · maxLength: 255

The customer's phone number

Example: 9123456789

phone_country_code

string | null · maxLength: 255

The country code for the customer phone number

Example: +65

description

string | null · maxLength: 255

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

Example: First Customer

object

Address details

metadata

object | null

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_id

string | null · maxLength: 64

The identifier for the default payment method.

Example: pm_djh2837dwduh890123

tax_registration_id

string | null · maxLength: 255

The customer's tax registration number.

Example: 123456789

object

GET/customers/list

curl https://paysw-wiki.lab.next-on.pro/dev-router/customers/list \
  --header 'api-key: <api-key>'

Example Responses

[
  {
    "customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
    "name": "Jon Test",
    "email": "JonTest@test.com",
    "phone": "9123456789",
    "phone_country_code": "+65",
    "description": "First Customer",
    "address": {
      "city": "New York",
      "country": "AF",
      "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",
    "metadata": {},
    "default_payment_method_id": "pm_djh2837dwduh890123",
    "tax_registration_id": "123456789",
    "document_details": {
      "document_type": "cpf",
      "document_number": "12345678911"
    }
  }
]

json

application/json

Mandates Payment Methods