Autenticação
A chave do lojista vai no campo api-key
{
"api-key": "SUA_CHAVE_API",
"amount": 100.50,
"client": {
"name": "Cliente Teste",
"document": "12345678909",
"email": "cliente@exemplo.com"
}
}
Gateway PIX / Cartão
POST https://dexpayments.org/api/v1/gateway/
Gera cobrança PIX QR Code ou processa pagamento com cartão.
| Campo | Uso |
|---|
| api-key | Chave privada do lojista. |
| amount | Valor da cobrança. |
| payment_method | pix ou credit_card. |
| client | Objeto com name, document e email. |
| card | Obrigatório para cartão. |
| metadata.order_id | Identificador do pedido do lojista. |
Webhook
POST https://dexpayments.org/api/v1/webhook/
Recebe confirmação assíncrona de pagamento.
| Uso | Descrição |
|---|
| Pagamento | Atualiza o status da transação e dispara postback do lojista quando configurado. |
| PIX | Compatível com payloads de pagamento aprovados, pendentes, cancelados ou falhos. |
Cash-out
POST https://dexpayments.org/api/c1/cashout/
Solicitação de saque PIX da conta do lojista.
| Campo | Descrição |
|---|
| api-key | Chave privada do lojista. |
| amount | Valor do saque. |
| pix_key | Chave PIX de destino. |
| pix_key_type | cpf, cnpj, email, telefone ou aleatoria. |
Exemplo PIX
{
"api-key": "SUA_CHAVE_API",
"amount": 25.90,
"payment_method": "pix",
"client": {
"name": "Maria da Silva",
"document": "12345678909",
"email": "maria@exemplo.com"
},
"metadata": {
"order_id": "PED-1001"
}
}
Exemplo Cartão
{
"api-key": "SUA_CHAVE_API",
"amount": 49.90,
"payment_method": "credit_card",
"client": {
"name": "Maria da Silva",
"document": "12345678909",
"email": "maria@exemplo.com"
},
"card": {
"holder_name": "MARIA DA SILVA",
"number": "4111111111111111",
"exp_month": "12",
"exp_year": "2030",
"cvv": "123"
}
}
Resposta esperada
{
"status": "success",
"message": "ok",
"idTransaction": "abc123",
"paymentCode": "000201...",
"paymentCodeBase64": "iVBORw0KGgo..."
}
Observações
- Os endpoints públicos e exemplos desta página já utilizam a base URL https://dexpayments.org.
- O menu lateral do painel aponta para esta documentação local.
- O item Prêmios foi removido do sidebar neste patch.