Skip to main content
Use the SDK from server-side TypeScript code. Keep browser flows on Payment Element.

​
Install

bun add @pagouai/api-sdk

​
Create a client

import { Client } from "@pagouai/api-sdk";

const client = new Client({
  apiKey: process.env.PAGOU_API_KEY!,
  environment: "sandbox",
  timeoutMs: 30_000,
  maxRetries: 2,
});

​
Underlying API request example

{
  "external_ref": "order_1001",
  "amount": 1500,
  "currency": "BRL",
  "method": "pix"
}

​
Underlying API response example

{
  "success": true,
  "requestId": "req_3001",
  "data": {
    "id": "tr_1001",
    "status": "pending"
  }
}

​
First Pix payment

const created = await client.transactions.create(
  {
    external_ref: "order_1001",
    amount: 1500,
    currency: "BRL",
    method: "pix",
    buyer: {
      name: "Ada Lovelace",
      email: "ada@example.com",
      document: { type: "CPF", number: "12345678901" },
    },
    products: [{ name: "Starter order", price: 1500, quantity: 1 }],
  },
  {
    idempotencyKey: "tx_order_1001",
    requestId: "req_order_1001",
  },
);

​
Auth variants

new Client({ apiKey: process.env.PAGOU_API_KEY!, auth: { scheme: "bearer" } });
new Client({ apiKey: process.env.PAGOU_API_KEY!, auth: { scheme: "basic" } });
new Client({ apiKey: process.env.PAGOU_API_KEY!, auth: { scheme: "api_key_header", headerName: "apiKey" } });

​
Retry behavior

  • Retries cover network failures and 429, 500, 502, 503, 504.
  • GET and HEAD retry automatically.
  • POST and PUT retry only when you set an idempotency key.