Visão Geral
Recupera uma lista de entidades de método de pagamento com filtragem opcional por proprietário, tipo ou outros critérios.
Endpoint
GET http://api.gu1.ai/entities?entityType=payment_method
Autenticação
Requer uma chave API válida no cabeçalho de Autorização:
Authorization: Bearer YOUR_API_KEY
Parâmetros de Consulta
Deve ser "payment_method" para filtrar métodos de pagamento
Filtrar por relacionamento com outra entidade (ex. UUID do proprietário pessoa ou empresa)
Número de resultados a retornar (padrão: 50, máx: 100)
Número de resultados a pular para paginação (padrão: 0)
Campo para ordenar: createdAt, updatedAt, riskScore
Ordem de classificação: asc ou desc (padrão: desc)
Exemplos de Requisições
Listar Todos os Métodos de Pagamento
curl -X GET "http://api.gu1.ai/entities?entityType=payment_method" \
-H "Authorization: Bearer YOUR_API_KEY"
Listar Métodos de Pagamento para uma Pessoa
curl -X GET "http://api.gu1.ai/entities?entityType=payment_method&relationshipWith=person-uuid-123" \
-H "Authorization: Bearer YOUR_API_KEY"
Resposta
Se a requisição foi bem-sucedida
Array de entidades de método de pagamento
Exemplo de Resposta
{
"success": true,
"entities": [
{
"id": "payment-method-uuid-123",
"entityType": "payment_method",
"entityData": {
"paymentMethod": {
"type": "credit_card",
"last4": "4242",
"brand": "visa",
"holderName": "John Doe"
}
},
"riskScore": 15,
"createdAt": "2024-01-15T10:00:00.000Z"
}
],
"pagination": {
"total": 1,
"limit": 50,
"offset": 0,
"hasMore": false
}
}
Veja Também