Customers
Criar cliente
API SDK Documentação - Customers
Crie clientes para vincular em suas cobranças.
Método
import { Malga } from 'malga'
const malga = new Malga({
apiKey: '17a64c8f-a387-4682-bdd8-d280493715e0',
clientId: 'd1d2b51a-0446-432a-b055-034518c2660e',
})
await malga.customers.create({
name: 'João da Silva',
email: 'joao.silva@test.com',
phoneNumber: '99999999999',
document: {
number: '99999999999',
type: 'cpf',
country: 'BR'
},
address: {
city: 'Rio de Janeiro',
complement: 'Sala 214',
country: 'BR',
district: 'São Conrado',
state: 'RJ',
street: 'Estrada da Gávea',
streetNumber: '696',
zipCode: '22610002'
}
})
{
id: '2c48166b-51fe-4d8d-a450-1385df8a95b9',
name: 'João da Silva',
email: 'joao.silva@test.com',
clientId: 'd1d2b51a-0446-432a-b055-034518c2660e',
phoneNumber: '99999999999',
createdAt: '2023-12-31T19:36:30.741Z',
document: {
number: '99999999999',
type: 'cpf',
country: 'BR"
},
address: {
city: 'Rio de Janeiro',
complement: 'Sala 214',
country: 'BR',
district: 'São Conrado',
state: 'RJ',
street: 'Estrada da Gávea',
streetNumber: '696',
zipCode: '22610002'
}
}
Parâmetros
Lista de todos os parâmetros suportados pelo método.
name
string
requiredNome do cliente
email
string
requiredE-mail do cliente
phoneNumber
string
requiredTelefone do cliente
document
object
Dados do documento do cliente
address
object
Dados de endereço do cliente
Também é possível passar um segundo parâmetro no método para ignorar as validações de duplicação de e-mail e documento
force
boolean
Parâmetro para ignorar a duplicidade de clientes, o padrão é false
Was this page helpful?