Listar Payins
curl --request GET \
--url https://api.example.com/payin \
--header 'Authorization: <authorization>'import requests
url = "https://api.example.com/payin"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.example.com/payin', 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.example.com/payin",
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.example.com/payin"
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.example.com/payin")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/payin")
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_bodyPayins (Recebimentos)
Listar Payins
Recupera uma lista de pagamentos (Payins) associados à sua conta corporativa com suporte a filtros e paginação.
GET
/
payin
Listar Payins
curl --request GET \
--url https://api.example.com/payin \
--header 'Authorization: <authorization>'import requests
url = "https://api.example.com/payin"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.example.com/payin', 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.example.com/payin",
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.example.com/payin"
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.example.com/payin")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/payin")
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_bodyAtravés desta rota, você pode gerar relatórios financeiros da sua base de clientes, filtrando pagamentos específicos usando parâmetros de busca.
Autorização
A rota deve estar protegida e identificada nos Cabeçalhos.string
required
Use o Basic Auth.
Query Parameters (Filtros)
string
Se desejar apenas uma lista de transações liquidadas, use
APPROVED. Outros valores permitidos:PENDINGFAILEDCANCELEDREFUSEDREFUNDEDCHARGEBACKEXPIRED
string
Filtre pelo agrupamento:
PIX, CREDIT_CARD ou BOLETO.datetime
Traga transações com data de criação inicial a partir desta (Ex:
2026-03-01T00:00:00.000Z).datetime
Usado em concomitante ao startDate para consolidar range. Limite as transações até aqui (Ex:
2026-03-31T23:59:59.000Z).string
Busque pelo ID de adquirente.
string
Busque a transação pelo ID exato da sua base (aquele cadastrado no banco da sua Loja/Produto).
integer
Filtra Payins com montante (em centavos) igual ou superior ao desejado.
integer
Filtra Payins com montante igual ou inferior ao desejado.
integer
default:"1"
Página atual de controle (Paginação).
integer
default:"20"
A quantidade de registros por página devolvidos pelo JSON em
.items[].Response
A chamada emulada preencherá uma lista.{
"total": 542,
"currentPage": 1,
"totalPages": 28,
"items": [
{
"id": "payin_1A2B3D",
"status": "APPROVED",
"paymentMethod": "PIX",
"amount": 25000,
"referenceId": "sua-comanda-345",
"createdAt": "2026-03-01T14:30:20.000Z"
}
]
}
Was this page helpful?