Skip to main content
GET
http://api.gu1.ai
/
entities
/
{id}
Obtener Método de Pago
curl --request GET \
  --url http://api.gu1.ai/entities/{id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "id": "<string>",
  "entityType": "<string>",
  "entityData": {
    "paymentMethod": {}
  },
  "relationships": [
    {}
  ],
  "metadata": {},
  "riskScore": 123,
  "riskFactors": [
    {}
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Descripción General

Recupera información detallada sobre una entidad de método de pago específica incluyendo sus datos, relaciones y metadatos.

Endpoint

GET http://api.gu1.ai/entities/{id}

Autenticación

Requiere una clave API válida en el encabezado de Autorización:
Authorization: Bearer YOUR_API_KEY

Parámetros de Ruta

id
string
required
UUID de la entidad de método de pago a recuperar

Ejemplos de Solicitudes

curl -X GET "http://api.gu1.ai/entities/payment-method-uuid-123" \
  -H "Authorization: Bearer YOUR_API_KEY"

Respuesta

success
boolean
Si la solicitud fue exitosa
id
string
UUID de la entidad de método de pago
entityType
string
Siempre "payment_method"
entityData
object
Datos del método de pago
relationships
array
Array de relaciones con otras entidades (propietarios, transacciones, dispositivos)
metadata
object
Metadatos adicionales
riskScore
number
Puntuación de riesgo calculada (si se analizó)
riskFactors
array
Array de factores de riesgo identificados
createdAt
string
Marca de tiempo ISO 8601 de la creación
updatedAt
string
Marca de tiempo ISO 8601 de la última actualización

Ejemplos de Respuesta

Respuesta de Tarjeta de Crédito

{
  "success": true,
  "id": "payment-method-uuid-123",
  "entityType": "payment_method",
  "entityData": {
    "paymentMethod": {
      "type": "credit_card",
      "last4": "4242",
      "brand": "visa",
      "expiryMonth": "12",
      "expiryYear": "2025",
      "holderName": "John Doe",
      "issuerCountry": "BR",
      "bin": "424242",
      "funding": "credit",
      "fingerprint": "abc123xyz"
    }
  },
  "relationships": [
    {
      "targetEntityId": "person-uuid-123",
      "relationshipType": "owns",
      "strength": 1.0,
      "metadata": {
        "since": "2024-01-15"
      }
    }
  ],
  "riskScore": 15,
  "riskFactors": [
    {
      "type": "high_velocity",
      "severity": "low",
      "description": "Múltiples transacciones en corto período de tiempo"
    }
  ],
  "createdAt": "2024-01-15T10:00:00.000Z",
  "updatedAt": "2024-12-23T10:00:00.000Z"
}

Respuesta de Cuenta Bancaria

{
  "success": true,
  "id": "payment-method-uuid-456",
  "entityType": "payment_method",
  "entityData": {
    "paymentMethod": {
      "type": "bank_account",
      "accountNumber": "12345-6",
      "accountType": "checking",
      "bank": "Banco do Brasil",
      "currency": "BRL",
      "routingNumber": "001",
      "holderName": "John Doe"
    }
  },
  "relationships": [
    {
      "targetEntityId": "person-uuid-123",
      "relationshipType": "owns",
      "strength": 1.0
    }
  ],
  "riskScore": 5,
  "riskFactors": [],
  "createdAt": "2024-01-15T10:00:00.000Z",
  "updatedAt": "2024-12-23T10:00:00.000Z"
}

Casos de Uso

Obtener Método de Pago con Detalles del Propietario

async function getPaymentMethodWithOwner(paymentMethodId) {
  // Obtener método de pago
  const pmResponse = await fetch(
    `http://api.gu1.ai/entities/${paymentMethodId}`,
    {
      headers: {
        'Authorization': 'Bearer YOUR_API_KEY'
      }
    }
  );

  const paymentMethod = await pmResponse.json();

  // Obtener propietario (primera relación)
  const ownerRelationship = paymentMethod.relationships.find(
    r => r.relationshipType === 'owns'
  );

  if (ownerRelationship) {
    const ownerResponse = await fetch(
      `http://api.gu1.ai/entities/${ownerRelationship.targetEntityId}`,
      {
        headers: {
          'Authorization': 'Bearer YOUR_API_KEY'
        }
      }
    );

    const owner = await ownerResponse.json();

    return {
      paymentMethod,
      owner
    };
  }

  return { paymentMethod };
}

Verificar Historial de Transacciones del Método de Pago

async function getPaymentMethodTransactions(paymentMethodId) {
  // Obtener todas las transacciones vinculadas a este método de pago
  const response = await fetch(
    `http://api.gu1.ai/entities?entityType=transaction&relationshipWith=${paymentMethodId}`,
    {
      headers: {
        'Authorization': 'Bearer YOUR_API_KEY'
      }
    }
  );

  const { entities } = await response.json();

  return entities;
}

Respuestas de Error

404 No Encontrado

{
  "error": "Entidad no encontrada",
  "entityId": "payment-method-uuid-123"
}

401 No Autorizado

{
  "error": "Clave API inválida o faltante"
}

Ver También