Bun Adaptor

Saiba como integrar <CardGroup cols={2}> ao seu projeto de servidor Bun usando nosso Bun Adaptor. Abrange checkout, Customer Portal, webhooks e configuração segura do ambiente.

Checkout Handler

Integre o checkout do Dodo Payments ao seu servidor Bun.

Customer Portal

Permita que os clientes gerenciem assinaturas e dados.

Webhooks

Receba e processe eventos de webhook do Dodo Payments.

​

Instalação

1. Install the package

   Execute o comando a seguir na raiz do seu projeto:

   bun add @dodopayments/bun
   
2. Set up environment variables

   Crie um arquivo .env na raiz do seu projeto:

   DODO_PAYMENTS_API_KEY=your-api-key
   DODO_PAYMENTS_WEBHOOK_KEY=your-webhook-secret
   DODO_PAYMENTS_ENVIRONMENT="test_mode" or "live_mode"
   DODO_PAYMENTS_RETURN_URL=your-return-url
   

   Nunca faça commit do arquivo .env ou de secrets no controle de versão.

​

Exemplos de Route Handler

Todos os exemplos pressupõem que você está usando o servidor nativo do Bun com Bun.serve().

Checkout Handler

Use este handler para integrar o checkout do Dodo Payments ao seu servidor Bun. Suporta fluxos de pagamento estático (GET), dinâmico (POST) e de sessão (POST).

Bun Server Handler

import { Checkout } from '@dodopayments/bun';

const staticCheckoutHandler = Checkout({
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
    environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
    type: "static"
});

const sessionCheckoutHandler = Checkout({
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
    environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
    type: "session"
});

const dynamicCheckoutHandler = Checkout({
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
    environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
    type: "dynamic"
});

Bun.serve({
  port: 3000,
  fetch(request) {
    const url = new URL(request.url);
    
    if (url.pathname === "/api/checkout") {
      if (request.method === "GET") {
        return staticCheckoutHandler(request);
      }
      if (request.method === "POST") {
        return sessionCheckoutHandler(request);
        // or return dynamicCheckoutHandler(request);
      }
    }
    
    return new Response("Not Found", { status: 404 });
  },
});

Static Checkout Curl example

curl --request GET \
--url 'https://example.com/api/checkout?productId=pdt_xxx' \
--header 'User-Agent: insomnia/11.2.0' \
--cookie mode=test

Dynamic Checkout Curl example

curl --request POST \
--url https://example.com/api/checkout \
--header 'Content-Type: application/json' \
--header 'User-Agent: insomnia/11.2.0' \
--cookie mode=test \
--data '{
"billing": {
  "city": "Texas",
  "country": "US",
  "state": "Texas",
  "street": "56, hhh",
  "zipcode": "560000"
},
"customer": {
  "email": "[e-mail]",
  	"name": "test"
},
"metadata": {},
"payment_link": true,
  "product_id": "pdt_xxx",
  "quantity": 1,
  "billing_currency": "USD",
  "discount_codes": ["IKHZ23M9GQ"],
  "return_url": "https://example.com",
  "trial_period_days": 10
}'

Checkout Session Curl example

curl --request POST \
--url https://example.com/api/checkout \
--header 'Content-Type: application/json' \
--header 'User-Agent: insomnia/11.2.0' \
--cookie mode=test \
--data '{
"product_cart": [
  {
    "product_id": "pdt_xxx",
    "quantity": 1
  }
],
"customer": {
  "email": "[e-mail]",
  "name": "test"
},
"return_url": "https://example.com/success"
}'

Customer Portal Handler

Use este handler para permitir que os clientes gerenciem suas assinaturas e dados por meio do Customer Portal do Dodo Payments.

Bun Server Handler

import { CustomerPortal } from "@dodopayments/bun";

const customerPortalHandler = CustomerPortal({
  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
  environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
});

