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>"
}

POST

entities

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

Show propiedades

paymentMethod

object

required

Detalles del método de pago

Show propiedades

type

string

required

Tipo de método de pago: credit_card, debit_card, bank_account, digital_wallet, crypto_wallet, pix

last4

string

Últimos 4 dígitos del número de tarjeta/cuenta

brand

string

Marca de la tarjeta (para tarjetas): visa, mastercard, amex, elo, hipercard, etc.

expiryMonth

string

Mes de vencimiento (para tarjetas): 01 a 12

expiryYear

string

Año de vencimiento (para tarjetas): formato YYYY

holderName

string

Nombre en la tarjeta/cuenta

issuerCountry

string

Código de país emisor (ISO 3166-1 alpha-2)

bin

string

Número de Identificación Bancaria (primeros 6 dígitos de la tarjeta)

fingerprint

string

Huella digital única para este método de pago

funding

string

Tipo de financiamiento: credit, debit, prepaid, unknown

accountNumber

string

Número de cuenta completo (para cuentas bancarias, encriptado)

accountType

string

Tipo de cuenta: checking, savings, business

bank

string

Nombre del banco (para cuentas bancarias)

currency

string

Código de moneda (ISO 4217): BRL, USD, ARS, etc.

routingNumber

string

Número de ruta (para cuentas bancarias)

provider

string

Nombre del proveedor (para billeteras digitales): paypal, apple_pay, google_pay, etc.

string

Email asociado con la billetera (para billeteras digitales)

address

string

Dirección de la billetera (para billeteras de criptomonedas)

network

string

Nombre de la red (para criptomonedas): bitcoin, ethereum, etc.

pixKey

string

Clave PIX (para métodos de pago PIX en Brasil)

pixKeyType

string

Tipo de clave PIX: cpf, cnpj, email, phone, random

relationships

array

Array de relaciones con otras entidades

Show propiedades

targetEntityId

string

required

UUID de la entidad relacionada (propietario persona o empresa)

relationshipType

string

required

Tipo de relación: owns, uses, manages

strength

number

Fuerza de la relación (0.0 a 1.0)

metadata

object

Metadatos adicionales de la relación

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
      }
    ]
  }'