Cobrança
Consultar um pedido de recarga
Status de um pedido de recarga criado por POST /v1/billing/checkout ou POST /v1/billing/payment-intents (Pix ou cartão): pending, paid (carteira creditada), expired (Pix não pago dentro da hora) ou failed. Só leitura: não chama nenhum provedor de pagamento. O wallet.topup_paid só é entregue depois que o pedido é concluído; quando ele chega, este endpoint já responde paid. Id de outro workspace: o mesmo 404 TOPUP_NOT_FOUND. Proprietário ou Admin (billing:read) com chave de conta ou token OAuth.
Requer uma chave com escopo de tenant — uma chave de workspace, ou uma chave de conta com x-workspace-id.
GET
/
v1
/
billing
/
topups
/
{id}
Consultar um pedido de recarga
curl --request GET \
--url https://pilotstatus.com.br/v1/billing/topups/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/billing/topups/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/billing/topups/{id}', 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://pilotstatus.com.br/v1/billing/topups/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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://pilotstatus.com.br/v1/billing/topups/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pilotstatus.com.br/v1/billing/topups/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/billing/topups/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"topup": {
"id": "cmh2b4k1n0001to8example2p",
"status": "paid",
"amount": 100,
"currency": "BRL",
"method": "pix",
"provider": "PAGUE_DEV",
"createdAt": "2026-10-28T10:15:00.000Z",
"paidAt": "2026-10-28T10:17:42.000Z",
"expiresAt": "2026-10-28T11:15:00.000Z"
}
}{
"error": "Invalid API key"
}{
"error": "This endpoint requires a tenant-scoped API key",
"code": "NUMBER_SCOPE_NOT_ALLOWED"
}{
"error": "Top-up order not found | Pedido de recarga não encontrado",
"code": "TOPUP_NOT_FOUND"
}Autorizações
apiKeyapiKeyId
Sua chave de API ps_
Cabeçalhos
Só com chave de conta (ps_account_): o workspace em que agir, obtido em GET /v1/workspaces. Sem ele, uma chave de conta recebe 400 WORKSPACE_ID_REQUIRED.
Parâmetros de caminho
O orderId devolvido na criação da recarga.
Resposta
O pedido
Esta página foi útil?
⌘I
Consultar um pedido de recarga
curl --request GET \
--url https://pilotstatus.com.br/v1/billing/topups/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://pilotstatus.com.br/v1/billing/topups/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://pilotstatus.com.br/v1/billing/topups/{id}', 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://pilotstatus.com.br/v1/billing/topups/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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://pilotstatus.com.br/v1/billing/topups/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pilotstatus.com.br/v1/billing/topups/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/billing/topups/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"topup": {
"id": "cmh2b4k1n0001to8example2p",
"status": "paid",
"amount": 100,
"currency": "BRL",
"method": "pix",
"provider": "PAGUE_DEV",
"createdAt": "2026-10-28T10:15:00.000Z",
"paidAt": "2026-10-28T10:17:42.000Z",
"expiresAt": "2026-10-28T11:15:00.000Z"
}
}{
"error": "Invalid API key"
}{
"error": "This endpoint requires a tenant-scoped API key",
"code": "NUMBER_SCOPE_NOT_ALLOWED"
}{
"error": "Top-up order not found | Pedido de recarga não encontrado",
"code": "TOPUP_NOT_FOUND"
}