EnterPay API Docs V1
  1. Clientes
EnterPay API Docs V1
  • Referência de API
  • Autenticação
  • Erros
  • Clientes
    • Buscar um cliente
      GET
    • Listar meus clientes
      GET
    • Cadastrar novo cliente
      POST
    • Atualizar dados do cliente
      PUT
    • Remover cliente
      DELETE
  • Cobrança
    • Listar minhas cobranças
      GET
    • Criar uma nova cobrança
      POST
  • Configurações da conta
    • Empresa
      • Atualizar dados da empresa
      • Obter informações da empresa
    • Customização
      • Atualizar dados de customização
      • Obter dados de customização
  • Webhook
    • UpdateStatus
      POST
  1. Clientes

Atualizar dados do cliente

PUT
/api/customers/1

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": "João Ferraz",
        "document_type": "cpf",
        "document_number": "001.002.003-04",
        "birthdate": "1990-01-01",
        "phone": "+5511998100102",
        "email": "joaoferraz@example.com"
    },
    "payer": {
        "name": "João Ferraz",
        "document_number": "999.999.999-99",
        "phone": "+5573999962753",
        "email": "financeiro@example.com"
    },
    "business": {
        "company_name": "Empresa Ferraz",
        "document_type": "cnpj",
        "document_number": "99.999.999/0001-99",
        "email": "financeiro@example.com.br",
        "phone": "+551130136565"
    },
    "business_address": {
        "street": "Rua Olavo",
        "number": "100",
        "neighborhood": "Centro",
        "city": "São Paulo",
        "state": "SP",
        "country": "Brazil"
    }
}

Códigos de solicitação

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://sandbox.enterpay.com.br/api/customers/1' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customer": {
        "name": "João Ferraz",
        "document_type": "cpf",
        "document_number": "001.002.003-04",
        "birthdate": "1990-01-01",
        "phone": "+5511998100102",
        "email": "joaoferraz@example.com"
    },
    "payer": {
        "name": "João Ferraz",
        "document_number": "999.999.999-99",
        "phone": "+5573999962753",
        "email": "financeiro@example.com"
    },
    "business": {
        "company_name": "Empresa Ferraz",
        "document_type": "cnpj",
        "document_number": "99.999.999/0001-99",
        "email": "financeiro@example.com.br",
        "phone": "+551130136565"
    },
    "business_address": {
        "street": "Rua Olavo",
        "number": "100",
        "neighborhood": "Centro",
        "city": "São Paulo",
        "state": "SP",
        "country": "Brazil"
    }
}'

Respostas

🟢200Success
application/json
Body

Exemplo
{
    "success": true,
    "message": "Operação realizada com sucesso.",
    "data": {
        "id": 1,
        "name": "João Ferraz",
        "document_type": "cpf",
        "document_number": "001.002.003-04",
        "birthdate": "1990-01-01",
        "phone": "+5511998100102",
        "email": "joaoferraz@example.com",
        "document_file": null,
        "social_contract_file": null,
        "proof_residence_file": null,
        "created_at": "2024-10-03T20:44:16.000000Z",
        "updated_at": "2024-10-04T20:17:49.000000Z",
        "deleted_at": null,
        "customer_business": {
            "id": 1,
            "company_name": "Empresa Ferraz",
            "document_type": "cnpj",
            "document_number": "99.999.999/0001-99",
            "email": "financeiro@example.com.br",
            "phone": "+551130136565",
            "address_id": 3,
            "created_at": "2024-10-03T20:44:14.000000Z",
            "updated_at": "2024-10-04T20:17:49.000000Z",
            "deleted_at": null,
            "address": {
                "id": 3,
                "street": "Rua Olavo",
                "number": "100",
                "neighborhood": "Centro",
                "city": "São Paulo",
                "state": "SP",
                "country": "Brazil",
                "zipcode": "69006427",
                "created_at": "2024-10-03T20:44:14.000000Z",
                "updated_at": "2024-10-04T20:17:49.000000Z",
                "deleted_at": null
            }
        },
        "customer_payer": {
            "id": 1,
            "name": "João Ferraz",
            "document_type": "cpf",
            "document_number": "999.999.999-99",
            "phone": "+5573999962753",
            "email": "joaoferraz@example.com",
            "created_at": "2024-10-03T20:44:14.000000Z",
            "updated_at": "2024-10-04T20:17:49.000000Z",
            "deleted_at": null
        }
    }
}
Modificado em 2024-10-04 20:34:48
Página anterior
Cadastrar novo cliente
Próxima página
Remover cliente
Built with