Skip to main content
Gerencie a base de clientes vinculada ao trilho da sua API key. Base: https://api.goatpay.com.br/v1.

​
Rotas

MétodoRotaPermissãoDocumentação
POST/v1/customers/createcustomers/createCriar
GET/v1/customers/get/:idcustomers/getConsultar
GET/v1/customers/listcustomers/listListar
PATCH/v1/customers/update/:idcustomers/updateAtualizar
DELETE/v1/customers/delete/:idcustomers/deleteExcluir

​
Listagem

GET /v1/customers/list aceita:
  • page, pageSize (máx. 100)
  • search — nome, e-mail ou documento
  • status — Ativo, Inativo, Bloqueado ou active / inactive / blocked
Resposta paginada: items, page, pageSize, total, pages.

​
Campos do cliente

CampoDescrição
name, email, documentObrigatórios na criação
typePF ou PJ
statusSituação comercial
phone, whatsapp, city, stateOpcionais
transactions, volumeMétricas na resposta (somente leitura)

​
Checkout automático

Clientes também são criados ou atualizados no checkout de links quando o customerMode do link exige cadastro. Você pode manter o CRM sincronizado via API ou confiar no fluxo do link. Visão geral: Loja.