Detalhes da Transação

curl --request GET \
  --url https://garu.com.br/api/transactions/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://garu.com.br/api/transactions/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://garu.com.br/api/transactions/{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://garu.com.br/api/transactions/{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;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://garu.com.br/api/transactions/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://garu.com.br/api/transactions/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://garu.com.br/api/transactions/{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_body

{
  "id": 123,
  "galaxPayId": 123,
  "status": "<string>",
  "value": 123,
  "valueSeller": 123,
  "paymentMethod": "<string>",
  "installments": 123,
  "customer": {},
  "product": {},
  "isRecurring": true,
  "subscriptionId": {}
}

GET

api

transactions

{id}

Detalhes da Transação

curl --request GET \
  --url https://garu.com.br/api/transactions/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://garu.com.br/api/transactions/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://garu.com.br/api/transactions/{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://garu.com.br/api/transactions/{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;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://garu.com.br/api/transactions/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://garu.com.br/api/transactions/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://garu.com.br/api/transactions/{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_body

{
  "id": 123,
  "galaxPayId": 123,
  "status": "<string>",
  "value": 123,
  "valueSeller": 123,
  "paymentMethod": "<string>",
  "installments": 123,
  "customer": {},
  "product": {},
  "isRecurring": true,
  "subscriptionId": {}
}

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"

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

const transaction = await response.json();
console.log(`Status: ${transaction.status}`);
console.log(`Cliente: ${transaction.customer.name}`);

import requests
import os

url = "https://garu.com.br/api/transactions/12345"
headers = {
    "Authorization": f"Bearer {os.environ['GARU_API_KEY']}"
}

response = requests.get(url, headers=headers)
transaction = response.json()

print(f"Status: {transaction['status']}")
print(f"Cliente: {transaction['customer']['name']}")

Resposta de Sucesso

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

Listar Transações Consultar Status

​Visão Geral

​Exemplo de Requisição

​Resposta de Sucesso

​Exemplo de Resposta (200 OK)

​Verificando se o Pagamento foi Confirmado

​Próximos Passos

Consultar Status

Reembolsar

Visão Geral

Exemplo de Requisição

Resposta de Sucesso

Exemplo de Resposta (200 OK)

Verificando se o Pagamento foi Confirmado

Próximos Passos