curl --request GET \
--url https://api.cakto.com.br/public_api/orders/{id}/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cakto.com.br/public_api/orders/{id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cakto.com.br/public_api/orders/{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://api.cakto.com.br/public_api/orders/{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 => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.cakto.com.br/public_api/orders/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyHttpResponse<String> response = Unirest.get("https://api.cakto.com.br/public_api/orders/{id}/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.cakto.com.br/public_api/orders/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
{
"id": "10bb51bb-03be-473c-b4c5-3490765c4096",
"refId": "CATDiPp",
"status": "refunded",
"type": "unique",
"offer_type": "main",
"baseAmount": "33.00",
"discount": "0.00",
"amount": "34.35",
"coupon": null,
"couponCode": null,
"reason": null,
"refund_reason": null,
"product": {
"id": "10bb51bb-03be-473c-b4c5-3490765c4096",
"name": "Product Name",
"image": "https://api.cakto.com.br/images/products/product_logo.png",
"description": "Product description",
"price": 33,
"type": "unique",
"contentDeliveries": [
"cakto_v2",
"emailAccess"
],
"emailAccessLink": "https://example-email-to-send-to-customers.com.br",
"salesPage": "https://api.cakto.com.br/dashboard/products",
"status": "active",
"paymentMethods": [
"boleto",
"credit_card",
"pix"
],
"category": {
"id": "10bb51bb-03be-473c-b4c5-3490765c4096",
"name": "Cat2"
}
},
"checkout": 52,
"subscription": null,
"subscription_period": null,
"installments": 1,
"paymentMethod": "credit_card",
"createdAt": "2025-10-03T11:19:35.019507-03:00",
"due_date": null,
"paidAt": "2025-10-03T11:19:37.064939-03:00",
"releaseDate": null,
"refundedAt": "2025-10-29T18:35:40.729119-03:00",
"chargedbackAt": null,
"canceledAt": null,
"customer": {
"name": "Customer Name Example",
"email": "teste74727@gmail.com",
"birthDate": null,
"phone": "16999997777",
"docType": "cpf",
"docNumber": "11199933377"
},
"address": {
"country": "BR",
"state": "MG",
"city": "Monte Carmelo",
"zipcode": "38500000",
"street": "Rua Teste",
"neighborhood": "Centro",
"complement": "Point of reference",
"number": "177"
},
"shipping": null,
"fees": "1.52",
"commissionedUsers": [
{
"id": 1,
"email": "teste@teste.com"
},
{
"id": 2,
"email": "testeando@teste.com"
}
],
"commissions": [
{
"userId": "1",
"type": "producer",
"commissionPercentage": 50,
"commissionValue": 15.41
},
{
"userId": "2",
"type": "coproducer",
"commissionPercentage": 50,
"commissionValue": 15.42
}
],
"utm_source": "",
"utm_medium": "",
"utm_campaign": "",
"utm_term": "",
"utm_content": "",
"sck": null,
"checkoutUrl": "https://pay.cakto.com.br/EXAMPLE"
}{
"detail": "As credenciais de autenticação não foram fornecidas."
}{
"detail": "Não encontrado."
}Obter Pedido
Retorna os detalhes de um pedido específico
curl --request GET \
--url https://api.cakto.com.br/public_api/orders/{id}/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cakto.com.br/public_api/orders/{id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cakto.com.br/public_api/orders/{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://api.cakto.com.br/public_api/orders/{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 => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.cakto.com.br/public_api/orders/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyHttpResponse<String> response = Unirest.get("https://api.cakto.com.br/public_api/orders/{id}/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.cakto.com.br/public_api/orders/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
{
"id": "10bb51bb-03be-473c-b4c5-3490765c4096",
"refId": "CATDiPp",
"status": "refunded",
"type": "unique",
"offer_type": "main",
"baseAmount": "33.00",
"discount": "0.00",
"amount": "34.35",
"coupon": null,
"couponCode": null,
"reason": null,
"refund_reason": null,
"product": {
"id": "10bb51bb-03be-473c-b4c5-3490765c4096",
"name": "Product Name",
"image": "https://api.cakto.com.br/images/products/product_logo.png",
"description": "Product description",
"price": 33,
"type": "unique",
"contentDeliveries": [
"cakto_v2",
"emailAccess"
],
"emailAccessLink": "https://example-email-to-send-to-customers.com.br",
"salesPage": "https://api.cakto.com.br/dashboard/products",
"status": "active",
"paymentMethods": [
"boleto",
"credit_card",
"pix"
],
"category": {
"id": "10bb51bb-03be-473c-b4c5-3490765c4096",
"name": "Cat2"
}
},
"checkout": 52,
"subscription": null,
"subscription_period": null,
"installments": 1,
"paymentMethod": "credit_card",
"createdAt": "2025-10-03T11:19:35.019507-03:00",
"due_date": null,
"paidAt": "2025-10-03T11:19:37.064939-03:00",
"releaseDate": null,
"refundedAt": "2025-10-29T18:35:40.729119-03:00",
"chargedbackAt": null,
"canceledAt": null,
"customer": {
"name": "Customer Name Example",
"email": "teste74727@gmail.com",
"birthDate": null,
"phone": "16999997777",
"docType": "cpf",
"docNumber": "11199933377"
},
"address": {
"country": "BR",
"state": "MG",
"city": "Monte Carmelo",
"zipcode": "38500000",
"street": "Rua Teste",
"neighborhood": "Centro",
"complement": "Point of reference",
"number": "177"
},
"shipping": null,
"fees": "1.52",
"commissionedUsers": [
{
"id": 1,
"email": "teste@teste.com"
},
{
"id": 2,
"email": "testeando@teste.com"
}
],
"commissions": [
{
"userId": "1",
"type": "producer",
"commissionPercentage": 50,
"commissionValue": 15.41
},
{
"userId": "2",
"type": "coproducer",
"commissionPercentage": 50,
"commissionValue": 15.42
}
],
"utm_source": "",
"utm_medium": "",
"utm_campaign": "",
"utm_term": "",
"utm_content": "",
"sck": null,
"checkoutUrl": "https://pay.cakto.com.br/EXAMPLE"
}{
"detail": "As credenciais de autenticação não foram fornecidas."
}{
"detail": "Não encontrado."
}Escopo
read orders
Status do Pedido
status | Descrição |
|---|---|
waiting_payment | Aguardando pagamento |
processing | Processando |
authorized | Autorizado |
paid | Pago |
partially_paid | Parcialmente pago |
scheduled | Agendado (normalmente parcelas futuras de assinatura) |
retrying | Nova tentativa de cobrança em andamento |
refund_requested | Reembolso solicitado, aguardando aprovação do produtor |
in_settlement | Reembolso aprovado, em efetivação pela adquirente |
refunded | Reembolsado |
refused | Recusado |
blocked | Recusado (bloqueio antifraude) |
chargedback | Chargeback |
prechargeback | Prechargeback (aviso prévio de chargeback) |
in_protest | Em protesto |
acquirer_error | Erro na adquirente ao processar reembolso |
canceled | Cancelado |
Dados do Cliente e Endereço
- Com acesso total: Retorna todos os dados do cliente (nome, email, telefone, documento, etc.)
- Sem acesso: Retorna apenas o nome do cliente
null quando o usuário não tem acesso.Authorizations
Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.
Path Parameters
Id do Pedido
Response
Corpo da resposta status 200
Valor base do pedido antes de descontos e taxas
^-?\d{0,8}(?:\.\d{0,2})?$Cupom aplicado na compra
Show child attributes
Show child attributes
Produto adquirido na compra
Show child attributes
Show child attributes
Método de pagamento utilizado na compra
Data e hora de criação
Cliente que realizou a compra
- Option 1
- Option 2
Show child attributes
Show child attributes
Endereço do cliente
Show child attributes
Show child attributes
Indica se o produtor absorveu os juros de parcelamento
Usuários comissionados na compra
Show child attributes
Show child attributes
Detalhes das comissões associadas à compra
Show child attributes
Show child attributes
Identificador único do pedido no sistema
255Id curto de referência do pedido
255Status atual do pedido
processing- Processandoauthorized- Autorizadopaid- Pagorefund_requested- Reembolso solicitadoin_settlement- Em efetivaçãoacquirer_error- Erro na adquirenterefunded- Reembolsadowaiting_payment- Aguardando pagamentorefused- Recusadoblocked- Recusadochargedback- Chargebackcanceled- Canceladoin_protest- Em protestopartially_paid- Parcialmente pagoprechargeback- Prechargebackscheduled- Scheduledretrying- RetryingMED- Med
processing, authorized, paid, refund_requested, in_settlement, acquirer_error, refunded, waiting_payment, refused, blocked, chargedback, canceled, in_protest, partially_paid, prechargeback, scheduled, retrying, MED Tipo do produto comprado no pedido
unique- Pagamento únicosubscription- Assinatura recorrente
unique, subscription Tipo da oferta comprada no pedido
main- Principalupsell- Upselldownsell- Downsellorderbump- Order Bump
main, upsell, downsell, orderbump Valor do desconto aplicado no pedido
^-?\d{0,8}(?:\.\d{0,2})?$Valor total do pedido após descontos e taxas
^-?\d{0,8}(?:\.\d{0,2})?$Código do cupom de desconto aplicado no pedido
255Motivo de recusa do pagamento
255Descrição do motivo do reembolso do pedido
Checkout onde a compra foi realizada
Assinatura associada ao pedido
Período da assinatura que este pedido corresponde
-2147483648 <= x <= 2147483647Número de parcelas que o valor foi dividido
-2147483648 <= x <= 2147483647Data e hora em que o pagamento será processado
Data e hora em que o pedido foi pago
Data e hora estimada de liberação das comissões
Data e hora em que o pedido foi reembolsado
Data e hora em que a solicitação de reembolso foi feita pelo cliente
Momento em que o reembolso será efetivado automaticamente se não houver cancelamento
Data e hora que o chargeback foi realizado
Data e hora de cancelamento do pedido
Valor total das taxas aplicadas ao pedido
^-?\d{0,8}(?:\.\d{0,2})?$Valor adicional de juros de parcelamento cobrado do cliente, aumenta os ganhos do produtor
^-?\d{0,8}(?:\.\d{0,2})?$Valor total de juros de parcelamento cobrado
^-?\d{0,8}(?:\.\d{0,2})?$Origem do tráfego (ex: google, instagram, newsletter)
255Meio do tráfego (ex: cpc, email, social)
255Nome da campanha (ex: promocao_2023)
255Termo da campanha (ex: sapato+vermelho)
255Conteúdo da campanha (ex: banner_superior)
255Parâmetro personalizado, geralmente usado internamente para rastrear algo específico (ex: ID de clique, sessão, ou código de origem próprio)
255URL do checkout onde o pedido foi realizado
Was this page helpful?