Cadastrar novo cliente

POST

/api/customers

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Bodyapplication/json

Exemplo

{
    "customer": {
        "name": "Igor Santana",
        "document_type": "cpf",
        "document_number": "738.291.460-78",
        "birthdate": "1990-01-01",
        "phone": "+5511999900123",
        "email": "igor@example.com"
    },
    "payer": {
        "name": "João",
        "document_number": "cpf",
        "phone": "+5511987654321",
        "email": "joao@example.com"
    },
    "business": {
        "company_name": "Igor Santana Consultoria LTDA",
        "document_type": "cnpj",
        "document_number": "14.274.133/0001-60",
        "email": "geral@empresa.com.br",
        "phone": "+551130111234",
        "street": "Rua Topázio Imperial",
        "neighborhood": "Gilberto Mestrinho",
        "number": "123",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "zipcode": "69006427"
    }
}

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sandbox.enterpay.com.br/api/customers' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customer": {
        "name": "Igor Santana",
        "document_type": "cpf",
        "document_number": "738.291.460-78",
        "birthdate": "1990-01-01",
        "phone": "+5511999900123",
        "email": "igor@example.com"
    },
    "payer": {
        "name": "João",
        "document_number": "cpf",
        "phone": "+5511987654321",
        "email": "joao@example.com"
    },
    "business": {
        "company_name": "Igor Santana Consultoria LTDA",
        "document_type": "cnpj",
        "document_number": "14.274.133/0001-60",
        "email": "geral@empresa.com.br",
        "phone": "+551130111234",
        "street": "Rua Topázio Imperial",
        "neighborhood": "Gilberto Mestrinho",
        "number": "123",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "zipcode": "69006427"
    }
}'

Respostas

🟢200Success

application/json

Body

Exemplo

{
    "success": true,
    "message": "Operação realizada com sucesso.",
    "data": {
        "name": "Igor Santana",
        "document_type": "cpf",
        "document_number": "738.291.460-78",
        "birthdate": "1990-01-01",
        "phone": "+5511999900123",
        "email": "igr.amaral@gmail.com",
        "updated_at": "2024-10-03T20:44:16.000000Z",
        "created_at": "2024-10-03T20:44:16.000000Z",
        "id": 1
    }
}

Modificado em 2024-10-04 21:07:38

Página anterior

Listar meus clientes

Próxima página

Atualizar dados do cliente