ABabacatepay

Criar um cliente

Changed on

Permite que você crie um cliente para a sua loja.

Campo obrigatório: Apenas o email é obrigatório para criar um cliente.

Recomendado: Embora os demais campos sejam opcionais, é altamente recomendado fornecer name, cellphone, taxId e zipCode quando disponíveis, pois essas informações melhoram a experiência do cliente no checkout e facilitam a identificação.

post/customers/create

Request

  • Base URL
    https://api.abacatepay.com/v2
  • URL
    https://api.abacatepay.com/v2/customers/create
  • Auth
    HTTP bearer

Request body

emailstring required

E-mail do cliente (obrigatório)

namestring

Nome completo do seu cliente (opcional)

cellphonestring

Celular do cliente (opcional)

taxIdstring

CPF ou CNPJ válido do cliente (opcional)

zipCodestring

CEP do cliente (opcional)

metadataobject

Metadados adicionais do cliente. Campo livre para a sua aplicação (opcional). Os valores precisam ser texto: número ou objeto é recusado.

Example request

{
  "email": "daniel_lima@abacatepay.com"
}

Response

Cliente criado com sucesso.

errorstring nullable
successboolean

Se a requisição obteve sucesso ou não.

Example response

{
  "data": {
    "id": "cust_aebxkhDZNaMmJeKsy0AHS0FQ",
    "devMode": true,
    "name": "Daniel Lima",
    "cellphone": "(11) 4002-8922",
    "email": "daniel_lima@abacatepay.com",
    "taxId": "11144477735",
    "country": "BR",
    "zipCode": "01310-100",
    "address": {
      "zipCode": "01310-100",
      "street": "Avenida Paulista",
      "number": "1000",
      "neighborhood": "Bela Vista",
      "city": "São Paulo",
      "state": "SP",
      "complement": "Sala 12"
    },
    "metadata": {
      "source": "landing-page",
      "campaign": "black-friday-2025"
    }
  },
  "success": true
}

Changes

  • 319122d4f5fcRevision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status