Documentação da API 3Pay

Guia completo para integrar pagamentos em sua aplicação

Processar Pagamentos

Aprenda a receber pagamentos via cartão, PIX e boleto

Configurar Webhooks

Receba notificações em tempo real sobre transações

Visão Geral

A API 3Pay oferece endpoints RESTful para integrar pagamentos em sua aplicação. Todas as respostas são em formato JSON.

BASE URL: https://api.3pay.com/v2

# Exemplo de requisição
curl -X GET https://api.3pay.com/v2/payments/pay_123 \
  -H "Authorization: Bearer YOUR_API_KEY"

Autenticação

Todas as requisições à API 3Pay devem incluir seu API Key no header de autorização.

curl -X GET https://api.3pay.com/v2/payments \
  -H "Authorization: Bearer sk_test_1234567890abcdef" \
  -H "Content-Type: application/json"

Modo Sandbox

Use sk_test_... para testes. Não use chaves reais em ambiente de desenvolvimento.

Pagamentos

POST

/v2/payments

Cria um novo pagamento. Aceita cartão de crédito, PIX ou boleto.

// Exemplo de requisição
{
  "amount": 1999, // em centavos (R$ 19.99)
  "currency": "BRL",
  "payment_method": "credit_card",
  "card": {
    "number": "4242424242424242",
    "exp_month": "12",
    "exp_year": "2025",
    "cvv": "123"
  },
  "customer": {
    "name": "João Silva",
    "email": "joao@exemplo.com"
  }
}

// Exemplo de resposta (201 Created)
{
  "id": "pay_123",
  "amount": 1999,
  "status": "processing",
  "payment_method": "credit_card",
  "created_at": "2023-06-15T12:00:00Z"
}

GET

/v2/payments/{id}

Recupera os detalhes de um pagamento específico.

// Exemplo de resposta
{
  "id": "pay_123",
  "amount": 1999,
  "status": "paid",
  "payment_method": "credit_card",
  "card_last4": "4242",
  "customer": {
    "name": "João Silva",
    "email": "joao@exemplo.com"
  },
  "created_at": "2023-06-15T12:00:00Z",
  "paid_at": "2023-06-15T12:02:30Z"
}

Webhooks

Webhooks permitem que você receba notificações em tempo real sobre eventos na sua conta 3Pay.

Configuração Necessária

Acesse o painel 3Pay para configurar os endpoints dos seus webhooks.

// Exemplo de payload de webhook
{
  "id": "evt_123",
  "type": "payment.paid",
  "data": {
    "id": "pay_123",
    "amount": 1999,
    "status": "paid",
    "customer_id": "cus_456"
  },
  "created_at": "2023-06-15T12:02:30Z"
}

Eventos Disponíveis

Evento	Descrição
`payment.created`	Novo pagamento criado
`payment.paid`	Pagamento confirmado
`payment.failed`	Pagamento falhou

SDK JavaScript

Instalação

npm install 3pay-sdk
# ou
yarn add 3pay-sdk

Uso Básico

import { ThreePay } from '3pay-sdk';

// Configurar o cliente
const client = new ThreePay('sua_api_key');

// Criar pagamento
const payment = await client.payments.create({
  amount: 1999,
  currency: 'BRL',
  payment_method: 'pix'
});

console.log(payment.id);