Desenvolvedores

API-first. Documentada, versionada e em produção.

REST em JSON, autenticação Basic e postbacks a cada mudança de status — com Pix, boleto e cartão na mesma rota.

Primeira chamada

Uma venda em uma requisição

Pix, boleto e cartão passam pela mesma rota: muda o paymentMethod, não a integração. Se o seu stack fala HTTP, ele fala com a Hylex Pay.

REST e JSON

Verbos HTTP previsíveis e corpo em JSON, do primeiro ao último endpoint. Sem SOAP, sem XML e sem campo posicional.

Autenticação Basic

Um par de chaves pública e secreta, gerado no painel, no cabeçalho Authorization. Sem fluxo de token para manter.

Postbacks por transação

Informe a postbackUrl no corpo da venda e receba cada mudança de status no seu endpoint. Nada para cadastrar antes.

Split, 3DS e tokenização

Rateio entre recebedores e autenticação 3DS entram no corpo da própria venda; o cartão tokenizado vira um hash que você envia no mesmo POST.

POST /v1/transactions
curl --request POST \
  --url https://api.hylexpay.com/v1/transactions \
  --header 'authorization: Basic <base64(publicKey:secretKey)>' \
  --header 'content-type: application/json' \
  --data '{
    "amount": 750,
    "paymentMethod": "pix",
    "postbackUrl": "https://sua-api.com/postback",
    "items": [
      { "title": "Assinatura Pro", "quantity": 1, "unitPrice": 750 }
    ],
    "customer": {
      "name": "Carlos Exemplar",
      "email": "[email protected]",
      "document": { "type": "cpf", "number": "00011122233" }
    }
  }'
Postback recebido
{
  "type": "transaction",
  "objectId": "123456",
  "data": {
    "id": 123456,
    "amount": 750,
    "paymentMethod": "pix",
    "status": "waiting_payment"
  }
}

Por onde começar

Um guia curto para a primeira transação e a referência completa de cada endpoint.

Get Started

Da chave de API à primeira transação criada, com exemplos prontos para colar no terminal.

Começar

Documentação da API

Vendas, saques, antecipações, saldo e dados da empresa — com exemplos em Shell, Node, Ruby, PHP e Python.

Abrir a documentação

Recursos

O que fica fora da documentação, mas você vai querer por perto.

API Status

Disponibilidade em tempo real de cada serviço e histórico de incidentes.

Ver status

Open Source

Bibliotecas, exemplos de integração e ferramentas que mantemos em aberto.

Ir para o GitHub

Chaves de API

A chave pública e a chave secreta são geradas por você no painel, na área de integrações.

Gerar chaves

Precisa de ajuda para integrar?

Push Forward