Skip to main content
Use these examples when your service owns payout creation, cancellation, and reconciliation.

​
Underlying API request example

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

​
Underlying API response example

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

​
Create a transfer

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",
});

​
Retrieve and reconcile

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

​
Cancel

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

​
List with auto-pagination

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

​
Common rule

Use pix_key_type and pix_key_value in SDK and API examples. Do not use undocumented fields such as pix_key or recipient_name.