OpenAPI 3.1.0 · 20 Endpoints · Base URL: https://xpayr.com/api/v1

Referência Interativa da XPayr REST API v1.

Inspecione cada endpoint de produção e Testnet diretamente da nossa especificação canônica /.well-known/openapi.json , baixe nossa pronta para uso Coleção Postman v2.1, ou gere código completo de aplicação em 8 linguagens.

GET /api/v1/health Saúde do Sistema
xpayr_health_check

Verificação de integridade do API Gateway

Verifique a saúde operacional, a versão e o carimbo de data/hora do servidor da XPayr Gateway API v1.

curl -X GET "https://xpayr.com/api/v1/health"
POST /api/v1/payments Pagamentos e Checkout
xpayr_create_payment_session

Criar sessão de pagamento cripto (Checkout Duplo)

Crie uma sessão de pagamento cripto não custodial com suporte a pagamento Web3 em 1 clique, transferência direta via QR de corretoras, links multichain, links reutilizáveis por 1 ano e envio automático de faturas HTML por e-mail.

curl -X POST "https://xpayr.com/api/v1/payments" \
  -H "Authorization: Bearer sk_test_your_workspace_key" \
  -H "Content-Type: application/json" \
  -d '{"amount":49.9,"currency":"USDT","network":"tron-mainnet","order_id":"ORD-1001","description":"Pro SaaS Annual Plan","is_multi_chain":true,"is_reusable":false,"send_invoice_email":true,"customer_email":"buyer@example.com","ipn_callback_url":"https://example.com/webhooks/xpayr"}'
GET /api/v1/payments Pagamentos e Checkout
xpayr_list_payment_sessions

Listar sessões de pagamento do lojista

Liste as sessões de pagamento cripto do lojista com filtragem por status, moeda, rede e paginação.

curl -X GET "https://xpayr.com/api/v1/payments" \
  -H "Authorization: Bearer sk_test_your_workspace_key"
GET /api/v1/payments/{session_id} Pagamentos e Checkout
xpayr_get_payment_session

Obter detalhes da sessão de pagamento

Recupere todos os detalhes, metadados, valores de divisão de liquidação, modo de checkout e hash de transação on-chain de uma sessão de pagamento.

curl -X GET "https://xpayr.com/api/v1/payments/{session_id}" \
  -H "Authorization: Bearer sk_test_your_workspace_key"
GET /api/v1/payments/{session_id}/status Pagamentos e Checkout
xpayr_get_public_payment_status

Consultar status público do pagamento on-chain

Consulte em tempo real o status público do checkout, tx_hash on-chain, endereço da carteira remetente, confirmações de bloco e carimbo paid_at sem chave de API.

curl -X GET "https://xpayr.com/api/v1/payments/{session_id}/status"
POST /api/v1/payments/{session_id}/coupon Pagamentos e Checkout
xpayr_apply_payment_coupon

Aplicar cupom de desconto no checkout

Valide e aplique um código de cupom promocional de desconto do lojista a uma sessão de pagamento pendente ativa.

curl -X POST "https://xpayr.com/api/v1/payments/{session_id}/coupon" \
  -H "Authorization: Bearer sk_test_your_workspace_key" \
  -H "Content-Type: application/json" \
  -d '{"coupon_code":"XPAYR-DEMO"}'
GET /api/v1/me Lojista e Perfil
xpayr_get_merchant_profile

Obter perfil do lojista e carteira de liquidação

Recupere o perfil autenticado do lojista, o endereço da carteira de liquidação, a taxa de comissão em pontos-base (50 bps = 0.5%) e as chaves de API ativas.

curl -X GET "https://xpayr.com/api/v1/me" \
  -H "Authorization: Bearer sk_test_your_workspace_key"
GET /api/v1/me/balance Lojista e Perfil
xpayr_get_merchant_balance

Obter volume e saldo de liquidação multichain

Consulte o volume confirmado de liquidação não custodial, a contagem de transações e as taxas da plataforma agrupados por moeda e rede blockchain.

curl -X GET "https://xpayr.com/api/v1/me/balance" \
  -H "Authorization: Bearer sk_test_your_workspace_key"
GET /api/v1/me/networks Lojista e Perfil
xpayr_get_supported_networks

Listar redes, chains e tokens suportados

Liste todas as redes blockchain ativas EVM, TRON, Solana e Arc Mainnet/Testnet, IDs de chain, endpoints RPC, contratos divisores e tokens suportados.

curl -X GET "https://xpayr.com/api/v1/me/networks" \
  -H "Authorization: Bearer sk_test_your_workspace_key"
GET /api/v1/webhooks Webhooks
xpayr_get_webhook_config

Obter configuração e eventos de webhook

Inspecione a URL de callback de webhook do lojista, o segredo de assinatura HMAC-SHA256 mascarado e os eventos inscritos do ciclo de vida do pagamento.

curl -X GET "https://xpayr.com/api/v1/webhooks" \
  -H "Authorization: Bearer sk_test_your_workspace_key"
POST /api/v1/webhooks Webhooks
xpayr_set_webhook_endpoint

Configurar endpoint de webhook HTTPS

Configure ou atualize a URL receptora HTTPS de webhooks do lojista e gere um novo segredo de assinatura HMAC-SHA256 de 32 bytes.

curl -X POST "https://xpayr.com/api/v1/webhooks" \
  -H "Authorization: Bearer sk_test_your_workspace_key" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/webhooks/xpayr"}'
POST /api/v1/webhooks/test Webhooks
xpayr_send_test_webhook

Disparar evento de webhook de teste assinado

Envie um payload test.webhook assinado com cabeçalhos HMAC-SHA256 para validar a verificação de assinatura de webhook do lojista.