Bun.serve({
  port: 3000,
  fetch(request) {
    const url = new URL(request.url);
    
    if (url.pathname === "/api/customer-portal" && request.method === "GET") {
      return customerPortalHandler(request);
    }
    
    return new Response("Not Found", { status: 404 });
  },
});

Customer Portal Curl example

curl --request GET \
--url 'https://example.com/api/customer-portal?customer_id=cus_123&send_email=true' \
--header 'User-Agent: insomnia/11.2.0' \
--cookie mode=test

Webhook Handler

Use este handler para receber e processar eventos de webhook do Dodo Payments com segurança no seu servidor Bun.

Bun Server Handler

import { Webhooks } from "@dodopayments/bun";

const webhookHandler = Webhooks({
  webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_KEY,
  onPayload: async (payload) => {
    // handle the payload
  },
  // ... other event handlers for granular control
});

Bun.serve({
  port: 3000,
  fetch(request) {
    const url = new URL(request.url);
    
    if (url.pathname === "/api/webhook/dodo-payments" && request.method === "POST") {
      return webhookHandler(request);
    }
    
    return new Response("Not Found", { status: 404 });
  },
});

​

Route Handler de Checkout

Dodo Payments é compatível com três tipos de fluxos de pagamento para integrar pagamentos ao seu site; este adaptador é compatível com todos os tipos de fluxos de pagamento.

• Links de pagamento estáticos: URLs que podem ser compartilhadas instantaneamente para uma cobrança rápida de pagamentos sem código.
• Links de pagamento dinâmicos: Gere links de pagamento programaticamente com detalhes personalizados usando a API ou SDKs.
• Checkout Sessions: Crie experiências de checkout hospedadas, seguras e personalizáveis, com carrinhos de produtos e dados do cliente pré-configurados.

Static Checkout (GET)

​

Parâmetros de consulta compatíveis

productId · string · obrigatório

Identificador do produto (por exemplo, ?productId=pdt_xxx).

quantity · integer

Quantidade do produto.

fullName · string

Nome completo do cliente.

firstName · string

Primeiro nome do cliente.

lastName · string

Sobrenome do cliente.

email · string

Endereço de e-mail do cliente.

country · string

País do cliente.

addressLine · string

Linha de endereço do cliente.

city · string

Cidade do cliente.

state · string

Estado/província do cliente.

zipCode · string

CEP/código postal do cliente.

disableFullName · boolean

Desativar o campo de nome completo.

disableFirstName · boolean

Desativar o campo de primeiro nome.

disableLastName · boolean

Desativar o campo de sobrenome.

disableEmail · boolean

Desativar o campo de e-mail.

disableCountry · boolean

Desativar o campo de país.

disableAddressLine · boolean

Desativar o campo de linha de endereço.

disableCity · boolean

Desativar o campo de cidade.

disableState · boolean

Desativar o campo de estado.

disableZipCode · boolean

Desativar o campo de CEP.

paymentCurrency · string

Especificar a moeda do pagamento (por exemplo, USD).

showCurrencySelector · boolean

Mostrar o seletor de moeda.

paymentAmount · integer

Especificar o valor do pagamento (por exemplo, 1000 para US$ 10,00).

showDiscounts · boolean

Mostrar os campos de desconto.

metadata_* · string

Qualquer parâmetro de consulta que comece com metadata_ será transmitido como metadata.

Se productId estiver ausente, o handler retornará uma resposta 400. Parâmetros de consulta inválidos também resultarão em uma resposta 400.

​

Formato da resposta

O checkout estático retorna uma resposta JSON com a URL do checkout:

{
  "checkout_url": "https://checkout.dodopayments.com/..."
}

Dynamic Checkout (POST)

• Envie os parâmetros como um corpo JSON em uma solicitação POST.
• Suporta pagamentos únicos e recorrentes.
• Para obter a lista completa de campos compatíveis no corpo do POST, consulte:
  • Corpo da solicitação para um produto de pagamento único
  • Corpo da solicitação para um produto de assinatura

