Listar clientes

curl --request GET \
  --url https://api.uvvipay.com.br/v1/customers \
  --header 'client-id: <api-key>' \
  --header 'client-secret: <api-key>'

import requests

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

headers = {
    "client-id": "<api-key>",
    "client-secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'client-id': '<api-key>', 'client-secret': '<api-key>'}
};

fetch('https://api.uvvipay.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.uvvipay.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 => [
    "client-id: <api-key>",
    "client-secret: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("client-id", "<api-key>")
	req.Header.Add("client-secret", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.uvvipay.com.br/v1/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["client-id"] = '<api-key>'
request["client-secret"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "external_customer_id": "customer-ext-0001",
      "name": "John Doe",
      "email": "john@example.com"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 10,
  "total_pages": 1
}

GET

customers

Listar clientes

curl --request GET \
  --url https://api.uvvipay.com.br/v1/customers \
  --header 'client-id: <api-key>' \
  --header 'client-secret: <api-key>'

import requests

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

headers = {
    "client-id": "<api-key>",
    "client-secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'client-id': '<api-key>', 'client-secret': '<api-key>'}
};

fetch('https://api.uvvipay.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.uvvipay.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 => [
    "client-id: <api-key>",
    "client-secret: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("client-id", "<api-key>")
	req.Header.Add("client-secret", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.uvvipay.com.br/v1/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["client-id"] = '<api-key>'
request["client-secret"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "external_customer_id": "customer-ext-0001",
      "name": "John Doe",
      "email": "john@example.com"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 10,
  "total_pages": 1
}

Lista os clientes da sua conta. Use o id de cada item como customer_id na criação da assinatura. Use page e limit (máximo 100). A resposta não inclui documento, telefone nem dados de cartão. Se page passar do fim, data vem vazio. total, page, limit e total_pages continuam corretos. Exemplo de resposta:

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "external_customer_id": "customer-ext-0001",
      "name": "John Doe",
      "email": "john@example.com"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 10,
  "total_pages": 1
}

Erros comuns: 400 (query inválida), 401/403 (credenciais ou produto Recorrência), 429 (20 req/min).

Authorizations

client-id

string

header

required

client-secret

string

header

required

Headers

client-id

string

required

ID público da credencial do merchant

client-secret

string

required

Secret da credencial do merchant

Query Parameters

page

integer

default:1

Página (1-based)

Required range: x >= 1

limit

integer

default:10

Itens por página (máximo 100)

Required range: 1 <= x <= 100

Response

Página de clientes. Página além do fim: data: [] com metadados válidos.

data

object[]

Show child attributes

total

integer

page

integer

limit

integer

total_pages

integer