Skip to main content
GET
/
api
/
transactions
/
{id}
Detalhes da Transação
curl --request GET \
  --url https://garu.com.br/api/transactions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "galaxPayId": 123,
  "status": "<string>",
  "value": 123,
  "valueSeller": 123,
  "paymentMethod": "<string>",
  "installments": 123,
  "customer": {},
  "product": {},
  "isRecurring": true,
  "subscriptionId": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.garu.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
Visão Geral

Este endpoint retorna os detalhes completos de uma transação específica, incluindo informações do cliente, produto, método de pagamento e status.

​
Exemplo de Requisição

curl -X GET https://garu.com.br/api/transactions/12345 \
  -H "Authorization: Bearer sk_test_sua_chave_api"

​
Resposta de Sucesso

​
id
number
ID interno da transação na Garu.
​
galaxPayId
number
ID da transação no gateway de pagamento.
​
status
string
Status atual da transação.
​
value
number
Valor total da transação em Reais.
​
valueSeller
number
Valor líquido que o vendedor receberá.
​
paymentMethod
string
Método de pagamento: creditcard, pix, boleto.
​
installments
number
Número de parcelas (apenas para cartão de crédito).
​
customer
object
Dados do cliente que realizou a compra.
​
product
object
Dados do produto comprado.
​
isRecurring
boolean
Se a transação faz parte de uma assinatura recorrente.
​
subscriptionId
number | null
ID da assinatura (se isRecurring for true).

​
Exemplo de Resposta (200 OK)

{
  "id": 12345,
  "galaxPayId": 987654,
  "status": "captured",
  "value": 297.00,
  "valueSeller": 297.00,
  "paymentMethod": "creditcard",
  "installments": 3,
  "date": "2024-12-24T14:30:00.000Z",
  "deadline": "2024-12-24T14:30:00.000Z",
  "customer": {
    "id": 456,
    "name": "João Silva",
    "email": "joao@example.com",
    "document": "12345678901",
    "phone": "11999887766"
  },
  "product": {
    "id": 123,
    "name": "Curso de Marketing Digital",
    "value": 297.00,
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "isRecurring": false,
  "subscriptionId": null,
  "billingCycle": null,
  "createdAt": "2024-12-24T14:30:00.000Z",
  "updatedAt": "2024-12-24T14:35:00.000Z"
}

​
Verificando se o Pagamento foi Confirmado

async function verificarPagamento(transactionId) {
  const response = await fetch(
    `https://garu.com.br/api/transactions/${transactionId}`,
    {
      headers: {
        'Authorization': `Bearer ${process.env.GARU_API_KEY}`
      }
    }
  );

  const transaction = await response.json();

  // Status que indicam pagamento confirmado
  const paidStatuses = ['captured', 'payedBoleto', 'payedPix'];
  const isPaid = paidStatuses.includes(transaction.status);

  return {
    isPaid,
    status: transaction.status,
    value: transaction.value,
    customer: transaction.customer,
    product: transaction.product
  };
}

// Uso
const result = await verificarPagamento(12345);
if (result.isPaid) {
  console.log(`Pagamento confirmado para ${result.customer.name}`);
  // Liberar acesso ao produto
}

​
Próximos Passos

Consultar Status

Endpoint público para verificar status

Reembolsar

Emita reembolsos totais ou parciais