​

Formato da resposta

O checkout dinâmico retorna uma resposta JSON com a URL do checkout:

{
  "checkout_url": "https://checkout.dodopayments.com/..."
}

Checkout Sessions (POST)

As Checkout Sessions oferecem uma experiência de checkout hospedada e mais segura, que gerencia o fluxo completo de pagamento para compras únicas e assinaturas, com controle total de personalização.

Consulte o Guia de integração das Checkout Sessions para obter mais detalhes e a lista completa de campos compatíveis.

​

Formato da resposta

As Checkout Sessions retornam uma resposta JSON com a URL do checkout:

{
  "checkout_url": "https://checkout.dodopayments.com/session/..."
}

​

Route Handler de Customer Portal

O Route Handler de Customer Portal permite integrar perfeitamente o Customer Portal do Dodo Payments ao seu aplicativo de servidor Bun.

​

Parâmetros de consulta

customer_id · string · obrigatório

O ID do cliente para a sessão do portal (por exemplo, ?customer_id=cus_123).

send_email · boolean

Se definido como true, envia um e-mail ao cliente com o link do portal.

Retorna 400 se customer_id estiver ausente.

​

Webhook Route Handler

• Método: somente solicitações POST são compatíveis. Outros métodos retornam 405.
• Verificação de assinatura: verifica a assinatura do webhook usando webhookKey. Retorna 401 se a verificação falhar.
• Validação do payload: validado com Zod. Retorna 400 para payloads inválidos.
• Tratamento de erros:
  • 401: assinatura inválida
  • 400: payload inválido
  • 500: erro interno durante a verificação
• Roteamento de eventos: chama o handler de eventos apropriado com base no tipo do payload.

​

Event Handlers de webhook compatíveis

Typescript

onPayload?: (payload: WebhookPayload) => Promise<void>;
onPaymentSucceeded?: (payload: WebhookPayload) => Promise<void>;
onPaymentFailed?: (payload: WebhookPayload) => Promise<void>;
onPaymentProcessing?: (payload: WebhookPayload) => Promise<void>;
onPaymentCancelled?: (payload: WebhookPayload) => Promise<void>;
onRefundSucceeded?: (payload: WebhookPayload) => Promise<void>;
onRefundFailed?: (payload: WebhookPayload) => Promise<void>;
onDisputeOpened?: (payload: WebhookPayload) => Promise<void>;
onDisputeExpired?: (payload: WebhookPayload) => Promise<void>;
onDisputeAccepted?: (payload: WebhookPayload) => Promise<void>;
onDisputeCancelled?: (payload: WebhookPayload) => Promise<void>;
onDisputeChallenged?: (payload: WebhookPayload) => Promise<void>;
onDisputeWon?: (payload: WebhookPayload) => Promise<void>;
onDisputeLost?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionActive?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionOnHold?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionRenewed?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionPlanChanged?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionCancelled?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionFailed?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionExpired?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionUpdated?: (payload: WebhookPayload) => Promise<void>;
onLicenseKeyCreated?: (payload: WebhookPayload) => Promise<void>;
onAbandonedCheckoutDetected?: (payload: WebhookPayload) => Promise<void>;
onAbandonedCheckoutRecovered?: (payload: WebhookPayload) => Promise<void>;
onDunningStarted?: (payload: WebhookPayload) => Promise<void>;
onDunningRecovered?: (payload: WebhookPayload) => Promise<void>;
onCreditAdded?: (payload: WebhookPayload) => Promise<void>;
onCreditDeducted?: (payload: WebhookPayload) => Promise<void>;
onCreditExpired?: (payload: WebhookPayload) => Promise<void>;
onCreditRolledOver?: (payload: WebhookPayload) => Promise<void>;
onCreditRolloverForfeited?: (payload: WebhookPayload) => Promise<void>;
onCreditOverageCharged?: (payload: WebhookPayload) => Promise<void>;
onCreditManualAdjustment?: (payload: WebhookPayload) => Promise<void>;
onCreditBalanceLow?: (payload: WebhookPayload) => Promise<void>;

