API Reference

Referência

Gerencie seus clientes, aqueles que pagam você.

Um cliente é seu usuário final, aquele que você vai cobrar e pagar o seu produto.

Estrutura

Um cliente é representado em nossa API pela seguinte estrutura:

{
  "id": "cust_aebxkhDZNaMmJeKsy0AHS0FQ",
  "metadata": {
    "name": "Test Customer",
    "cellphone": "11999999999",
    "taxId": "12345678900",
    "email": "[email protected]"
  }
}

Atributos

id string
Id único do cliente na AbacatePay


metadata object
Objeto com os dados do cliente

  • name string
    Nome do cliente (obrigatório)
  • cellphone string
    Telefone do cliente (obrigatório)
  • taxId string
    Documento do cliente, podendo ser CPF ou CNPJ (obrigatório)
  • email string
    E-mail do cliente (obrigatório)

📘

Clientes são únicos por CPF

Não é possível criar um cliente com CPF inválido e caso já exista um cliente com esse CPF, a API não criará o cliente novo mas retornará o cliente já existente