Introduction

Authentication

Test cards

Establishments

Users

Customers

Cards

Payment links

Error codes

Payment Split

Products

Discount Coupons

Sales

Signatures

Webhooks

Financial

On this page:

To add a customer to the API, you need to create a request with the POST method containing specific fields, as described in the example request below. We emphasize that for the request to be successful, the input data types must comply with the field descriptions. You can view our List of Field Descriptions below.

POST Create customer

https://api.premepay.com/v1/stores/:id/customers

List of Parameters

Parameters Type Description Required
firstName string First name or Corporate name Yes
surname string Surname No
identificationNumber string CPF or CNPJ No
birthdate date Birth date No
email string Email Yes
phone string Telefone No
address object Addresss No
street string Street No
number string Number No
reference string Reference No
district string District No
city string City No
state int State No
country int Country No
zipcode string Zip code No

Request example

This is an example of how your request to register a new customer should look like:

Response

If your request is successful, you will receive the customer object as the response.

Related Content

<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/bfe6a9ef-6d9a-405e-9fbe-484666d3fb5e/PUT.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/bfe6a9ef-6d9a-405e-9fbe-484666d3fb5e/PUT.png" width="40px" /> PUT - Edit customer

</aside>

<aside> <img src="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/a22a31f7-bd92-40af-8042-7685c0c0859a/GET.png" alt="https://s3-us-west-2.amazonaws.com/secure.notion-static.com/a22a31f7-bd92-40af-8042-7685c0c0859a/GET.png" width="40px" /> GET - List customers

</aside>