Skip to main content
POST
http://api.gu1.ai
/
entities
Crear Método de Pago
curl --request POST \
  --url http://api.gu1.ai/entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityType": "<string>",
  "entityData": {
    "paymentMethod": {
      "type": "<string>",
      "last4": "<string>",
      "brand": "<string>",
      "expiryMonth": "<string>",
      "expiryYear": "<string>",
      "holderName": "<string>",
      "issuerCountry": "<string>",
      "bin": "<string>",
      "fingerprint": "<string>",
      "funding": "<string>",
      "accountNumber": "<string>",
      "accountType": "<string>",
      "bank": "<string>",
      "currency": "<string>",
      "routingNumber": "<string>",
      "provider": "<string>",
      "email": "<string>",
      "address": "<string>",
      "network": "<string>",
      "pixKey": "<string>",
      "pixKeyType": "<string>"
    }
  },
  "relationships": [
    {
      "targetEntityId": "<string>",
      "relationshipType": "<string>",
      "strength": 123,
      "metadata": {}
    }
  ],
  "metadata": {}
}
'
{
  "success": true,
  "id": "<string>",
  "entityType": "<string>",
  "entityData": {},
  "relationships": [
    {}
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

​
Descripción General

Crea una nueva entidad de método de pago (tarjeta de crédito, cuenta bancaria, billetera, etc.) en el sistema. Los métodos de pago pueden vincularse a entidades de personas o empresas y utilizarse para monitoreo de transacciones y detección de fraude.

​
Endpoint

POST http://api.gu1.ai/entities

​
Autenticación

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

​
Cuerpo de la Solicitud

​
entityType
string
required
Debe ser "payment_method" para entidades de método de pago
​
entityData
object
required
Contenedor para datos del método de pago
​
relationships
array
Array de relaciones con otras entidades
​
metadata
object
Metadatos adicionales para la entidad de método de pago

​
Ejemplos de Solicitudes

​
Crear Tarjeta de Crédito

curl -X POST http://api.gu1.ai/entities \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "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"
      }
    },
    "relationships": [
      {
        "targetEntityId": "person-uuid-123",
        "relationshipType": "owns",
        "strength": 1.0
      }
    ]
  }'

​
Crear Cuenta Bancaria

curl -X POST http://api.gu1.ai/entities \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "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
      }
    ]
  }'

​
Crear Método de Pago PIX

curl -X POST http://api.gu1.ai/entities \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityType": "payment_method",
    "entityData": {
      "paymentMethod": {
        "type": "pix",
        "pixKey": "john.doe@example.com",
        "pixKeyType": "email",
        "holderName": "John Doe",
        "currency": "BRL"
      }
    },
    "relationships": [
      {
        "targetEntityId": "person-uuid-123",
        "relationshipType": "owns",
        "strength": 1.0
      }
    ]
  }'

​
Respuesta

​
success
boolean
Si la operación fue exitosa
​
id
string
UUID de la entidad de método de pago creada
​
entityType
string
Siempre "payment_method"
​
entityData
object
Los datos del método de pago tal como se almacenaron
​
relationships
array
Array de relaciones creadas
​
createdAt
string
Marca de tiempo ISO 8601 de la creación
​
updatedAt
string
Marca de tiempo ISO 8601 de la última actualización

​
Ejemplo de Respuesta

{
  "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"
    }
  },
  "relationships": [
    {
      "targetEntityId": "person-uuid-123",
      "relationshipType": "owns",
      "strength": 1.0
    }
  ],
  "createdAt": "2024-12-23T10:00:00.000Z",
  "updatedAt": "2024-12-23T10:00:00.000Z"
}

​
Respuestas de Error

​
400 Solicitud Incorrecta

{
  "error": "Tipo de entidad inválido o campos requeridos faltantes",
  "details": {
    "entityType": "Debe ser 'payment_method'",
    "entityData.paymentMethod.type": "Campo requerido"
  }
}

​
401 No Autorizado

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

​
Ver También