---
title: "Create Customer"
method: POST
path: "/"
---

# Create Customer

`POST /`

## Request

- Base URL: `https://api-sandbox.payretailers.com/api/v1/customers`
- URL: `https://api-sandbox.payretailers.com/api/v1/customers/`
- Auth: HTTP basic

## Headers

- `Ocp-Apim-Subscription-Key` string, required

## Request body

- object
  - `uniqueCustomerIdentifier` string: <strong style="color:red">Required if a personalId is not provided</strong><br>Your unique identifier for the Customer
  - `notificationUrl` string, required: The URL where the Customer event webhooks will be sent.
  - `country` string, required: Country of the Customer
  - `personalId` string: <strong style="color:red">Required if a uniqueCustomerIdentifier is not provided</strong><br>Personal Id of the Customer.
  - `firstName` string: The customer's first name. Numbers and special characters are not allowed, except þ, ð, ç, ñ, accent marks (´, `, á, é, í, ó, ú, à, è, ì, ò, ù, ä, ë, ï, ö, ü, â, ê, î, ô, û), diacritical marks (~), diaereses (ë), hyphens (-), commas (,) and apostrophe (').<br>**Length:** up to 30 chars
  - `lastName` string: The customer's last name. Numbers and special characters are not allowed, except þ, ð, ç, ñ, accent marks (´, `, á, é, í, ó, ú, à, è, ì, ò, ù, ä, ë, ï, ö, ü, â, ê, î, ô, û), diacritical marks (~), diaereses (ë), hyphens (-), commas (,) and apostrophe (').<br>**Length:** up to 30 chars
  - `address` string: The user's address.<br>**Length:** up to 255 chars
  - `city` string: The user's city. Numbers and special characters are not allowed, except for þ, ð, ç, ñ, accent marks (á, à, é, ó, ô, â), diacritical marks (~), diaereses (ë), dashes (-), commas (,) and apostrophe (').<br>**Length:** up to 60 chars.
  - `zip` string: The Customer's post code. Only numbers and "-" are allowed. Special characters, such as +,$,() and letters [A-Z], are not allowed
  - `state` string: The Customer's state or province.
  - `phone` string: The Customer's phone number. Numbers and special characters, such as +,-, and (), are allowed.<br>**Length:** from 7 to 15 digits
  - `email` string: The customer's email address. Will be used by the system to send checkout instructions.
  - `language` string, required: The Customer's language.
  - `registeredAccounts` object[]: An array of the accounts registered for the Customer.
    - `bankName` string: Name of the Customer's bank
    - `accountNumber` string: Customer's account number
    - `accountAgencyNumber` string: Customer's account agency number
    - `accountTypeCode` string: Customer's account type code

## Response `202`

202

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/payretailers/apis/customer-module.md) - [All operations](https://skmtc.dev/payretailers/apis/customer-module/llms.txt) - [OpenAPI document](https://skmtc.dev/payretailers/apis/customer-module/revisions/62c025878cdb?raw)