Pular para o conteúdo principal
Use estes exemplos quando o seu serviço for dono da criação, cancelamento e reconciliação de payouts.

​
Exemplo de requisição subjacente à API

{
  "pix_key_type": "EMAIL",
  "pix_key_value": "supplier@example.com",
  "amount": 1200,
  "description": "Supplier payout",
  "external_ref": "payout_1001"
}

​
Exemplo de resposta subjacente da API

{
  "success": true,
  "requestId": "req_3003",
  "data": {
    "id": "po_1001",
    "status": "pending"
  }
}

​
Criar uma transferência

const transfer = await client.transfers.create({
  pix_key_type: "EMAIL",
  pix_key_value: "supplier@example.com",
  amount: 1200,
  description: "Supplier payout",
  external_ref: "payout_1001",
});

​
Consultar e reconciliar

const current = await client.transfers.retrieve("po_1001", {
  requestId: "reconcile_po_1001",
  timeoutMs: 10_000,
});

​
Cancelar

const cancelled = await client.transfers.cancel(
  "po_1001",
  { reason: "wrong recipient" },
  { requestId: "cancel_po_1001" },
);

​
Listar com paginação automática

for await (const item of client.transfers.listAutoPagingIterator({ limit: 100 })) {
  console.log(item.id, item.status);
}

​
Regra comum

Use pix_key_type e pix_key_value nos exemplos de SDK e API. Não use campos não documentados como pix_key ou recipient_name.