GET

Buscar Transação por ID

Recupera os detalhes completos de uma transação específica usando seu transactionId.

Endpoint

GET https://dfpay.app/api/Transaction/transactionByTransactionId/{transactionId}

Headers Obrigatórios

X-Client-Id

ID público do seu aplicativo (obtido no painel DFPay)

X-API-Key

Chave secreta da sua empresa (obtida no painel DFPay)

Accept

Deve ser application/json

Parâmetros de Rota

transactionId

UUID da transação retornado no campo id ao criar uma transação.

Exemplo: 9f9a917a-c265-4bd5-ba3d-c2cc7c766339

Resposta de Sucesso (200 OK)

{
  "id": 123,
  "leadId": 456,
  "lead": {
    "id": 456,
    "name": "João Silva",
    "email": "joao@example.com",
    "phone": "11999999999",
    "document": "12345678900",
    "address": {
      "street": "Rua Exemplo",
      "streetNumber": "100",
      "complement": "Apto 101",
      "zipCode": "01234-567",
      "neighborhood": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "country": "Brasil"
    }
  },
  "companyId": 6,
  "enSubIntegration": "Fastshop",
  "value": 5,
  "transactionId": "9f9a917a-c265-4bd5-ba3d-c2cc7c766339",
  "gatewayPostbackUrl": "",
  "enStatusTransaction": "Awaiting",
  "enPaymentSystem": "Pix",
  "updateDate": "2025-10-17T01:27:45.224075+00:00",
  "createdAt": "2025-10-17T01:27:45.224058",
  "items": []
}

Campos Principais

  • transactionId: UUID único da transação
  • enStatusTransaction: Status atual (Awaiting, Paid, Cancelled, etc.)
  • enPaymentSystem: Método de pagamento (Pix, Boleto, CreditCard)
  • value: Valor da transação em centavos
  • lead: Dados completos do cliente

Possíveis Erros

404Transação não encontrada
{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
  "title": "Not Found",
  "status": 404,
  "detail": "Transaction not found",
  "instance": "/api/Transaction/transactionByTransactionId/invalid-id"
}
401Não autorizado
{
  "type": "https://tools.ietf.org/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Invalid or missing authentication credentials"
}

Exemplos de Uso

cURL

curl -X GET "https://dfpay.app/api/Transaction/transactionByTransactionId/9f9a917a-c265-4bd5-ba3d-c2cc7c766339" \
  -H "Accept: application/json" \
  -H "X-Client-Id: e1c98954cc404cbcb2868af9b40c7a33" \
  -H "X-API-Key: sua-api-key-secreta"

JavaScript (fetch)

const transactionId = '9f9a917a-c265-4bd5-ba3d-c2cc7c766339';

const response = await fetch(
  `https://dfpay.app/api/Transaction/transactionByTransactionId/${transactionId}`,
  {
    method: 'GET',
    headers: {
      'Accept': 'application/json',
      'X-Client-Id': 'e1c98954cc404cbcb2868af9b40c7a33',
      'X-API-Key': 'sua-api-key-secreta'
    }
  }
);

const transaction = await response.json();
console.log('Status:', transaction.enStatusTransaction);
console.log('Valor:', transaction.value / 100); // Converter centavos para reais

Node.js (n8n exemplo)

const CLIENT_ID = 'e1c98954cc404cbcb2868af9b40c7a33';
const API_KEY = 'sua-api-key-secreta';
const TX_ID = '9f9a917a-c265-4bd5-ba3d-c2cc7c766339';

try {
  const res = await this.helpers.httpRequest({
    method: 'GET',
    url: `https://dfpay.app/api/Transaction/transactionByTransactionId/${encodeURIComponent(TX_ID)}`,
    headers: {
      'Accept': 'application/json',
      'X-Client-Id': CLIENT_ID,
      'X-API-Key': API_KEY,
    },
    json: true,
    timeout: 30000,
  });

  return [{ json: { ok: true, res } }];
} catch (e) {
  return [{
    json: {
      ok: false,
      status: e.response?.status ?? null,
      data: e.response?.data ?? e.message,
    }
  }];
}

Notas Importantes

  • Use o transactionId retornado ao criar a transação
  • O campo value está sempre em centavos (500 = R$ 5,00)
  • O status enStatusTransaction pode ser: Awaiting, Paid, Cancelled, Failed, Refunded
  • Dados do cliente estão no objeto lead
  • Para atualizações em tempo real, configure webhooks ao invés de fazer polling constante