Criar um cliente

curl --request POST \
  --url https://api.valorapayments.com.br/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Ana Souza",
  "email": "ana@example.com",
  "document": "12345678909",
  "phone": "11988887777",
  "external_reference": "usuario-42"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Ana Souza',
    email: 'ana@example.com',
    document: '12345678909',
    phone: '11988887777',
    external_reference: 'usuario-42'
  })
};

fetch('https://api.valorapayments.com.br/v1/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.valorapayments.com.br/v1/customers"

payload = {
    "name": "Ana Souza",
    "email": "ana@example.com",
    "document": "12345678909",
    "phone": "11988887777",
    "external_reference": "usuario-42"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.valorapayments.com.br/v1/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Ana Souza',
    'email' => 'ana@example.com',
    'document' => '12345678909',
    'phone' => '11988887777',
    'external_reference' => 'usuario-42'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "cus_Xk2v9QeR7tLmN3bA",
  "object": "customer",
  "name": "<string>",
  "email": "<string>",
  "document": "<string>",
  "phone": "<string>",
  "external_reference": "<string>",
  "metadata": {
    "order_id": "1001"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "type": "invalid_api_key",
    "message": "Chave de API inválida ou revogada."
  }
}

{
  "error": {
    "type": "missing_scope",
    "message": "A chave não tem o escopo necessário."
  }
}

{
  "error": {
    "type": "email_in_use",
    "message": "Já existe um cliente com este e-mail."
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "Corpo inválido.",
    "details": {
      "amount": [
        "Valor inválido."
      ]
    }
  }
}

{
  "error": {
    "type": "rate_limited",
    "message": "Muitas requisições. Tente novamente em instantes."
  }
}

{
  "error": {
    "type": "service_unavailable",
    "message": "Serviço temporariamente indisponível."
  }
}

POST

customers

Criar um cliente

curl --request POST \
  --url https://api.valorapayments.com.br/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Ana Souza",
  "email": "ana@example.com",
  "document": "12345678909",
  "phone": "11988887777",
  "external_reference": "usuario-42"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Ana Souza',
    email: 'ana@example.com',
    document: '12345678909',
    phone: '11988887777',
    external_reference: 'usuario-42'
  })
};

fetch('https://api.valorapayments.com.br/v1/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.valorapayments.com.br/v1/customers"

payload = {
    "name": "Ana Souza",
    "email": "ana@example.com",
    "document": "12345678909",
    "phone": "11988887777",
    "external_reference": "usuario-42"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.valorapayments.com.br/v1/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Ana Souza',
    'email' => 'ana@example.com',
    'document' => '12345678909',
    'phone' => '11988887777',
    'external_reference' => 'usuario-42'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "cus_Xk2v9QeR7tLmN3bA",
  "object": "customer",
  "name": "<string>",
  "email": "<string>",
  "document": "<string>",
  "phone": "<string>",
  "external_reference": "<string>",
  "metadata": {
    "order_id": "1001"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "type": "invalid_api_key",
    "message": "Chave de API inválida ou revogada."
  }
}

{
  "error": {
    "type": "missing_scope",
    "message": "A chave não tem o escopo necessário."
  }
}

{
  "error": {
    "type": "email_in_use",
    "message": "Já existe um cliente com este e-mail."
  }
}

{
  "error": {
    "type": "invalid_request",
    "message": "Corpo inválido.",
    "details": {
      "amount": [
        "Valor inválido."
      ]
    }
  }
}

{
  "error": {
    "type": "rate_limited",
    "message": "Muitas requisições. Tente novamente em instantes."
  }
}

{
  "error": {
    "type": "service_unavailable",
    "message": "Serviço temporariamente indisponível."
  }
}

Autorizações

Authorization

string

header

obrigatório

Chave de API sk_vl_... criada no painel em Desenvolvedores → Chaves de API.

Corpo

application/json

name

string

obrigatório

Nome (até 120).

Maximum string length: 120

string<email>

E-mail. Único por negócio.

document

string

CPF (11) ou CNPJ (14 dígitos), só números.

Pattern: ^(\d{11}|\d{14})$

phone

string

Telefone, só dígitos (8 a 15), + opcional.

Pattern: ^\+?\d{8,15}$

external_reference

string

O seu identificador (id do pedido, SKU). Até 100 caracteres.

Maximum string length: 100

Exemplo:

"pedido-1001"

metadata

object

Até 20 pares chave/valor em texto (chave até 40, valor até 500 caracteres). Volta igual nas respostas e nos webhooks.

Hide child attributes

metadata.{key}

string

Maximum string length: 500

Exemplo:

{ "order_id": "1001" }

Resposta

Cliente criado.

string

Id do cliente.

Pattern: ^cus_[A-Za-z0-9_-]{16}$

Exemplo:

"cus_Xk2v9QeR7tLmN3bA"

object

enum<string>

Sempre customer.

Opções disponíveis:

customer

name

string

Nome.

string | null

E-mail.

document

string | null

CPF ou CNPJ, só dígitos.

phone

string | null

Telefone, só dígitos.

external_reference

string | null

O seu identificador.

metadata

object

Até 20 pares chave/valor em texto (chave até 40, valor até 500 caracteres). Volta igual nas respostas e nos webhooks.

Hide child attributes

metadata.{key}

string

Maximum string length: 500

Exemplo:

{ "order_id": "1001" }

created_at

string<date-time>

Criação.

updated_at

string<date-time>

Última alteração.

Visão geral

Pagamentos

Checkouts

Clientes

Produtos

Saldo

Webhooks

Criar um cliente

Autorizações

Corpo

Resposta