curl -X POST "https://xpayr.com/api/v1/webhooks/test" \
  -H "Authorization: Bearer sk_test_your_workspace_key"
POST /api/v1/agents Comércio de Agentes de IA
xpayr_create_ai_agent

Criar agente de comércio de IA controlado por políticas

Provisione uma nova identidade de agente de comércio de IA gerenciada pelo lojista com credenciais delimitadas e limites de gastos programáveis.

curl -X POST "https://xpayr.com/api/v1/agents" \
  -H "Authorization: Bearer sk_test_your_workspace_key" \
  -H "Content-Type: application/json" \
  -d '{"name":"Autonomous Cloud Buyer","description":"Pays API and compute invoices under $50 automatically.","wallet_address":"0x71C...89A"}'
GET /api/v1/agents Comércio de Agentes de IA
xpayr_list_ai_agents

Listar agentes de comércio de IA do lojista

Liste todos os agentes de comércio de IA gerenciados pelo lojista com seus status, carteiras atribuídas e políticas de gastos.

curl -X GET "https://xpayr.com/api/v1/agents" \
  -H "Authorization: Bearer sk_test_your_workspace_key"
PUT /api/v1/agents/{agent_id}/policy Comércio de Agentes de IA
xpayr_update_ai_agent_policy

Atualizar limites de gastos do agente de IA

Configure os limites da política de gastos de um agente de IA (máx. em USD por transação, teto diário, limite de aprovação automática, redes/tokens permitidos).

curl -X PUT "https://xpayr.com/api/v1/agents/{agent_id}/policy" \
  -H "Authorization: Bearer sk_test_your_workspace_key" \
  -H "Content-Type: application/json" \
  -d '{"max_tx_amount":100,"daily_limit_amount":500,"auto_approve_under":25}'
POST /api/v1/agent-intents Comércio de Agentes de IA
xpayr_submit_agent_payment_intent

Enviar intenção de pagamento autônoma de agente de IA

Envie uma intenção de pagamento autônoma de agente de IA avaliada em tempo real conforme as regras de política do lojista (approved, pending_approval, rejected).

curl -X POST "https://xpayr.com/api/v1/agent-intents" \
  -H "Authorization: Bearer sk_test_your_workspace_key" \
  -H "Content-Type: application/json" \
  -d '{"amount":19.99,"currency":"USDC","network":"arc-testnet","recipient_address":"0xb0bD2f3A86db752dA693D8a686C406E269E57c99","reason":"Monthly GPU cluster invoice #402"}'
GET /api/v1/agent-intents Comércio de Agentes de IA
xpayr_list_agent_payment_intents

Listar intenções de pagamento de agentes de IA e logs de auditoria

Liste as intenções de pagamento de agentes de IA, decisões de avaliação de políticas e registros de trilha de auditoria do lojista.

curl -X GET "https://xpayr.com/api/v1/agent-intents" \
  -H "Authorization: Bearer sk_test_your_workspace_key"
POST /api/v1/agent-intents/{intent_id}/bridge Comércio de Agentes de IA
xpayr_bridge_agent_intent_to_checkout

Converter intenção de agente aprovada em sessão de checkout

Converta uma intenção de pagamento aprovada de agente de IA em uma sessão de pagamento XPayr executável ao vivo com URL de checkout hospedada e verificação on-chain.

curl -X POST "https://xpayr.com/api/v1/agent-intents/{intent_id}/bridge" \
  -H "Authorization: Bearer sk_test_your_workspace_key"
POST /api/v1/agent-approvals/{intent_id}/approve Comércio de Agentes de IA
xpayr_approve_agent_intent

Aprovar intenção pendente de agente de IA (Human-in-the-Loop)

Aprove uma intenção de pagamento pendente de um agente de IA na fila de aprovação do lojista e converta-a para o checkout.

curl -X POST "https://xpayr.com/api/v1/agent-approvals/{intent_id}/approve" \
  -H "Authorization: Bearer sk_test_your_workspace_key" \
  -H "Content-Type: application/json" \
  -d '{"note":"Approved by Treasury Manager"}'
POST /api/v1/agent-approvals/{intent_id}/reject Comércio de Agentes de IA
xpayr_reject_agent_intent

Rejeitar intenção pendente de agente de IA

Rejeite uma intenção de pagamento pendente de um agente de IA na fila de aprovação do lojista informando um motivo para auditoria.

curl -X POST "https://xpayr.com/api/v1/agent-approvals/{intent_id}/reject" \
  -H "Authorization: Bearer sk_test_your_workspace_key" \
  -H "Content-Type: application/json" \
  -d '{"reason":"Exceeds vendor budget allocation"}'

Perguntas Frequentes de Integração da API v1

Qual URL base e esquema de autenticação a XPayr API v1 utiliza?

All REST API v1 endpoints are served from https://xpayr.com/api/v1 using standard Bearer token authentication (Authorization: Bearer sk_test_... for Testnet or sk_live_... for Mainnet). Public endpoints like GET /api/v1/health and GET /api/v1/payments/{session_id}/status require no secret key.

Posso importar a XPayr API v1 diretamente no Postman, Insomnia, Bruno ou Cursor?

Sim! Importe https://xpayr.com/postman.json (Coleção Postman v2.1) ou https://xpayr.com/.well-known/openapi.json (OpenAPI 3.1.0) com um clique.

As respostas da API na Testnet são estruturalmente idênticas às da Mainnet?

Sim. A mudança de sk_test_ para sk_live_ mantém exatamente as mesmas URLs de endpoint, nomes de campos JSON e esquemas de eventos de webhook HMAC-SHA256.