Skip to main content
PATCH
/
entities
/
{id}
Atualizar Método de Pagamento
curl --request PATCH \
  --url http://api.gu1.ai/entities/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityData": {},
  "relationships": [
    {}
  ],
  "metadata": {}
}
'
{
  "success": true,
  "id": "<string>",
  "entityData": {},
  "updatedAt": "<string>"
}

​
Visão Geral

Atualiza uma entidade de método de pagamento existente. Este endpoint permite atualizações parciais - você só precisa fornecer os campos que deseja alterar.

​
Endpoint

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

​
Autenticação

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

​
Parâmetros de Rota

​
id
string
required
UUID da entidade de método de pagamento a atualizar

​
Corpo da Requisição

​
entityData
object
Container para dados do método de pagamento a atualizar
​
relationships
array
Array de relacionamentos para adicionar ou atualizar
​
metadata
object
Metadados adicionais para atualizar

​
Exemplos de Requisições

​
Atualizar Data de Vencimento do Cartão

curl -X PATCH "http://api.gu1.ai/entities/payment-method-uuid-123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityData": {
      "paymentMethod": {
        "expiryMonth": "06",
        "expiryYear": "2026"
      }
    }
  }'

​
Adicionar Metadados

curl -X PATCH "http://api.gu1.ai/entities/payment-method-uuid-123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "metadata": {
      "isDefault": true,
      "addedVia": "mobile_app",
      "verifiedAt": "2024-12-23T10:00:00Z"
    }
  }'

​
Resposta

​
success
boolean
Se a operação foi bem-sucedida
​
id
string
UUID da entidade de método de pagamento atualizada
​
entityData
object
Os dados completos do método de pagamento atualizado
​
updatedAt
string
Timestamp ISO 8601 desta atualização

​
Exemplo de Resposta

{
  "success": true,
  "id": "payment-method-uuid-123",
  "entityType": "payment_method",
  "entityData": {
    "paymentMethod": {
      "type": "credit_card",
      "last4": "4242",
      "brand": "visa",
      "expiryMonth": "06",
      "expiryYear": "2026",
      "holderName": "John Doe"
    }
  },
  "metadata": {
    "isDefault": true,
    "addedVia": "mobile_app",
    "verifiedAt": "2024-12-23T10:00:00Z"
  },
  "updatedAt": "2024-12-23T10:15:00.000Z"
}
  • Este é um endpoint de atualização parcial - apenas os campos fornecidos serão atualizados
  • Outros campos permanecerão inalterados
  • Para remover um campo, defina-o explicitamente como null
  • Atualizações de campos sensíveis (como números de cartão) podem ser restritas

​
Veja Também