Skip to main content
POST
/
entities
Criar Método de Pagamento
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>",
      "pixKey": "<string>",
      "pixKeyType": "<string>"
    }
  },
  "relationships": [
    {}
  ]
}
'
{
  "success": true,
  "id": "<string>",
  "entityType": "<string>",
  "entityData": {},
  "createdAt": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.gu1.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Visão Geral

Cria uma nova entidade de método de pagamento (cartão de crédito, conta bancária, carteira, etc.) no sistema. Os métodos de pagamento podem ser vinculados a entidades de pessoas ou empresas e usados para monitoramento de transações e detecção de fraude.

​
Endpoint

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

​
Autenticação

Requer uma chave API válida no cabeçalho de Autorização: 
Authorization: Bearer YOUR_API_KEY

​
Corpo da Requisição

​
entityType
string
required
Deve ser "payment_method" para entidades de método de pagamento
​
entityData
object
required
Container para dados do método de pagamento
​
relationships
array
Array de relacionamentos com outras entidades

​
Exemplos de Requisições

​
Criar Cartão 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
      }
    ]
  }'

​
Criar Método de Pagamento 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
      }
    ]
  }'

​
Resposta

​
success
boolean
Se a operação foi bem-sucedida
​
id
string
UUID da entidade de método de pagamento criada
​
entityType
string
Sempre "payment_method"
​
entityData
object
Os dados do método de pagamento conforme armazenados
​
createdAt
string
Timestamp ISO 8601 da criação

​
Exemplo de Resposta

{
  "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"
    }
  },
  "createdAt": "2024-12-23T10:00:00.000Z"
}

​
Veja Também