v10

latestOpenAPI 3.1.1raw.githubusercontent.com2026-06-261653109.3 KB
Transacoes

Obter transacao

Retorna os dados completos de uma transacao especifica.

get/v1/transactions/{transactionId}

Path parameters

transactionIdstring uuid required
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

ID da transacao

Response

Dados da transacao

messagestring nullable

Example response

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "externalId": "pedido_12345",
    "method": "Pix",
    "amount": 10000,
    "fee": 150,
    "netAmount": 9850,
    "currency": "BRL",
    "status": "Completed",
    "description": "Pagamento do pedido #12345",
    "environment": "Sandbox",
    "metadata": "{\"orderId\": 12345}",
    "callbackUrl": "https://seusite.com.br/webhook",
    "customerId": "550e8400-e29b-41d4-a716-446655440000",
    "expiresAt": "2025-01-15T15:30:00Z",
    "completedAt": "2025-01-15T15:10:00Z",
    "createdAt": "2025-01-15T15:00:00Z",
    "updatedAt": "2025-01-15T15:10:00Z",
    "pix": {
      "txId": "SAFEFY2025011512345678901234",
      "endToEndId": "E12345678202501151510abc123def456",
      "copyAndPaste": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890...",
      "payerName": "Joao Silva",
      "payerDocument": "***456789**",
      "payerBank": "Banco do Brasil",
      "expiresAt": "2025-01-15T15:30:00Z"
    },
    "card": {
      "lastFour": "1234",
      "brand": "Visa",
      "installments": 1,
      "authorizationCode": "ABC123"
    },
    "boleto": {
      "barcode": "23793.38128 60000.000003 00000.000400 1 84340000010000",
      "digitableLine": "23793.38128 60000.000003 00000.000400 1 84340000010000",
      "pdfUrl": "https://api.safefypay.com.br/boleto/123456.pdf",
      "dueDate": "2025-01-20T00:00:00Z"
    },
    "customer": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Joao Silva",
      "email": "joao@email.com",
      "document": "123.456.789-00",
      "phone": "5511999998888"
    }
  },
  "error": {
    "message": "Token invalido ou expirado.",
    "code": "unauthorized"
  }
}