DesenvolvedoresReferência da APIClientes

Criar ou atualizar cliente

POST
/customers

Cria o cliente ou atualiza o existente com o mesmo e-mail (nome, telefone e documento informados).

Chave: Só chave secreta (chamada pelo servidor).

Escopo: customers:write.

Idempotência: aceita o cabeçalho Idempotency-Key.

Autorização

chaveSecreta
headerAutorizaçãoBearer <chave de API>

Chave secreta (sk_…). Use só no servidor; requisições de navegador (com Origin) são recusadas.

Cabeçalhos

Idempotency-Key?string

De 1 a 255 caracteres visíveis. Repetir a chamada com a mesma chave devolve a mesma resposta por 24 horas.

Corpo da requisição

application/json
  1. body
email*string
Formatoemail
Tamanholength <= 254
name?string
Tamanho1 <= length <= 160
phone?string

Só números, com DDD.

Padrão^\+?\d{10,15}$
document?string

CPF ou CNPJ válido.

Tamanholength <= 20
marketingConsent?boolean

Corpo da resposta

Já existia um cliente com este e-mail; os dados foram atualizados.

application/json
  1. response
data*
meta*
curl -X POST 'https://minepag.com.br/api/v1/customers' \  -H 'Content-Type: application/json' \  -d '{  "email": "user@example.com"}'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "email": "string",    "name": "string",    "phone": "string",    "document": {      "type": "cpf",      "last4": "string"    },    "status": "active",    "source": "checkout",    "marketingConsent": true,    "notes": "string",    "metrics": {      "paidOrdersCount": -9007199254740991,      "lifetimeValue": -9007199254740991,      "refundedTotal": -9007199254740991,      "firstOrderAt": "2019-08-24T14:15:22Z",      "lastOrderAt": "2019-08-24T14:15:22Z"    },    "createdAt": "2019-08-24T14:15:22Z"  },  "meta": {    "requestId": "string"  }}