---

​

Prompt para LLM

You are an expert Bun developer assistant. Your task is to guide a user through integrating the @dodopayments/bun adapter into their existing Bun project.

The @dodopayments/bun adapter provides handlers for Dodo Payments' Checkout, Customer Portal, and Webhook functionalities, designed for Bun's native server with Bun.serve().

First, install the necessary package:

bun add @dodopayments/bun

Here's how you should structure your response:

    Ask the user which functionalities they want to integrate.

"Which parts of the @dodopayments/bun adapter would you like to integrate into your project? You can choose one or more of the following:
1. Checkout (static, dynamic, or session-based)
2. Customer Portal
3. Webhooks"

    Based on the user's selection, provide step-by-step integration instructions.

For each selected functionality, show:

    The environment variables required
    The exact code to add to their server file
    Where to place the code in their Bun.serve() configuration

Provide complete, working examples that the user can copy and paste directly into their project.

    Environment Variables Setup

Always include instructions for setting up the .env file:

DODO_PAYMENTS_API_KEY=your-api-key
DODO_PAYMENTS_WEBHOOK_KEY=your-webhook-secret
DODO_PAYMENTS_ENVIRONMENT="test_mode" or "live_mode"
DODO_PAYMENTS_RETURN_URL=your-return-url

Remind the user to never commit their .env file to version control.

    For Checkout Integration

If the user selects Checkout, ask which type they need:

    Static checkout (GET requests with query parameters)
    Dynamic checkout (POST requests with JSON body)
    Checkout sessions (POST requests with product cart)

Provide the appropriate handler code for their selection.

    For Customer Portal Integration

Provide a complete example showing how to integrate the customer portal handler into their Bun server.

    For Webhook Integration

Provide a complete example showing how to integrate the webhook handler with available event handlers for granular control.

    Full Example

If the user wants to integrate all three functionalities, provide a complete Bun server example that combines all handlers.

```typescript
import { Checkout, CustomerPortal, Webhooks } from "@dodopayments/bun";

const staticCheckoutHandler = Checkout({
  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
  returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
  environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
  type: "static",
});

const sessionCheckoutHandler = Checkout({
  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
  returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
  environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
  type: "session",
});

const customerPortalHandler = CustomerPortal({
  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
  environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
});

const webhookHandler = Webhooks({
  webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_KEY,
  onPaymentSucceeded: async (payload) => {
    console.log("Payment succeeded:", payload);
    // Your business logic here
  },
  onSubscriptionActive: async (payload) => {
    console.log("Subscription activated:", payload);
    // Your business logic here
  },
});

Bun.serve({
  port: 3000,
  fetch(request) {
    const url = new URL(request.url);
    
    // Checkout routes
    if (url.pathname === "/api/checkout") {
      if (request.method === "GET") {
        return staticCheckoutHandler(request);
      }
      if (request.method === "POST") {
        return sessionCheckoutHandler(request);
      }
    }
    
    // Customer portal route
    if (url.pathname === "/api/customer-portal" && request.method === "GET") {
      return customerPortalHandler(request);
    }
    
    // Webhook route
    if (url.pathname === "/api/webhook/dodo-payments" && request.method === "POST") {
      return webhookHandler(request);
    }
    
    return new Response("Not Found", { status: 404 });
  },
});

console.log("Server running on http://localhost:3000");

Additional Guidance:
• Explain that the handlers are Bun-native and work seamlessly with Bun.serve()
• Highlight the use of Web Standard Request and Response objects
• Mention that error handling is built-in and returns appropriate HTTP status codes
• Provide links to the Dodo Payments documentation for more details