Listar clientes

curl --request GET \
  --url https://api.valorapayments.com.br/v1/customers \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

<?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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

{
  "object": "list",
  "data": [
    {
      "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"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

{
  "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": "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."
  }
}

GET

customers

Listar clientes

curl --request GET \
  --url https://api.valorapayments.com.br/v1/customers \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

<?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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

{
  "object": "list",
  "data": [
    {
      "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"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

{
  "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": "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.

Parâmetros de consulta

limit

integer

padrão:20

Itens por página, de 1 a 100.

Intervalo obrigatório: 1 <= x <= 100

starting_after

string

O next_cursor da página anterior.

string

Filtra pelo e-mail.

external_reference

string

Filtra pelo seu identificador.

Resposta

Página de clientes.

object

enum<string>

Sempre list.

Opções disponíveis:

list

data

object[]

Hide child attributes

data.id

string

Id do cliente.

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

Exemplo:

"cus_Xk2v9QeR7tLmN3bA"

data.object

enum<string>

Sempre customer.

Opções disponíveis:

customer

data.name

string

Nome.

data.email

string | null

E-mail.

data.document

string | null

CPF ou CNPJ, só dígitos.

data.phone

string | null

Telefone, só dígitos.

data.external_reference

string | null

O seu identificador.

data.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

data.metadata.{key}

string

Maximum string length: 500

Exemplo:

{ "order_id": "1001" }

data.created_at

string<date-time>

Criação.

data.updated_at

string<date-time>

Última alteração.

has_more

boolean

Há mais itens depois desta página.

next_cursor

string | null

Passe em starting_after para a próxima página.

Visão geral

Pagamentos

Checkouts

Clientes

Produtos

Saldo

Webhooks

Listar clientes

Autorizações

Parâmetros de consulta

Resposta