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

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>",
      "pixKey": "<string>",
      "pixKeyType": "<string>"
    }
  },
  "relationships": [
    {}
  ]
}
'

{
  "success": true,
  "id": "<string>",
  "entityType": "<string>",
  "entityData": {},
  "createdAt": "<string>"
}

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

Show propriedades

paymentMethod

object

required

Detalhes do método de pagamento

Show propriedades

type

string

required

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

last4

string

Últimos 4 dígitos do número de cartão/conta

brand

string

Marca do cartão (para cartões): visa, mastercard, amex, elo, hipercard, etc.

expiryMonth

string

Mês de vencimento (para cartões): 01 a 12

expiryYear

string

Ano de vencimento (para cartões): formato YYYY

holderName

string

Nome no cartão/conta

issuerCountry

string

Código do país emissor (ISO 3166-1 alpha-2)

bin

string

Número de Identificação Bancária (primeiros 6 dígitos do cartão)

pixKey

string

Chave PIX (para métodos de pagamento PIX no Brasil)

pixKeyType

string

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

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