Listar Cobranças
curl --request GET \
--url https://api.visepag.com/v1/payins \
--header 'Authorization: <authorization>'import requests
url = "https://api.visepag.com/v1/payins"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.visepag.com/v1/payins', 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.visepag.com/v1/payins",
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: <authorization>"
],
]);
$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.visepag.com/v1/payins"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.visepag.com/v1/payins")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.visepag.com/v1/payins")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"object": "list",
"data": [
{
"id": "54e2b712-aca0-4230-b69a-d6dd8542c925",
"status": "paid",
"method": "pix",
"amount": 1000,
"platformFee": 70,
"description": "Pedido #1234",
"customerName": "João Silva",
"customerDocument": "52998224725",
"customerEmail": "[email protected]",
"pixCopy": "00020101021226...",
"pixQrCode": null,
"createdAt": "2026-03-05T18:14:48Z",
"paidAt": "2026-03-05T18:16:22Z",
"expiresAt": "2026-03-06T18:14:48Z",
"currency": "brl",
"livemode": true
}
],
"has_more": true,
"url": "/v1/payins"
}
Cobranças
Listar Cobranças
Retorna as cobranças da empresa com filtros e paginação
GET
/
payins
Listar Cobranças
curl --request GET \
--url https://api.visepag.com/v1/payins \
--header 'Authorization: <authorization>'import requests
url = "https://api.visepag.com/v1/payins"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.visepag.com/v1/payins', 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.visepag.com/v1/payins",
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: <authorization>"
],
]);
$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.visepag.com/v1/payins"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.visepag.com/v1/payins")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.visepag.com/v1/payins")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"object": "list",
"data": [
{
"id": "54e2b712-aca0-4230-b69a-d6dd8542c925",
"status": "paid",
"method": "pix",
"amount": 1000,
"platformFee": 70,
"description": "Pedido #1234",
"customerName": "João Silva",
"customerDocument": "52998224725",
"customerEmail": "[email protected]",
"pixCopy": "00020101021226...",
"pixQrCode": null,
"createdAt": "2026-03-05T18:14:48Z",
"paidAt": "2026-03-05T18:16:22Z",
"expiresAt": "2026-03-06T18:14:48Z",
"currency": "brl",
"livemode": true
}
],
"has_more": true,
"url": "/v1/payins"
}
Descrição
Retorna uma lista paginada das cobranças da empresa, criadas pela API e pelo Dashboard, com filtros por status, método e data. Os depósitos feitos na própria conta não entram na lista.Headers
Bearer token de autenticação. Formato:
Bearer YOUR_API_KEYQuery Parameters
Exemplo de Requisição
# Listar as últimas 20 cobranças pagas
curl "https://api.visepag.com/v1/payins?limit=20&method=pix&status=paid" \
-H "Authorization: Bearer YOUR_API_KEY"
# Próxima página após o último ID retornado
curl "https://api.visepag.com/v1/payins?limit=10&starting_after=54e2b712-aca0-4230-b69a-d6dd8542c925" \
-H "Authorization: Bearer YOUR_API_KEY"
const params = new URLSearchParams({
limit: '20',
method: 'pix',
status: 'paid',
'created[gte]': '2026-03-01T00:00:00Z',
'created[lte]': '2026-03-31T23:59:59Z'
});
const response = await fetch(
`https://api.visepag.com/v1/payins?${params}`,
{ headers: { 'Authorization': 'Bearer YOUR_API_KEY' } }
);
const { data, has_more } = await response.json();
Resposta 200 OK
Lista de cobranças, no mesmo formato da consulta
{
"object": "list",
"data": [
{
"id": "54e2b712-aca0-4230-b69a-d6dd8542c925",
"status": "paid",
"method": "pix",
"amount": 1000,
"platformFee": 70,
"description": "Pedido #1234",
"customerName": "João Silva",
"customerDocument": "52998224725",
"customerEmail": "[email protected]",
"pixCopy": "00020101021226...",
"pixQrCode": null,
"createdAt": "2026-03-05T18:14:48Z",
"paidAt": "2026-03-05T18:16:22Z",
"expiresAt": "2026-03-06T18:14:48Z",
"currency": "brl",
"livemode": true
}
],
"has_more": true,
"url": "/v1/payins"
}
Paginação
A API usa cursor-based pagination com o campostarting_after:
// Buscar todas as cobranças automaticamente
async function buscarTodasCobrancas() {
const cobrancas = [];
let cursor = null;
do {
const params = new URLSearchParams({ limit: '100' });
if (cursor) params.set('starting_after', cursor);
const res = await fetch(`https://api.visepag.com/v1/payins?${params}`, {
headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
});
const { data, has_more } = await res.json();
cobrancas.push(...data);
cursor = has_more ? data[data.length - 1].id : null;
} while (cursor);
return cobrancas;
}
Quando
has_more é true, existem mais resultados. Use o id da última cobrança retornada como starting_after para buscar a próxima página.Erros
| Status | Código | Descrição |
|---|---|---|
400 | invalid_parameter | limit, status, method, datas ou starting_after inválidos |